diff --git a/.github/actions/setup-jbr/action.yml b/.github/actions/setup-jbr/action.yml new file mode 100644 index 000000000..f8ed8d4e5 --- /dev/null +++ b/.github/actions/setup-jbr/action.yml @@ -0,0 +1,64 @@ +name: 'Set up JBR' +description: 'Set up the JetBrains Runtime, retrying through transient GitHub rate limits on the JBR download.' + +inputs: + token: + description: 'GitHub token used for authenticated JBR downloads.' + required: true + cache: + description: "Build tool to cache dependencies for (passed through to setup-java's cache input). Empty disables caching." + required: false + default: '' + +runs: + using: 'composite' + steps: + - name: Set up JBR (attempt 1) + id: attempt1 + uses: actions/setup-java@v5 + continue-on-error: true + # The jetbrains distribution authenticates its release-listing API call via + # the GITHUB_TOKEN env var, not the `token` input — without it the request is + # unauthenticated and hits GitHub's per-IP rate limit. + env: + GITHUB_TOKEN: ${{ inputs.token }} + with: + distribution: 'jetbrains' + java-version: 21 + token: ${{ inputs.token }} + cache: ${{ inputs.cache }} + + - name: Back off before retry + if: steps.attempt1.outcome == 'failure' + shell: bash + run: sleep 30 + + - name: Set up JBR (attempt 2) + id: attempt2 + if: steps.attempt1.outcome == 'failure' + uses: actions/setup-java@v5 + continue-on-error: true + env: + GITHUB_TOKEN: ${{ inputs.token }} + with: + distribution: 'jetbrains' + java-version: 21 + token: ${{ inputs.token }} + cache: ${{ inputs.cache }} + + - name: Back off before final retry + if: steps.attempt1.outcome == 'failure' && steps.attempt2.outcome == 'failure' + shell: bash + run: sleep 60 + + # Final attempt: no continue-on-error, so a persistent failure still fails the job. + - name: Set up JBR (attempt 3) + if: steps.attempt1.outcome == 'failure' && steps.attempt2.outcome == 'failure' + uses: actions/setup-java@v5 + env: + GITHUB_TOKEN: ${{ inputs.token }} + with: + distribution: 'jetbrains' + java-version: 21 + token: ${{ inputs.token }} + cache: ${{ inputs.cache }} diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index af13369b6..a4707222e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,9 +21,9 @@ jobs: cache: gradle - name: Set up Node - uses: actions/setup-node@v6 + uses: actions/setup-node@v4 with: - node-version: '24' + node-version: '22' - name: Grant execute permission for gradlew run: chmod +x gradlew @@ -33,12 +33,6 @@ jobs: # buildDebug does not touch androidTest, so stale instrumented tests rot silently otherwise. - name: Compile Android instrumented tests run: ./gradlew :android:assembleDebugAndroidTest - # buildDebug abbreviates to buildDebugPreBundle, which never runs unit tests, and Kover - # aggregates only :common and :server, so the phone's unit tests need their own step. - - name: Unit test the Android app - run: ./gradlew :android:testDebugUnitTest - - name: Build and unit test the Wear OS app - run: ./gradlew :wear:assembleDebug :wear:testDebugUnitTest - name: Run Kover run: ./gradlew koverXmlReport - name: Upload coverage reports to Codecov diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml index f668298b9..76283093e 100644 --- a/.github/workflows/prepare-release.yml +++ b/.github/workflows/prepare-release.yml @@ -15,8 +15,8 @@ jobs: - name: Set up JDK uses: actions/setup-java@v5 with: - distribution: 'temurin' - java-version: '21' + distribution: 'adopt' + java-version: 21 cache: gradle - name: Run Unit Tests @@ -50,11 +50,10 @@ jobs: - name: Checkout code uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 + - name: Set up JBR + uses: ./.github/actions/setup-jbr with: - distribution: 'temurin' - java-version: '21' + token: ${{ secrets.GITHUB_TOKEN }} - name: Gradle caching uses: actions/cache@v6 @@ -72,7 +71,7 @@ jobs: timeout_minutes: 30 max_attempts: 3 shell: pwsh - command: ./gradlew :desktop:packageReleaseMsi -Pchannel=github -Pformat=msi + command: ./gradlew :desktop:packageReleaseMsi - name: Rename MSI Artifact shell: cmd @@ -104,7 +103,7 @@ jobs: timeout_minutes: 30 max_attempts: 3 shell: pwsh - command: ./gradlew :desktop:packageReleaseExe -Pchannel=github -Pformat=exe + command: ./gradlew :desktop:packageReleaseExe - name: Rename EXE Artifact shell: cmd @@ -130,17 +129,6 @@ jobs: echo Successfully renamed file to "hammer.exe" - - name: Write update digests - shell: pwsh - run: ./gradlew writeAssetDigests "-PassetFiles=desktop/build/installers/main-release/msi/hammer.msi,desktop/build/installers/main-release/exe/hammer.exe" - - - name: Upload update digests - uses: actions/upload-artifact@v7 - with: - name: update-digests-windows - path: desktop/build/installers/main-release/*/hammer.*.sha512 - if-no-files-found: error - - name: Create Release uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 env: @@ -161,11 +149,10 @@ jobs: - name: Checkout code uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 + - name: Set up JBR + uses: ./.github/actions/setup-jbr with: - distribution: 'temurin' - java-version: '21' + token: ${{ secrets.GITHUB_TOKEN }} - name: Gradle caching uses: actions/cache@v6 @@ -203,7 +190,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew :desktop:packageReleaseDeb -Pchannel=github -Pformat=deb + command: ./gradlew :desktop:packageReleaseDeb - name: Rename DEB Artifact run: | @@ -227,7 +214,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew :desktop:packageReleaseRpm -Pchannel=github -Pformat=rpm + command: ./gradlew :desktop:packageReleaseRpm - name: Rename RPM Artifact run: | @@ -251,17 +238,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew buildDistAppImage -Pchannel=appimage -Pformat=appimage - - - name: Write update digests - run: ./gradlew writeAssetDigests "-PassetFiles=desktop/build/installers/main-release/deb/hammer.deb,desktop/build/installers/main-release/rpm/hammer.rpm,desktop/build/installers/main-release/appimage/hammer.AppImage" - - - name: Upload update digests - uses: actions/upload-artifact@v7 - with: - name: update-digests-linux - path: desktop/build/installers/main-release/*/hammer.*.sha512 - if-no-files-found: error + command: ./gradlew buildDistAppImage - name: Create Release uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 @@ -283,11 +260,10 @@ jobs: - name: Checkout code uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 + - name: Set up JBR + uses: ./.github/actions/setup-jbr with: - distribution: 'temurin' - java-version: '21' + token: ${{ secrets.GITHUB_TOKEN }} - name: Gradle caching uses: actions/cache@v6 @@ -304,7 +280,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew :desktop:packageReleaseDmg -Pchannel=github -Pformat=dmg + command: ./gradlew :desktop:packageReleaseDmg - name: Rename DMG Artifact run: | @@ -328,7 +304,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew :desktop:packageReleasePkg -Pchannel=github -Pformat=pkg + command: ./gradlew :desktop:packageReleasePkg - name: Rename PKG Artifact run: | @@ -349,16 +325,6 @@ jobs: echo "Contents of pkg directory:" ls -la - - name: Write update digests - run: ./gradlew writeAssetDigests "-PassetFiles=desktop/build/installers/main-release/dmg/hammer.dmg,desktop/build/installers/main-release/pkg/hammer.pkg" - - - name: Upload update digests - uses: actions/upload-artifact@v7 - with: - name: update-digests-macos - path: desktop/build/installers/main-release/*/hammer.*.sha512 - if-no-files-found: error - - name: Create Release uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 env: @@ -382,8 +348,8 @@ jobs: - name: Set up JDK uses: actions/setup-java@v5 with: - distribution: 'temurin' - java-version: '21' + distribution: 'adopt' + java-version: 21 - name: Gradle caching uses: actions/cache@v6 @@ -444,8 +410,8 @@ jobs: - name: Set up JDK uses: actions/setup-java@v5 with: - distribution: 'temurin' - java-version: '21' + distribution: 'adopt' + java-version: 21 - name: Gradle caching uses: actions/cache@v6 @@ -496,9 +462,6 @@ jobs: echo "File renamed successfully." - - name: Rename R8 Mapping - run: cp "$GITHUB_WORKSPACE/android/build/outputs/mapping/release/mapping.txt" "$GITHUB_WORKSPACE/android/build/outputs/apk/release/hammer-apk-mapping.txt" - - name: Create Release uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 env: @@ -508,7 +471,7 @@ jobs: prerelease: true artifactErrorsFailBuild: true allowUpdates: true - artifacts: "${{ github.workspace }}/android/build/outputs/apk/release/hammer.apk,${{ github.workspace }}/android/build/outputs/apk/release/hammer-apk-mapping.txt" + artifacts: "${{ github.workspace }}/android/build/outputs/apk/release/hammer.apk" snap: needs: tests @@ -519,11 +482,10 @@ jobs: - name: Checkout code uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 + - name: Set up JBR + uses: ./.github/actions/setup-jbr with: - distribution: 'temurin' - java-version: '21' + token: ${{ secrets.GITHUB_TOKEN }} cache: gradle - name: Grant Permission to Execute @@ -558,11 +520,10 @@ jobs: - name: Checkout code uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 + - name: Set up JBR + uses: ./.github/actions/setup-jbr with: - distribution: 'temurin' - java-version: '21' + token: ${{ secrets.GITHUB_TOKEN }} cache: gradle - name: Install Flatpak and flatpak-builder @@ -598,7 +559,7 @@ jobs: with: timeout_minutes: 30 max_attempts: 3 - command: ./gradlew buildDistFlatpak -Pchannel=flathub + command: ./gradlew buildDistFlatpak - name: Create Release uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 @@ -625,61 +586,10 @@ jobs: - name: Fetch tags run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* - - name: Set up JDK - uses: actions/setup-java@v5 - with: - distribution: 'temurin' - java-version: '21' - - - name: Gradle caching - uses: actions/cache@v6 - with: - path: | - ~/.gradle/caches - ~/.gradle/wrapper - key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} - restore-keys: | - ${{ runner.os }}-gradle- - - # The desktop updater reads latest*.yml from the release. Each platform job hashed - # the installer it attached and handed the digest over as a workflow artifact, so - # nothing is downloaded back and no release lookup is needed. Attached before the - # draft flips, so a published release never exists without them. - - name: Collect update digests - uses: actions/download-artifact@v7 - with: - pattern: update-digests-* - merge-multiple: true - path: ${{ runner.temp }}/update-digests - - - name: Write update metadata - run: ./gradlew writeUpdateMetadata "-PreleaseDigestsDir=${{ runner.temp }}/update-digests" --no-daemon - - - name: Attach update metadata - uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - draft: true - prerelease: true - artifactErrorsFailBuild: true - allowUpdates: true - artifacts: "${{ github.workspace }}/build/update-metadata/latest.yml,${{ github.workspace }}/build/update-metadata/latest-mac.yml,${{ github.workspace }}/build/update-metadata/latest-linux.yml" - - name: Get last tag message run: | TAG_NAME=${GITHUB_REF#refs/tags/} TAG_MESSAGE=$(git tag -n90 --format='%(contents)' "$TAG_NAME" ) - - # prepareForRelease appends this trailer when the release dialog's - # auto-publish box is checked. Strip it so it stays out of the body. - AUTO_PUBLISH=false - if printf '%s\n' "$TAG_MESSAGE" | grep -qxF 'Auto-Publish: true'; then - AUTO_PUBLISH=true - fi - TAG_MESSAGE=$(printf '%s\n' "$TAG_MESSAGE" | grep -vxF 'Auto-Publish: true' || true) - echo "auto_publish=$AUTO_PUBLISH" >> $GITHUB_ENV - echo "Auto-publish: $AUTO_PUBLISH" echo "Tag: $TAG_NAME" echo -e "Tag message:\n$TAG_MESSAGE" @@ -697,19 +607,3 @@ jobs: prerelease: true allowUpdates: true body: ${{ env.tag_message }} - - # Flipping the draft fires `release: published`, which starts - # publish-release.yml. The token must not be GITHUB_TOKEN: GitHub suppresses - # workflow runs triggered by it, so no store would ever publish. - - name: Publish release - if: env.auto_publish == 'true' - env: - GH_TOKEN: ${{ secrets.RELEASE_PAT }} - REPO: ${{ github.repository }} - TAG_NAME: ${{ github.ref_name }} - run: | - if [ -z "$GH_TOKEN" ]; then - echo "::error::Auto-publish was requested but the RELEASE_PAT secret is not set." - exit 1 - fi - gh release edit "$TAG_NAME" --repo "$REPO" --draft=false --prerelease=false --latest diff --git a/.github/workflows/publish-google-play.yml b/.github/workflows/publish-google-play.yml index ac51a276a..e16990706 100644 --- a/.github/workflows/publish-google-play.yml +++ b/.github/workflows/publish-google-play.yml @@ -36,9 +36,9 @@ jobs: distribution: 'temurin' cache: gradle - - uses: ruby/setup-ruby@d45b1a4e94b71acab930e56e79c6aa188764e7f9 # v1.316.0 + - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0 with: - ruby-version: '3.4.10' + ruby-version: '3.4.8' bundler-cache: true - name: Cache Ruby - Bundler @@ -89,15 +89,3 @@ jobs: esac echo "Running fastlane $LANE for track=$TRACK" bundle exec fastlane "$LANE" - - # Keeps the mappings for the exact Play builds next to the release, so prod - # crash traces can be retraced without the Play Console. - - name: Attach R8 mappings to the GitHub release - if: github.event_name == 'release' - env: - GH_TOKEN: ${{ github.token }} - TAG: ${{ github.event.release.tag_name }} - run: | - cp android/build/outputs/mapping/release/mapping.txt hammer-google-play-mapping.txt - cp wear/build/outputs/mapping/release/mapping.txt hammer-wear-mapping.txt - gh release upload "$TAG" hammer-google-play-mapping.txt hammer-wear-mapping.txt --clobber diff --git a/.github/workflows/publish-internal.yml b/.github/workflows/publish-internal.yml index 2e000e445..3e7cf0c71 100644 --- a/.github/workflows/publish-internal.yml +++ b/.github/workflows/publish-internal.yml @@ -21,9 +21,9 @@ jobs: distribution: 'temurin' cache: gradle - - uses: ruby/setup-ruby@d45b1a4e94b71acab930e56e79c6aa188764e7f9 # v1.316.0 + - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0 with: - ruby-version: '3.4.10' + ruby-version: '3.4.8' bundler-cache: true - name: Cache Ruby - Bundler diff --git a/.github/workflows/publish-ios-app-store.yml b/.github/workflows/publish-ios-app-store.yml index 6ac306e9b..3c942899a 100644 --- a/.github/workflows/publish-ios-app-store.yml +++ b/.github/workflows/publish-ios-app-store.yml @@ -15,18 +15,6 @@ on: required: false workflow_call: -# Serialized against the Mac App Store publish: since iOS moved onto the macOS -# app record for Universal Purchase, both publishes target the SAME App Store -# Connect record, and deliver edits record-level App Information (categories, -# copyright) as well as the per-platform version. A full release tag — one with -# no `+platform` suffix — starts both in parallel, so they must queue instead. -# The group name is deliberately constant, not per-tag: two overlapping releases -# would collide the same way. cancel-in-progress stays false; aborting a publish -# part-way through a review submission is far worse than waiting for a slot. -concurrency: - group: app-store-connect - cancel-in-progress: false - jobs: publish-ios-app-store: runs-on: macos-latest @@ -50,9 +38,9 @@ jobs: sudo xcode-select -s "$XCODE_APP/Contents/Developer" xcodebuild -version - - uses: ruby/setup-ruby@d45b1a4e94b71acab930e56e79c6aa188764e7f9 # v1.316.0 + - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0 with: - ruby-version: '3.4.10' + ruby-version: '3.4.8' bundler-cache: true - name: Install bundle diff --git a/.github/workflows/publish-mac-app-store.yml b/.github/workflows/publish-mac-app-store.yml index 4299c449a..8fdc9f844 100644 --- a/.github/workflows/publish-mac-app-store.yml +++ b/.github/workflows/publish-mac-app-store.yml @@ -15,18 +15,6 @@ on: required: false workflow_call: -# Serialized against the Mac App Store publish: since iOS moved onto the macOS -# app record for Universal Purchase, both publishes target the SAME App Store -# Connect record, and deliver edits record-level App Information (categories, -# copyright) as well as the per-platform version. A full release tag — one with -# no `+platform` suffix — starts both in parallel, so they must queue instead. -# The group name is deliberately constant, not per-tag: two overlapping releases -# would collide the same way. cancel-in-progress stays false; aborting a publish -# part-way through a review submission is far worse than waiting for a slot. -concurrency: - group: app-store-connect - cancel-in-progress: false - jobs: publish-mac-app-store: runs-on: macos-latest @@ -46,9 +34,9 @@ jobs: distribution: 'temurin' cache: gradle - - uses: ruby/setup-ruby@d45b1a4e94b71acab930e56e79c6aa188764e7f9 # v1.316.0 + - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0 with: - ruby-version: '3.4.10' + ruby-version: '3.4.8' bundler-cache: true - name: Grant Permission to Execute diff --git a/.github/workflows/publish-microsoft-store.yml b/.github/workflows/publish-microsoft-store.yml index 2f8d84899..c2c36bd13 100644 --- a/.github/workflows/publish-microsoft-store.yml +++ b/.github/workflows/publish-microsoft-store.yml @@ -27,7 +27,7 @@ jobs: cache: gradle - name: Build MSIX package - run: ./gradlew :desktop:packageMsix -Pchannel=ms-store -Pformat=msix + run: ./gradlew :desktop:packageMsix - name: Upload Gradle problems report on failure if: failure() diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml index 75b102dab..b98ca1ec5 100644 --- a/.github/workflows/publish-release.yml +++ b/.github/workflows/publish-release.yml @@ -11,8 +11,6 @@ jobs: publish-google-play: if: ${{ !contains(github.event.release.tag_name, '+') || contains(github.event.release.tag_name, '+google-play') }} uses: ./.github/workflows/publish-google-play.yml - permissions: - contents: write secrets: inherit with: track: production diff --git a/.gitignore b/.gitignore index 3809a0bbd..2bb275b32 100644 --- a/.gitignore +++ b/.gitignore @@ -93,6 +93,3 @@ fastlane/README.md # server/src/main/resources/assets/images/ are committed, their sources are not /scripts/build-home-screenshots.py /scripts/home-screenshot-sources/ - -# Local working area: marketing renders, one-off scripts, anything not shipped -/scratch/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 285a08301..79caaa714 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,244 +1,5 @@ # Changelog -## [3.12.0] - 2026-10-5 - -New features -- Reader Mode: read your story as prose, one chapter at a time, instead of through the scene editor. Open it from the Read button under the scene list, the book icon in the scene editor, or the editor menu. The scene list becomes a table of contents, and the reader has its own font size -- Export: three new options in the Export Story dialog. Number chapter titles, pick a font (Word, RTF and EPUB), and choose whether to keep blank lines between paragraphs -- Android and iOS: an OLED theme, the dark theme on a pure black background -- Desktop (Windows and Linux installs from GitHub): Hammer tells you when a newer release is out and can update itself from the project list or the About screen. macOS DMG installs are told and sent to the release page. Automatic checks can be turned off in Settings -- Text editor 3.0: Huge improvements in input and performance -- Text editor: change the text size with Ctrl/Cmd and Plus, Minus or 0, or from the format bar's overflow menu -- Text editor: Delete in the right-click menu -- Turkish translation -- Web: a fifth reader reaction on public stories, "Surprised me" - -Improvements -- Syncing with unsaved work now asks Save, Discard or Cancel first, where before it silently saved every unsaved scene -- Open notes, timeline events, encyclopedia entries and the scene title, outline and notes refresh when a sync or conflict resolution changes them. An edit in progress keeps its draft -- The Backup Manager lists backups of projects that are no longer on disk, so a deleted project can be restored -- Exports no longer number chapter titles unless you turn the new option on. Word, RTF, PDF and Markdown used to number them always -- Text editor: the heading button writes real Markdown headings, and Hammer's shortcuts land on the same keys on non-QWERTY layouts -- Android: a launch splash screen on every supported version -- Translations and dependencies updated - -Fixes -- Android: unsaved scene edits could be lost when the app was closed in the background. They now come back as unsaved scenes the next time the project opens [#983] -- Export: unsaved scene edits were left out of the exported file [#983] -- Restoring a backup from the Backup Manager made the project disappear from the project list -- Choosing Discard on close with automatic sync on still saved and uploaded the discarded scenes -- PDF export: long paragraphs ran off the bottom of the page or left large blank gaps -- Android: a crash on launch when the saved login could not be decrypted, for example after restoring the device from a backup. You are asked to sign in again -- iOS: a crash when tapping into a text editor -- Server URL, number, tag and word-list fields no longer autocorrect or capitalize, which put a space after each "." in a server URL -- Encyclopedia references no longer match a name inside a longer word with accented or non-Latin letters ("Ana" in "Anaïs") - - -## [3.11.0] - 2026-9-24 - -New features -- Web: signed-in readers can leave kudos at the end of a publicly published story, picking up to four craft chips and one reaction. Kudos are anonymous: authors see per-chip totals on their story page, and a chip appears on the public page once three readers have picked it. Authors can turn kudos off for any story - -Improvements -- Word counts no longer count standalone Markdown markers such as horizontal rules, heading marks, bullets and blockquote markers as words. The server now counts the same way, so both give the same number -- Android and Wear OS builds are now shrunk and obfuscated with R8 -- Translations and dependencies updated - -Fixes -- Text editor: numpad navigation keys and numpad Enter now work -- Text editor: keyboard (IME) edits are applied right away, and the keyboard is told about each one only once -- Text editor: spelling underlines stay on the right words while you keep typing -- Text editor: the formatting you picked for new text is kept after unrelated updates -- Text editor: fixed crashes and misplaced carets when drawing the cursor or moving it during a layout change -- Wear OS: pairing with the phone app works in release builds - - -## [3.10.1] - 2026-9-23 - -- Fix Android Wear release - - -## [3.10.0] - 2026-9-20 - -New features -- A Wear OS watch app: dictate notes into your projects and capture story ideas from your wrist, then sync them on their own. Pair it from your phone, or sign in on the watch directly -- Add words to a project's own spelling dictionary, either from "Add to dictionary" on a flagged word in the editor or from the word list in Project Settings under Spell checking. The list syncs with the project -- Encyclopedia entry names and draft names accept the same characters project and scene names already did: punctuation like . , ! ? : ( ) & - " and non-Latin letters -- Copy Diagnostics on the About screen puts your version, system details, recent log, and newest crash report on the clipboard, so a bug report can carry its own diagnostics -- Desktop: Export Logs saves a zip wherever you choose, which works even where opening the log folder does not - -Improvements -- A failed login says what actually went wrong instead of answering with a bare 401, and a self-hosted server logs which failure occurred -- Account creation reports policy problems, real conflicts, and Allowed Users rejections distinctly -- Builds record which store or channel they came from, which shows up in diagnostics -- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian -- Web: the home page offers the iOS app, which now shares one App Store listing with macOS - -Fixes -- Desktop (Microsoft Store): the app crashed on its first network call and could not sync at all -- Client: email and password fields no longer capitalize the first character as you type, which could create an account with a password you could not reproduce elsewhere -- Client: a network failure occurring before any request was sent showed a raw Java error instead of a real message -- Text editor: the spelling suggestions menu could stick on "Loading" when the editor re-anchored it -- Sync: clients on different versions no longer fail an entire sync over a field one side does not recognize -- Sync: a failed sync no longer ends by logging "Sync complete!" -- Web: previous and next page links on the community feed and authors pages - - -## [3.9.8] - 2026-9-12 - -iOS Release fix - - -## [3.9.7] - 2026-9-4 - -iOS Release fix - - -## [3.9.6] - 2026-9-3 - -Release fix - - -## [3.9.5] - 2026-9-1 - -Release fix - - -## [3.9.4] - 2026-8-22 - -Fix widgets not doing anything - - -## [3.9.3] - 2026-8-22 - -Bug fixes - - -## [3.9.2] - 2026-8-21 - -- Fix MacOS Crash -- Fix Android widgets not working - - -## [3.9.1] - 2026-8-18 - -- Fix sharing scene order -- Fix PDF export crash -- Fix MacOS crash on start -- Added configurable timezone for server admins - - -## [3.9.0] - 2026-8-16 - -New features -- Export only the scenes you choose, in every export format -- Private web shares can be limited to a selection of scenes -- Encyclopedia entry names and aliases feed the spell check dictionary, so your invented names stop being flagged as misspelled. Controllable globally, per project, and per entry -- Scenes now connect to every kind of Encyclopedia entry, not just People and Places -- Drag the editor's edge to set how wide it gets on large screens -- Server: search the Allowed Users list by email - -Improvements -- Logging in to a new server asks whether to merge or replace, and only asks when local work is actually at stake -- Published stories and every export now lay prose out the way the editor shows it, line for line -- A scene opens for typing immediately instead of waiting for spell check to finish -- Scene tree nesting is easier to read -- Save all moved from Ctrl+Alt+S to Ctrl+Shift+S, so AltGr layouts keep their characters -- Desktop (Linux): runs natively on Wayland instead of being forced through XWayland -- Web: the editorial review dialog's scene list uses the full height of the window -- Italian translation added, and translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian -- Server: Argon2 password hashing no longer loads a native library, which fixes signup and login on hosts that mount the data volume noexec - -Fixes -- Client: scenes in a folder holding exactly ten items could go blank and export empty -- Client: sync could fail when a folder crossed a ten-item boundary -- Client: unsaved edits survive a device rotation on Android -- Client: AltGr chords no longer close the app on Turkish, German, and Polish layouts -- Client: crash when closing a project with the scene metadata panel open -- Sync: renaming a project onto the name of one you had deleted -- Sync: project settings could be wiped when a project moved to a different server -- Sync: a local project sharing a name with a server project could leave a duplicate behind -- Server: sync could hang indefinitely on hosts with a shallow entropy pool -- Server: concurrent sync sessions could be handed colliding sync ids -- Server: API errors returned a 500 instead of falling back to English when a translation was missing -- Web: Allowed Users paging could repeat and skip entries - - -## [3.8.2] - 2026-8-11 - -New features -- Web: public sign-up page, so an allowed user can create an account without installing the app -- Server: the Allowed Users list is now always enforced; the old whitelist toggle is gone - -Improvements -- Server: web sign-ins are now recorded in the security audit trail, alongside app sign-ins -- Server: admin instance messages render as Markdown, so links, emphasis, and lists work in them -- About: Dark Rock Studios attribution moved into its own "Studio" section with a full-screen Cairn overlay -- Desktop: dropped the JetBrains Runtime requirement; builds run on stock Temurin OpenJDK now -- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian - -Fixes -- Desktop (macOS): fixed a crash on launch -- Desktop (Linux/Snap): fixed a crash on launch - - -## [3.8.1] - 2026-8-8 - -Improvements -- Desktop window decoration migrated to the Nucleus TAO backend -- Server: trustProxyForwarding option reads real client IPs from X-Forwarded-* headers when running behind a reverse proxy, so the login rate limiter, login audit trail, and story reader counts reflect actual clients instead of the proxy -- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian -- Rendered stories now use real book typography: indented lists, a centered scene-break ornament, tinted blockquotes, and deliberate blank-line spacing between paragraphs - -Fixes -- Client: text editor no longer drops block structure (horizontal rules, images, code fences) when a scene loads -- Client: font size changes no longer flatten list and blockquote indents -- Client: typed text after a size change could lose the paragraph's body style -- Client: F3 and Ctrl+Alt+S sync shortcuts work from anywhere in the project window -- Client: tag suggestion chips could add the typed prefix instead of the selected tag -- Sync: projects with a stale cached server id could get stuck failing "410 Gone" instead of recreating -- Web: ~~strikethrough~~ rendered as literal tildes instead of struck-through text - - -## [3.8.0] - 2026-8-4 - -https://hammer.ink/blog/news/hammer-3-8-0 - -### New features - -- Set the language a project is written in, and have spell check follow it -- Self-service account deletion from the web dashboard, with an admin restore window -- Import and export documents as HTML, alongside Markdown -- "What's New" release notes shown in-app with no network request, and reopenable from About -- Import preview warns when a scene comes in unusually large, so a failed chapter split doesn't quietly collapse a manuscript into one scene - -### Improvements - -- Text editor: faster typing and relayout, word-wise undo with a much deeper history, and rich copy and paste that preserves formatting between apps -- Text editor: platform-correct key bindings on macOS, and AltGr chords type their character instead of firing shortcuts -- Large Markdown imports are dramatically faster: 1600 scenes went from 37 seconds to about 3 -- Search matches the rendered prose, resolving Markdown escapes and formatting -- Tag search matches accented and non-latin characters, and searches entry names as well as bodies -- Scene drag and drop stays accurate while the list autoscrolls -- Chapter detection on Markdown import understands Setext-style and bold titles -- Visible scrollbars on scrolling screens, and scroll-away footers float over their lists -- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian -- Server: the setup page can create the initial admin account -- Server: a self-hosted server not serving HTTPS now reports a clear error instead of "Network error" -- Server: smaller Docker image -- Web: error responses show a toast instead of failing silently - -### Fixes - -- Client: importing a very large story no longer freezes the app -- Client: scene drag could grab the wrong row -- Client: literal `**` and `_` left around emphasis imported from RTF -- Client: sync server URLs are normalized consistently when saved -- Client: a number of text editor crashes around undo, paste, and joined paragraphs -- Web: htmx requests denied access landed on a blank page instead of being redirected -- Web: broken download link on the home page - - ## [3.7.2] - 2026-7-27 [Improve] diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 4f140dc73..6977b5d65 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -146,58 +146,8 @@ flowchart TD ## Build Variants -### The distribution channel - -Every build is stamped with the distribution vehicle it was produced for, via -`-Pchannel=`: - -``` -./gradlew :desktop:packageMsix -Pchannel=ms-store -``` - -Omitting it produces a `dev` build. An unknown token fails the build rather than -silently falling back, so a typo in a release workflow cannot ship a store binary as -`dev`. Each release pipeline passes its own channel; `prepare-release.yml` uses `github` -for the installers it attaches to the GitHub release. - -The token list lives in two places that must stay in step, pinned by a test on each side: - -| Location | Role | -| --- | --- | -| `buildSrc/src/main/java/distributionChannel.kt` | Build-side enum and the `-Pchannel` resolver. | -| `base/src/commonMain/.../DistributionChannel.kt` | Runtime enum. `DistributionChannel.current` reads the baked-in `BuildMetadata.CHANNEL`. | - -Branch on `DistributionChannel.current` for behaviour that varies per vehicle: self-update -(forbidden in the app stores, expected for the GitHub and AppImage builds), where "get the -app" links point, external-payment policy, and sandbox-aware path resolution. It is a flat -enum on purpose: every channel-conditional branch is a greppable `when` on the type. -Capability flags (`canSelfUpdate`, `isSandboxed`, …) can be introduced later, from real -duplication rather than a guess at the axes. - -The build side reads the same token through `Project.distributionChannel()` in buildSrc: -`desktop/build.gradle.kts` derives its Mac App Store packaging mode (`isAppStoreRelease`: -sandbox entitlements, provisioning profiles, signing) from `-Pchannel=mac-app-store`. Together -with `-PbuildNumber=N`, that is everything `build-appstore.sh` passes. - -Packaging runs carry a second stamp, `-Pformat=` (`msi`, `exe`, `deb`, `rpm`, `dmg`, -`pkg`, `appimage`, `msix`, `snap`, `flatpak`), read the same way into -`BuildMetadata.PACKAGE_FORMAT` and `PackageFormat.current`. The channel says which vehicle a -build is for; the format says which installer it came out of, which is what the desktop -updater needs to pick its download. Omitting it gives `none`, an unknown token fails the -build, and each release step passes its own. Two packaging tasks in one Gradle invocation -would both carry the first task's format, so the release workflow runs one per step. - -Note that every branch compiles into every build, so a store-forbidden code path is -physically present in a store binary even when unreachable. If a store ever objects to -presence rather than behaviour, promote that one case to a real source set rather than -restructuring everything. - ### The F-Droid build flag -Predates the channel constant and is still the switch for the two things that must happen -before any Kotlin runs (see the table below). A build with the F-Droid flag set and no -`-Pchannel` reports the `fdroid` channel. - F-Droid builds are produced by the same modules as the Google Play build, but with a single build flag toggled. There are no Gradle product flavors; instead the flag is read directly from a Gradle property (or an environment variable) wherever it's needed: @@ -234,10 +184,9 @@ Access), which Google Play does not allow, so the feature is gated to F-Droid bu - `HammerApplication` forces internal storage on non-F-Droid builds, so a leftover preference can never point a Google Play build at a directory it has no permission for. -For behaviour that is specifically about F-Droid's manifest and storage permissions, -branch on `com.darkrockstudios.apps.hammer.common.BuildConfig.FDROID` rather than -re-reading the Gradle property. For anything else that varies per vehicle, use -`DistributionChannel.current`. +When adding new runtime behaviour that should differ between channels, branch on +`com.darkrockstudios.apps.hammer.common.BuildConfig.FDROID` rather than re-reading the +Gradle property. ## Client Development diff --git a/PRIVACY.md b/PRIVACY.md index 9d5e04637..81f15750a 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -1,6 +1,6 @@ # Privacy Policy -_Last updated: 15 September 2026_ +_Last updated: 21 July 2026_ This is a plain-language explanation of how Hammer handles your data, from Dark Rock Studios, the makers of Hammer. The short version: Hammer is offline-first, your writing lives on your own @@ -35,12 +35,8 @@ leaves your device unless you choose to send it. ## 5. Security For anything that does leave your device through a feature you turned on, we do our best to protect -it. Hammer connects to a sync server over an encrypted HTTPS connection unless you deliberately -enter an address beginning with `http://`, which some people need for a server on their own home -network. A plain `http://` connection is not encrypted, so your account details and the writing you -sync can be read by anyone who can see that network. The app warns you when you enter such an -address. That said, no method of sending data over the internet is ever completely secure, and we -won't pretend otherwise. +it. That said, no method of sending data over the internet is ever completely secure, and we won't +pretend otherwise. ## 6. Links to other places diff --git a/README.md b/README.md index eb1d27435..65327837f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A simple tool for building stories. ![badge-platform-android] ![badge-platform-ios] ![badge-platform-windows] ![badge-platform-linux] ![badge-platform-macos] -[![Discord badge](https://img.shields.io/discord/1100282852295327744?logo=discord)](https://discord.gg/49Kj5mMj6d) +[![Discord badge](https://img.shields.io/discord/1100282852295327744?logo=discord)](https://discord.gg/GTmgjZcupk) [![Crowdin](https://badges.crowdin.net/hammer-editor/localized.svg)](https://crowdin.com/project/hammer-editor) ### Available on: @@ -15,15 +15,13 @@ A simple tool for building stories. | Platform | App Store | Direct download | |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Android** | [![Google Play](https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.darkrockstudios.apps.hammer.android%26l%3DGoogle%2520Play%26m%3D%24version)](https://play.google.com/store/apps/details?id=com.darkrockstudios.apps.hammer.android) [![F-Droid](https://img.shields.io/f-droid/v/com.darkrockstudios.apps.hammer.android?logo=FDROID)](https://f-droid.org/en/packages/com.darkrockstudios.apps.hammer.android/) | [![.apk](https://img.shields.io/badge/.apk-3DDC84?logo=android&logoColor=white)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.apk) | -| **iOS** | [![App Store](https://img.shields.io/badge/App_Store-0D96F6?logo=apple&logoColor=white)](https://apps.apple.com/us/app/hammer-editor/id6770841038) | — | +| **iOS** | [![App Store](https://img.shields.io/badge/App_Store-0D96F6?logo=apple&logoColor=white)](https://apps.apple.com/us/app/hammer-editor/id6771650681) | — | | **Windows** | [![Microsoft Store](https://img.shields.io/badge/Microsoft_Store-0078D4?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0iI2ZmZmZmZiI+PHBhdGggZD0iTTAgMy40NDlMOS43NSAyLjF2OS40NTFIMG0xMC45NDktOS42MDJMMjQgMHYxMS40SDEwLjk0OU0wIDEyLjZoOS43NXY5LjQ1MUwwIDIwLjY5OU0xMC45NDkgMTIuNkgyNFYyNGwtMTIuOS0xLjgwMSIvPjwvc3ZnPg==)](https://apps.microsoft.com/detail/9p84lm8qv5x6) | [![.msi](https://img.shields.io/badge/.msi-0078D4?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0iI2ZmZmZmZiI+PHBhdGggZD0iTTAgMy40NDlMOS43NSAyLjF2OS40NTFIMG0xMC45NDktOS42MDJMMjQgMHYxMS40SDEwLjk0OU0wIDEyLjZoOS43NXY5LjQ1MUwwIDIwLjY5OU0xMC45NDkgMTIuNkgyNFYyNGwtMTIuOS0xLjgwMSIvPjwvc3ZnPg==)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.msi) [![.exe](https://img.shields.io/badge/.exe-0078D4?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0iI2ZmZmZmZiI+PHBhdGggZD0iTTAgMy40NDlMOS43NSAyLjF2OS40NTFIMG0xMC45NDktOS42MDJMMjQgMHYxMS40SDEwLjk0OU0wIDEyLjZoOS43NXY5LjQ1MUwwIDIwLjY5OU0xMC45NDkgMTIuNkgyNFYyNGwtMTIuOS0xLjgwMSIvPjwvc3ZnPg==)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.exe) | | **macOS** | [![Mac App Store](https://img.shields.io/badge/Mac_App_Store-000000?logo=apple&logoColor=white)](https://apps.apple.com/us/app/hammer-editor/id6770841038) | [![.dmg](https://img.shields.io/badge/.dmg-000000?logo=apple&logoColor=white)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.dmg) | | **Linux** | [![Snap Store](https://img.shields.io/badge/Snap_Store-82BEA0?logo=snapcraft&logoColor=white)](https://snapcraft.io/hammer-editor) | [![.deb](https://img.shields.io/badge/.deb-A81D33?logo=debian&logoColor=white)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.deb) [![.rpm](https://img.shields.io/badge/.rpm-EE0000?logo=redhat&logoColor=white)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.rpm) [![AppImage](https://img.shields.io/badge/AppImage-FCC624?logo=linux&logoColor=black)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.AppImage) [![Flatpak](https://img.shields.io/badge/Flatpak-4A90D9?logo=flatpak&logoColor=white)](https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.flatpak) | ### Community - -Join our [Discord](https://discord.gg/49Kj5mMj6d) and help us by reporting bugs, making feature -requests, and discussing +Join our [Discord](https://discord.gg/GTmgjZcupk) and help us by reporting bugs, making feature requests, and discussing the future of Hammer. Or visit us on Reddit at [r/hammereditor](https://www.reddit.com/r/hammereditor/) @@ -97,7 +95,7 @@ latest commit.~~ 💡 Have suggestions? 📚 Want to help translate? 🎮 Interested in our other apps? -👉 Join our community of Open Source enthusiasts on [**Discord**](https://discord.gg/49Kj5mMj6d)! +👉 Join our community of Open Source enthusiasts on [**Discord**](https://discord.gg/ju2RQa5x8W)! # Development diff --git a/SUPPORT.md b/SUPPORT.md index 17bf15e7d..64d74a9fa 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -5,7 +5,7 @@ Thanks for using Hammer! If you need help, have feedback, or want to request a f ## Get in touch - **Email:** [darkrockstudios@gmail.com](mailto:darkrockstudios@gmail.com) -- **Chat with us on Discord:** [join discord](https://discord.gg/49Kj5mMj6d) +- **Chat with us on Discord:** [discord.gg/GTmgjZcupk](https://discord.gg/GTmgjZcupk) - **Report a bug or request a feature:** [open an issue on GitHub](https://github.com/Darkrock-Studios/hammer-editor/issues) We aim to reply to support emails within a few business days. @@ -50,12 +50,7 @@ config directory). **macOS:** -`~/Library/Preferences/hammer/0/logs/` - -If you installed Hammer from the Mac App Store, it runs sandboxed and that -path is relocated into the app's container: - -`~/Library/Containers/com.darkrockstudios.apps.hammer/Data/Library/Preferences/hammer/0/logs/` +`~/Library/Application Support/hammer/0/logs/` **Linux:** diff --git a/android/build.gradle.kts b/android/build.gradle.kts index 78478cd8d..69aef9455 100644 --- a/android/build.gradle.kts +++ b/android/build.gradle.kts @@ -40,7 +40,6 @@ dependencies { implementation(libs.work.runtime.ktx) implementation(libs.material) implementation(libs.appcompat) - implementation(libs.core.splashscreen) implementation(libs.multiplatform.settings) androidTestImplementation(libs.androidx.junit) @@ -52,15 +51,7 @@ dependencies { androidTestUtil(libs.orchestrator) implementation(libs.aboutlibraries.core) - if (!isFDroidBuild) { - implementation(libs.play.services.wearable) - implementation(libs.coroutines.play.services) - implementation(libs.lifecycle.process) - } - testImplementation(platform(libs.junit.bom)) testImplementation(libs.bundles.junit.jupiter) - testRuntimeOnly(libs.junit.platform.launcher) - testImplementation(libs.coroutines.test) androidTestImplementation(libs.bundles.junit.jupiter) } @@ -79,14 +70,6 @@ android { useSupportLibrary = true } } - // Wear OS pairing needs Google Play services, which F-Droid builds may not ship. - if (isFDroidBuild) { - sourceSets.getByName("main").kotlin.srcDir("src/nogms/kotlin") - } else { - sourceSets.getByName("main").kotlin.srcDir("src/gms/kotlin") - sourceSets.getByName("main").res.srcDir("src/gms/res") - sourceSets.getByName("test").kotlin.srcDir("src/testGms/kotlin") - } if (isFDroidBuild) { // Swap in the manifest that also declares the public-storage permissions. sourceSets.getByName("main").manifest.srcFile("src/fdroid/AndroidManifest.xml") @@ -128,8 +111,7 @@ android { proguardFiles( getDefaultProguardFile("proguard-android-optimize.txt"), - rootProject.file("proguard-common.pro"), - file("proguard-rules.pro") + File("proguard-rules.pro") ) } } diff --git a/android/proguard-rules.pro b/android/proguard-rules.pro index 6d76544e0..db381a3ef 100644 --- a/android/proguard-rules.pro +++ b/android/proguard-rules.pro @@ -1,8 +1,57 @@ -# Phone-only rules. Rules shared with the wear app live in /proguard-common.pro. +-dontobfuscate -# Glance instantiates ActionCallback implementations reflectively via their no-arg -# constructor. Glance's own consumer rule keeps the class but not its members, so -# R8 strips the constructor and every widget tap throws NoSuchMethodException. --keepclassmembers class * implements androidx.glance.appwidget.action.ActionCallback { - (); +# Keep exception class names and their constructors for proper stack traces +-keep class * extends java.lang.Exception { *; } +-keep class * extends java.lang.RuntimeException { *; } +-keep class * extends java.lang.Throwable { *; } + +# Keep `Companion` object fields of serializable classes. +# This avoids serializer lookup through `getDeclaredClasses` as done for named companion objects. +-if @kotlinx.serialization.Serializable class ** +-keepclassmembers class <1> { + static <1>$Companion Companion; } + +# Keep `serializer()` on companion objects (both default and named) of serializable classes. +-if @kotlinx.serialization.Serializable class ** { + static **$* *; +} +-keepclassmembers class <2>$<3> { + kotlinx.serialization.KSerializer serializer(...); +} + +# Keep `INSTANCE.serializer()` of serializable objects. +-if @kotlinx.serialization.Serializable class ** { + public static ** INSTANCE; +} +-keepclassmembers class <1> { + public static <1> INSTANCE; + kotlinx.serialization.KSerializer serializer(...); +} + +# @Serializable and @Polymorphic are used at runtime for polymorphic serialization. +-keepattributes RuntimeVisibleAnnotations,AnnotationDefault + +# Serializer for classes with named companion objects are retrieved using `getDeclaredClasses`. +# If you have any, uncomment and replace classes with those containing named companion objects. +#-keepattributes InnerClasses # Needed for `getDeclaredClasses`. +#-if @kotlinx.serialization.Serializable class +#com.example.myapplication.HasNamedCompanion, # <-- List serializable classes with named companions. +#com.example.myapplication.HasNamedCompanion2 +#{ +# static **$* *; +#} +#-keepnames class <1>$$serializer { # -keepnames suffices; class is kept when serializer() is kept. +# static <1>$$serializer INSTANCE; +#} + +# Animal Sniffer compileOnly dependency to ensure APIs are compatible with older versions of Java. +-dontwarn org.codehaus.mojo.animal_sniffer.* + +# Logging +-keep class io.github.aakira.napier.** { *; } +-dontwarn org.slf4j.** +-assumenosideeffects class org.slf4j.Logger { + public void trace(...); + public void debug(...); +} \ No newline at end of file diff --git a/android/src/androidTest/kotlin/EditorTestHarness.kt b/android/src/androidTest/kotlin/EditorTestHarness.kt index 4f0bbc24f..4d23da5a6 100644 --- a/android/src/androidTest/kotlin/EditorTestHarness.kt +++ b/android/src/androidTest/kotlin/EditorTestHarness.kt @@ -6,7 +6,6 @@ import androidx.compose.ui.test.ComposeTimeoutException import androidx.compose.ui.test.SemanticsMatcher import androidx.compose.ui.test.junit4.ComposeTestRule import androidx.compose.ui.test.onAllNodesWithTag -import androidx.compose.ui.test.onFirst import androidx.compose.ui.test.onNodeWithTag import androidx.compose.ui.test.performClick import androidx.test.core.app.ActivityScenario @@ -16,7 +15,6 @@ import com.darkrockstudios.apps.hammer.common.data.ClientResult import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import org.koin.java.KoinJavaComponent.getKoin -import java.io.IOException /** * Shared helpers for editor instrumented tests: seed a project through the real Koin graph, @@ -32,10 +30,7 @@ object EditorTestHarness { /** Create a uniquely-named project so re-runs don't collide; returns its def. */ fun seedProject(baseName: String): ProjectDef { - val result = repository().createProject( - "$baseName ${System.currentTimeMillis()}", - seedDefaultLanguage = true, - ) + val result = repository().createProject("$baseName ${System.currentTimeMillis()}") check(result is ClientResult.Success) { "Failed to seed project: $result" } return result.data } @@ -48,37 +43,8 @@ object EditorTestHarness { scenario.onActivity { it.finish() } InstrumentationRegistry.getInstrumentation().waitForIdleSync() scenario.close() - deleteProjectWhenSettled(projectDef) + repository().deleteProject(projectDef) } - - /** - * Delete the project directory, tolerating writes that are still landing. - * - * finish() and waitForIdleSync() only drain the main thread, but the project-scope close - * flushes scene buffers on IO coroutines after that. A straggler write can land between - * deleteRecursively emptying the directory and removing it, so the final rmdir fails with - * "failed to delete ". Each retry deletes whatever reappeared, so this - * converges as soon as the flushes stop. - */ - fun deleteProjectWhenSettled(projectDef: ProjectDef, timeoutMillis: Long = 15_000L) { - val deadline = SystemClock.uptimeMillis() + timeoutMillis - var lastFailure: IOException? = null - while (SystemClock.uptimeMillis() < deadline) { - try { - repository().deleteProject(projectDef) - return - } catch (e: IOException) { - lastFailure = e - SystemClock.sleep(DELETE_RETRY_INTERVAL_MS) - } - } - throw AssertionError( - "Project directory was still being written to ${timeoutMillis}ms after teardown began", - lastFailure, - ) - } - - private const val DELETE_RETRY_INTERVAL_MS = 100L } /** Matches nodes whose testTag starts with [prefix] - for list items keyed by an unknown id. */ @@ -101,57 +67,6 @@ fun ComposeTestRule.navigateTo(navTag: String) { onNodeWithTag(navTag).performClick() } -/** - * Click the first node matching [matcher] and wait for [landed] to confirm the click took effect. - * - * A single injected tap is occasionally dropped before `clickable` resolves it into an onClick, - * which leaves the screen unchanged and reports no error. Re-inject until the expected outcome - * appears rather than trusting one injection. - * - * Fails if [matcher] never resolves, and never reports success without having clicked: a [landed] - * that is already true on entry would otherwise pass the step without touching the target. - */ -fun ComposeTestRule.clickUntil( - matcher: SemanticsMatcher, - timeoutMillis: Long = 10_000L, - landed: () -> Boolean, -) { - val deadline = SystemClock.uptimeMillis() + timeoutMillis - var clicked = false - while (true) { - // Only re-click while the target is still on screen; once it's gone the click did land and - // the screen is mid-change, so clicking again would hit whatever replaced it. - if (onAllNodes(matcher).fetchSemanticsNodes().isNotEmpty()) { - onAllNodes(matcher).onFirst().performClick() - clicked = true - } - - if (!clicked) { - if (SystemClock.uptimeMillis() >= deadline) { - throw AssertionError( - "'${matcher.description}' never appeared within ${timeoutMillis}ms, so it was never clicked", - ) - } - SystemClock.sleep(CLICK_RETRY_INTERVAL_MS) - continue - } - - try { - waitUntil(timeoutMillis = 1_000L) { landed() } - return - } catch (e: ComposeTimeoutException) { - if (SystemClock.uptimeMillis() >= deadline) { - throw AssertionError( - "Click on '${matcher.description}' never took effect within ${timeoutMillis}ms", - e, - ) - } - } - } -} - -private const val CLICK_RETRY_INTERVAL_MS = 100L - /** * Type into the tagged markdown/scene editor and wait for the edit to land. * diff --git a/android/src/androidTest/kotlin/EncyclopediaWorkflowTest.kt b/android/src/androidTest/kotlin/EncyclopediaWorkflowTest.kt index 4f9f6a1e3..a2871256e 100644 --- a/android/src/androidTest/kotlin/EncyclopediaWorkflowTest.kt +++ b/android/src/androidTest/kotlin/EncyclopediaWorkflowTest.kt @@ -66,7 +66,8 @@ class EncyclopediaWorkflowTest { composeRule.onAllNodes(hasTestTagPrefix("encyclopedia-entry-")).onFirst().assertIsDisplayed() // Opening it leaves the browse list - the create FAB only shows there. - composeRule.clickUntil(hasTestTagPrefix("encyclopedia-entry-")) { + composeRule.onAllNodes(hasTestTagPrefix("encyclopedia-entry-")).onFirst().performClick() + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(ENCYCLOPEDIA_CREATE_FAB_TAG).fetchSemanticsNodes().isEmpty() } } diff --git a/android/src/androidTest/kotlin/ProjectLifecycleTest.kt b/android/src/androidTest/kotlin/ProjectLifecycleTest.kt index ba99751ff..d6506b6a4 100644 --- a/android/src/androidTest/kotlin/ProjectLifecycleTest.kt +++ b/android/src/androidTest/kotlin/ProjectLifecycleTest.kt @@ -3,10 +3,10 @@ import androidx.compose.runtime.ExperimentalComposeApi import androidx.compose.ui.test.assertIsDisplayed import androidx.compose.ui.test.hasClickAction import androidx.compose.ui.test.hasSetTextAction -import androidx.compose.ui.test.hasTestTag import androidx.compose.ui.test.hasText import androidx.compose.ui.test.junit4.createAndroidComposeRule import androidx.compose.ui.test.onAllNodesWithText +import androidx.compose.ui.test.onNodeWithTag import androidx.compose.ui.test.onNodeWithText import androidx.compose.ui.test.performClick import androidx.compose.ui.test.performTextInput @@ -44,11 +44,12 @@ class ProjectLifecycleTest { @Test fun createProjectThenOpenIt() { // 1. Open the create dialog (masthead button when wide, bottom bar when narrow). - composeRule.clickUntil(hasTestTag(CreateProjectButtonTestTag)) { - composeRule.onAllNodes(hasSetTextAction()).fetchSemanticsNodes().isNotEmpty() - } + composeRule.onNodeWithTag(CreateProjectButtonTestTag).performClick() // 2. Type the project name into the dialog's only editable field, then confirm. + composeRule.waitUntil(timeoutMillis = 5_000) { + composeRule.onAllNodes(hasSetTextAction()).fetchSemanticsNodes().isNotEmpty() + } composeRule.onNode(hasSetTextAction()).performTextInput(projectName) // The confirm button and the dialog title both read "Create Project"; @@ -88,6 +89,6 @@ class ProjectLifecycleTest { @After fun deleteCreatedProject() { val repository = getKoin().get() - EditorTestHarness.deleteProjectWhenSettled(repository.getProjectDefinition(projectName)) + repository.deleteProject(repository.getProjectDefinition(projectName)) } } diff --git a/android/src/androidTest/kotlin/SceneEditorWorkflowTest.kt b/android/src/androidTest/kotlin/SceneEditorWorkflowTest.kt index 1c2722646..ff59e0ea3 100644 --- a/android/src/androidTest/kotlin/SceneEditorWorkflowTest.kt +++ b/android/src/androidTest/kotlin/SceneEditorWorkflowTest.kt @@ -1,7 +1,7 @@ -import androidx.compose.ui.test.hasTestTag import androidx.compose.ui.test.junit4.createEmptyComposeRule import androidx.compose.ui.test.onAllNodesWithTag import androidx.compose.ui.test.onNodeWithTag +import androidx.compose.ui.test.performClick import androidx.compose.ui.test.performImeAction import androidx.compose.ui.test.performTextInput import androidx.test.core.app.ActivityScenario @@ -44,10 +44,12 @@ class SceneEditorWorkflowTest { composeRule.navigateTo(NAV_EDITOR_TAG) // Create a scene and open it. - composeRule.clickUntil(hasTestTag(SCENE_LIST_ADD_BUTTON_TAG)) { - composeRule.onAllNodesWithTag(SCENE_LIST_ADD_SCENE_TAG).fetchSemanticsNodes().isNotEmpty() + composeRule.waitUntil(10_000) { + composeRule.onAllNodesWithTag(SCENE_LIST_ADD_BUTTON_TAG).fetchSemanticsNodes().isNotEmpty() } - composeRule.clickUntil(hasTestTag(SCENE_LIST_ADD_SCENE_TAG)) { + composeRule.onNodeWithTag(SCENE_LIST_ADD_BUTTON_TAG).performClick() + composeRule.onNodeWithTag(SCENE_LIST_ADD_SCENE_TAG).performClick() + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(CREATE_ITEM_NAME_FIELD_TAG).fetchSemanticsNodes().isNotEmpty() } composeRule.onNodeWithTag(CREATE_ITEM_NAME_FIELD_TAG).performTextInput("Opening") @@ -63,7 +65,8 @@ class SceneEditorWorkflowTest { } // Saving clears the dirty buffer, so the save action disappears. - composeRule.clickUntil(hasTestTag(SCENE_EDITOR_SAVE_TAG)) { + composeRule.onNodeWithTag(SCENE_EDITOR_SAVE_TAG).performClick() + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(SCENE_EDITOR_SAVE_TAG).fetchSemanticsNodes().isEmpty() } } diff --git a/android/src/androidTest/kotlin/SceneListWorkflowTest.kt b/android/src/androidTest/kotlin/SceneListWorkflowTest.kt index 5d28b525b..735442ebc 100644 --- a/android/src/androidTest/kotlin/SceneListWorkflowTest.kt +++ b/android/src/androidTest/kotlin/SceneListWorkflowTest.kt @@ -1,9 +1,9 @@ import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.hasTestTag import androidx.compose.ui.test.junit4.createEmptyComposeRule import androidx.compose.ui.test.onAllNodesWithTag import androidx.compose.ui.test.onFirst import androidx.compose.ui.test.onNodeWithTag +import androidx.compose.ui.test.performClick import androidx.compose.ui.test.performImeAction import androidx.compose.ui.test.performTextInput import androidx.test.core.app.ActivityScenario @@ -62,10 +62,12 @@ class SceneListWorkflowTest { // Open the add menu, pick scene/group, type a name, submit via the IME action. private fun addItem(menuItemTag: String, name: String) { - composeRule.clickUntil(hasTestTag(SCENE_LIST_ADD_BUTTON_TAG)) { - composeRule.onAllNodesWithTag(menuItemTag).fetchSemanticsNodes().isNotEmpty() + composeRule.waitUntil(10_000) { + composeRule.onAllNodesWithTag(SCENE_LIST_ADD_BUTTON_TAG).fetchSemanticsNodes().isNotEmpty() } - composeRule.clickUntil(hasTestTag(menuItemTag)) { + composeRule.onNodeWithTag(SCENE_LIST_ADD_BUTTON_TAG).performClick() + composeRule.onNodeWithTag(menuItemTag).performClick() + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(CREATE_ITEM_NAME_FIELD_TAG).fetchSemanticsNodes().isNotEmpty() } composeRule.onNodeWithTag(CREATE_ITEM_NAME_FIELD_TAG).performTextInput(name) diff --git a/android/src/androidTest/kotlin/TimelineWorkflowTest.kt b/android/src/androidTest/kotlin/TimelineWorkflowTest.kt index cbd077033..185201f81 100644 --- a/android/src/androidTest/kotlin/TimelineWorkflowTest.kt +++ b/android/src/androidTest/kotlin/TimelineWorkflowTest.kt @@ -1,5 +1,4 @@ import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.hasTestTag import androidx.compose.ui.test.junit4.createEmptyComposeRule import androidx.compose.ui.test.onAllNodesWithTag import androidx.compose.ui.test.onNodeWithTag @@ -43,8 +42,14 @@ class TimelineWorkflowTest { fun createEventThenOpenIt() { composeRule.navigateTo(NAV_TIMELINE_TAG) - // Open the create screen via the FAB. Content is optional, so a date alone persists an event. - composeRule.clickUntil(hasTestTag(TIME_LINE_CREATE_TAG)) { + // Open the create screen via the FAB. + composeRule.waitUntil(10_000) { + composeRule.onAllNodesWithTag(TIME_LINE_CREATE_TAG).fetchSemanticsNodes().isNotEmpty() + } + composeRule.onNodeWithTag(TIME_LINE_CREATE_TAG).performClick() + + // Content is optional, so a date alone persists an event. + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(TIME_LINE_CREATE_DATE_TAG).fetchSemanticsNodes().isNotEmpty() } composeRule.onNodeWithTag(TIME_LINE_CREATE_DATE_TAG).performTextInput("Year One") @@ -57,7 +62,8 @@ class TimelineWorkflowTest { composeRule.onAllNodesWithTag(EVENT_CARD_TAG)[0].assertIsDisplayed() // Opening the event leaves the overview - the create FAB only shows there. - composeRule.clickUntil(hasTestTag(EVENT_CARD_TAG)) { + composeRule.onAllNodesWithTag(EVENT_CARD_TAG)[0].performClick() + composeRule.waitUntil(10_000) { composeRule.onAllNodesWithTag(TIME_LINE_CREATE_TAG).fetchSemanticsNodes().isEmpty() } } diff --git a/android/src/fdroid/AndroidManifest.xml b/android/src/fdroid/AndroidManifest.xml index 1b4b29426..b6d94a7b4 100644 --- a/android/src/fdroid/AndroidManifest.xml +++ b/android/src/fdroid/AndroidManifest.xml @@ -30,7 +30,6 @@ = listOf(wearPairingModule) diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingActivity.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingActivity.kt deleted file mode 100644 index 68fd1f7f4..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingActivity.kt +++ /dev/null @@ -1,148 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import android.content.Context -import android.content.Intent -import android.os.Bundle -import android.widget.Toast -import androidx.activity.ComponentActivity -import androidx.activity.compose.BackHandler -import androidx.activity.compose.setContent -import androidx.activity.enableEdgeToEdge -import androidx.compose.foundation.isSystemInDarkTheme -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.systemBarsPadding -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.core.app.NotificationManagerCompat -import com.darkrockstudios.apps.hammer.android.R -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.UiTheme -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject -import org.koin.core.qualifier.named - -class WearPairingActivity : ComponentActivity(), KoinComponent { - - private val handler: WearPairingHandler by inject() - private val globalSettingsStore: GlobalSettingsStore by inject() - private val appScope: CoroutineScope by inject(named(APP_SCOPE)) - - private var nodeId: String? = null - private var request: PairRequest? = null - private var answered = false - - override fun onCreate(savedInstanceState: Bundle?) { - super.onCreate(savedInstanceState) - enableEdgeToEdge() - - // Drop touches delivered while another app's window overlays this dialog, so a tapjacking - // overlay can't approve a pairing on the user's behalf. - window.decorView.filterTouchesWhenObscured = true - setFinishOnTouchOutside(false) - window.setBackgroundDrawableResource(android.R.color.transparent) - - val sourceNode = intent.getStringExtra(EXTRA_NODE_ID) - val pairRequest = intent.getByteArrayExtra(EXTRA_REQUEST)?.let(PairingProtocol::decodeRequest) - if (sourceNode == null || pairRequest == null) { - finish() - return - } - nodeId = sourceNode - request = pairRequest - NotificationManagerCompat.from(this).cancel(notificationId(pairRequest.requestId)) - - val accountEmail = if (handler.isSignedIn()) globalSettingsStore.serverSettings?.email else null - val settings = globalSettingsStore.globalSettings - - setContent { - val isDark = when (settings.uiTheme) { - UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true - UiTheme.FollowSystem -> isSystemInDarkTheme() - } - - BackHandler { decline() } - - AppTheme(settings = settings, useDarkTheme = isDark) { - Box( - modifier = Modifier - .fillMaxWidth() - .systemBarsPadding() - .padding(Ui.Padding.M), - contentAlignment = Alignment.Center, - ) { - WearPairingDialog( - deviceLabel = pairRequest.deviceLabel, - accountEmail = accountEmail, - onApprove = ::approve, - onDecline = ::decline, - ) - } - } - } - } - - // The reply runs in the app scope so it still reaches the watch after this dialog closes. - private fun approve() { - val sourceNode = nodeId ?: return - val pairRequest = request ?: return - answered = true - val appContext = applicationContext - appScope.launch { - val response = handler.approve(sourceNode, pairRequest) - val message = when (response) { - is PairResponse.Success -> R.string.wear_pairing_toast_success - is PairResponse.Error -> R.string.wear_pairing_toast_failure - } - if (handler.isSignedIn()) { - withContext(Dispatchers.Main) { - Toast.makeText(appContext, message, Toast.LENGTH_SHORT).show() - } - } - } - finish() - } - - private fun decline() { - val sourceNode = nodeId ?: return - val pairRequest = request ?: return - answered = true - appScope.launch { handler.decline(sourceNode, pairRequest) } - finish() - } - - override fun onDestroy() { - super.onDestroy() - // Dismissed without an answer: tell the watch rather than leave it waiting. Only when finishing: - // a backgrounded instance the system reclaims comes back with the prompt still to answer. - if (!answered && isFinishing) { - decline() - } - } - - companion object { - private const val NOTIFICATION_ID_BASE = 7301 - private const val EXTRA_NODE_ID = "node_id" - private const val EXTRA_REQUEST = "request" - - /** Per request, so two watches asking at once do not overwrite each other's prompt. */ - fun notificationId(requestId: String): Int = NOTIFICATION_ID_BASE + (requestId.hashCode() and 0xFFFF) - - fun createIntent(context: Context, nodeId: String, requestPayload: ByteArray): Intent = - Intent(context, WearPairingActivity::class.java) - .putExtra(EXTRA_NODE_ID, nodeId) - .putExtra(EXTRA_REQUEST, requestPayload) - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingDialog.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingDialog.kt deleted file mode 100644 index 16826dd51..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingDialog.kt +++ /dev/null @@ -1,102 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import androidx.compose.foundation.BorderStroke -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.widthIn -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Surface -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.android.R -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMasthead - -private val DialogMaxWidth = 480.dp - -/** [accountEmail] is null when this phone is not signed in to a sync server. */ -@Composable -fun WearPairingDialog( - deviceLabel: String, - accountEmail: String?, - onApprove: () -> Unit, - onDecline: () -> Unit, - modifier: Modifier = Modifier, -) { - Surface( - modifier = modifier - .widthIn(max = DialogMaxWidth) - .fillMaxWidth(), - shape = RectangleShape, - color = MaterialTheme.colorScheme.surface, - contentColor = MaterialTheme.colorScheme.onSurface, - border = BorderStroke(Dp.Hairline, MaterialTheme.colorScheme.outlineVariant), - ) { - Column { - HdMasthead( - section = stringResource(R.string.wear_pairing_masthead), - leadingMeta = listOf(deviceLabel), - ) - HdFolioDivider() - Column( - modifier = Modifier - .fillMaxWidth() - .padding(Ui.Padding.XL), - verticalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - if (accountEmail != null) { - Text( - text = stringResource(R.string.wear_pairing_title, deviceLabel), - style = MaterialTheme.typography.titleMedium, - ) - Text( - text = stringResource(R.string.wear_pairing_body, accountEmail), - style = MaterialTheme.typography.bodyMedium, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - Row( - modifier = Modifier.fillMaxWidth(), - horizontalArrangement = Arrangement.SpaceBetween, - verticalAlignment = Alignment.CenterVertically, - ) { - HdHairlineButton( - label = stringResource(R.string.wear_pairing_decline), - onClick = onDecline, - ) - HdHairlineButton( - label = stringResource(R.string.wear_pairing_approve), - emphasised = true, - onClick = onApprove, - ) - } - } else { - Text( - text = stringResource(R.string.wear_pairing_not_signed_in), - style = MaterialTheme.typography.bodyLarge, - ) - Row( - modifier = Modifier.fillMaxWidth(), - horizontalArrangement = Arrangement.End, - ) { - // Approving here answers the watch with NotSignedIn rather than a bare decline. - HdHairlineButton( - label = stringResource(R.string.wear_pairing_close), - onClick = onApprove, - ) - } - } - } - } - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandler.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandler.kt deleted file mode 100644 index a9f177331..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandler.kt +++ /dev/null @@ -1,75 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.isSuccess -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException - -/** Answers a watch's pairing request once the user has approved or declined it on the phone. */ -class WearPairingHandler( - private val serverSettings: () -> ServerSettings?, - private val pairInstall: suspend (installId: String) -> CResult, - private val responder: PairingResponder, -) { - fun isSignedIn(): Boolean { - val settings = serverSettings() ?: return false - return settings.userId >= 0 && !settings.bearerToken.isNullOrBlank() - } - - suspend fun approve(nodeId: String, request: PairRequest): PairResponse { - val response = when { - request.version != PairingProtocol.VERSION -> - PairResponse.Error(request.requestId, PairErrorCode.Unsupported) - - !isSignedIn() -> - PairResponse.Error(request.requestId, PairErrorCode.NotSignedIn) - - else -> { - val result = pairInstall(request.installId) - if (isSuccess(result)) { - PairResponse.Success(request.requestId, result.data) - } else { - PairResponse.Error(request.requestId, PairErrorCode.ServerRejected) - } - } - } - send(nodeId, response) - return response - } - - suspend fun decline(nodeId: String, request: PairRequest): PairResponse { - val response = PairResponse.Error(request.requestId, PairErrorCode.Declined) - send(nodeId, response) - return response - } - - /** - * Replies to a request this phone could not read, so the watch stops waiting. The request id is - * unknown precisely because the payload could not be decoded, so this answers with a blank one, - * which the watch matches against whatever it has pending. - */ - suspend fun rejectUnreadable(nodeId: String) { - send(nodeId, PairResponse.Error(requestId = "", code = PairErrorCode.Unsupported)) - } - - /** Replies when the confirmation cannot be shown, so the watch can tell the user what to do. */ - suspend fun reportUnavailable(nodeId: String, request: PairRequest) { - send(nodeId, PairResponse.Error(request.requestId, PairErrorCode.PhoneUnavailable)) - } - - private suspend fun send(nodeId: String, response: PairResponse) { - try { - responder.respond(nodeId, response) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - // The watch may have gone out of range; it can retry from its own screen. - Napier.w("Failed to reply to the watch", e) - } - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingListenerService.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingListenerService.kt deleted file mode 100644 index b46cfbabe..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingListenerService.kt +++ /dev/null @@ -1,100 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import android.Manifest -import android.annotation.SuppressLint -import android.app.PendingIntent -import android.content.Intent -import android.content.pm.PackageManager -import android.os.Build -import androidx.core.app.NotificationChannelCompat -import androidx.core.app.NotificationCompat -import androidx.core.app.NotificationManagerCompat -import androidx.lifecycle.Lifecycle -import androidx.lifecycle.ProcessLifecycleOwner -import com.darkrockstudios.apps.hammer.android.R -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import com.google.android.gms.wearable.MessageEvent -import com.google.android.gms.wearable.WearableListenerService -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.launch -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject -import org.koin.core.qualifier.named - -/** - * Receives a watch's pairing request. The user must approve it on the phone, so this only brings - * up [WearPairingActivity]: directly when Hammer is on screen, through a notification otherwise, - * since Android blocks activity starts from the background. - */ -class WearPairingListenerService : WearableListenerService(), KoinComponent { - - private val handler: WearPairingHandler by inject() - private val appScope: CoroutineScope by inject(named(APP_SCOPE)) - - override fun onMessageReceived(event: MessageEvent) { - if (event.path != PairingProtocol.REQUEST_PATH) return - - val request = PairingProtocol.decodeRequest(event.data) - if (request == null) { - appScope.launch { handler.rejectUnreadable(event.sourceNodeId) } - return - } - - val intent = WearPairingActivity.createIntent(this, event.sourceNodeId, event.data) - val appVisible = ProcessLifecycleOwner.get().lifecycle.currentState.isAtLeast(Lifecycle.State.STARTED) - if (appVisible) { - startActivity(intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)) - } else if (!showNotification(intent, request.requestId)) { - // Nothing can put the prompt in front of the user, so answer instead of leaving the - // watch waiting on a confirmation that will never appear. - appScope.launch { handler.reportUnavailable(event.sourceNodeId, request) } - } - } - - /** False when the prompt could not be raised, so the caller can answer the watch instead. */ - @SuppressLint("MissingPermission") - private fun showNotification(intent: Intent, requestId: String): Boolean { - if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU && - checkSelfPermission(Manifest.permission.POST_NOTIFICATIONS) != PackageManager.PERMISSION_GRANTED - ) { - Napier.w("Cannot show the watch pairing prompt: notification permission not granted") - return false - } - - val notificationId = WearPairingActivity.notificationId(requestId) - val manager = NotificationManagerCompat.from(this) - manager.createNotificationChannel( - NotificationChannelCompat.Builder(CHANNEL_ID, NotificationManagerCompat.IMPORTANCE_HIGH) - .setName(getString(R.string.wear_pairing_channel_name)) - .build() - ) - - val pendingIntent = PendingIntent.getActivity( - this, - notificationId, - intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK), - PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT, - ) - val notification = NotificationCompat.Builder(this, CHANNEL_ID) - .setSmallIcon(R.drawable.ic_launcher_monochrome) - .setContentTitle(getString(R.string.wear_pairing_notification_title)) - .setContentText(getString(R.string.wear_pairing_notification_text)) - .setContentIntent(pendingIntent) - .setAutoCancel(true) - .setPriority(NotificationCompat.PRIORITY_HIGH) - .build() - return try { - manager.notify(notificationId, notification) - true - } catch (@Suppress("SwallowedException") e: SecurityException) { - Napier.w("Cannot show the watch pairing prompt", e) - false - } - } - - private companion object { - const val CHANNEL_ID = "wear_pairing" - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingResponder.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingResponder.kt deleted file mode 100644 index 109bef652..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingResponder.kt +++ /dev/null @@ -1,21 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import android.content.Context -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.google.android.gms.wearable.Wearable -import kotlinx.coroutines.tasks.await - -interface PairingResponder { - suspend fun respond(nodeId: String, response: PairResponse) -} - -class WearPairingResponder(context: Context) : PairingResponder { - private val messageClient = Wearable.getMessageClient(context) - - override suspend fun respond(nodeId: String, response: PairResponse) { - messageClient - .sendMessage(nodeId, PairingProtocol.RESPONSE_PATH, PairingProtocol.encodeResponse(response)) - .await() - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/preview/WearPairingDialog.Preview.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/preview/WearPairingDialog.Preview.kt deleted file mode 100644 index 5555c1a16..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/preview/WearPairingDialog.Preview.kt +++ /dev/null @@ -1,40 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear.preview - -import androidx.compose.foundation.layout.padding -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import com.darkrockstudios.apps.hammer.android.wear.WearPairingDialog -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings - -private val previewSettings = GlobalSettings(projectsDirectory = "/projects") - -@Preview -@Composable -private fun WearPairingDialogSignedInPreview() { - AppTheme(settings = previewSettings, useDarkTheme = false) { - WearPairingDialog( - deviceLabel = "Pixel Watch 3", - accountEmail = "writer@example.com", - onApprove = {}, - onDecline = {}, - modifier = Modifier.padding(Ui.Padding.M), - ) - } -} - -@Preview -@Composable -private fun WearPairingDialogNotSignedInDarkPreview() { - AppTheme(settings = previewSettings, useDarkTheme = true) { - WearPairingDialog( - deviceLabel = "Pixel Watch 3", - accountEmail = null, - onApprove = {}, - onDecline = {}, - modifier = Modifier.padding(Ui.Padding.M), - ) - } -} diff --git a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/wearPairingModule.kt b/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/wearPairingModule.kt deleted file mode 100644 index e087c4204..000000000 --- a/android/src/gms/kotlin/com/darkrockstudios/apps/hammer/android/wear/wearPairingModule.kt +++ /dev/null @@ -1,19 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import org.koin.core.module.Module -import org.koin.dsl.module - -val wearPairingModule: Module = module { - single { WearPairingResponder(context = get()) } - single { - val globalSettingsStore: GlobalSettingsStore = get() - val accountUseCase: AccountUseCase = get() - WearPairingHandler( - serverSettings = { globalSettingsStore.serverSettings }, - pairInstall = accountUseCase::pairInstall, - responder = get(), - ) - } -} diff --git a/android/src/gms/res/raw/keep.xml b/android/src/gms/res/raw/keep.xml deleted file mode 100644 index a1b2350be..000000000 --- a/android/src/gms/res/raw/keep.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - diff --git a/android/src/gms/res/values/wear.xml b/android/src/gms/res/values/wear.xml deleted file mode 100644 index 5ffb2d5ca..000000000 --- a/android/src/gms/res/values/wear.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - hammer_phone_pairing - - diff --git a/android/src/main/AndroidManifest.xml b/android/src/main/AndroidManifest.xml index 0fe741212..d9f0a0c69 100644 --- a/android/src/main/AndroidManifest.xml +++ b/android/src/main/AndroidManifest.xml @@ -5,13 +5,10 @@ - - @@ -104,26 +100,6 @@ android:resource="@xml/story_info_widget_info"/> - - - - - - - - - - + runCatching { + Napier.e( + "Uncaught exception on thread '${thread.name}', terminating", + throwable + ) + } + runCatching { writeCrashDump(thread, throwable) } + previous?.uncaughtException(thread, throwable) + } + } + + /** Synchronous, self-contained crash record in the logs dir — the guaranteed artifact when the app dies. */ + private fun writeCrashDump(thread: Thread, throwable: Throwable) { + val dir = File(getConfigDirectory(), "logs") + dir.mkdirs() + File(dir, "crash-${System.currentTimeMillis()}.txt").writeText( + buildString { + append("Hammer v${BuildMetadata.APP_VERSION} | ${platformStartupInfo()}\n") + append("Uncaught exception on thread '${thread.name}'\n\n") + append(throwable.stackTraceToString()) + } + ) + } + override fun onTerminate() { super.onTerminate() applicationScope.cancel("Application onTerminate") diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectRootActivity.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectRootActivity.kt index dc3a8f639..bb10e9bd6 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectRootActivity.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectRootActivity.kt @@ -30,7 +30,6 @@ import com.darkrockstudios.apps.hammer.android.shortcuts.ProjectShortcutsManager import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectDeepLink import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectRoot import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectRootComponent -import com.darkrockstudios.apps.hammer.common.compose.ProjectShortcutHost import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.closeProjectScope @@ -71,7 +70,6 @@ class ProjectRootActivity : AppCompatActivity() { private val viewModel: ProjectRootViewModel by viewModels() private var projectRoot: ProjectRoot? = null - private val shortcutHost = ProjectShortcutHost() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) @@ -109,7 +107,7 @@ class ProjectRootActivity : AppCompatActivity() { val settingsState by globalSettings.subscribeAsState() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> isSystemInDarkTheme() } @@ -187,22 +185,14 @@ class ProjectRootActivity : AppCompatActivity() { } override fun dispatchKeyEvent(event: KeyEvent): Boolean { - if (event.action == KeyEvent.ACTION_DOWN) { - // hasModifiers matches exactly, so AltGr chords fall through and type their character. - val ctrlShift = KeyEvent.META_CTRL_ON or KeyEvent.META_SHIFT_ON - if (event.keyCode == KeyEvent.KEYCODE_F && event.hasModifiers(ctrlShift)) { - projectRoot?.let { - it.showGlobalSearch() - return true - } - } - - if (event.keyCode == KeyEvent.KEYCODE_F3 && event.hasNoModifiers()) { - if (shortcutHost.startProjectSync()) return true - } - - if (event.keyCode == KeyEvent.KEYCODE_S && event.hasModifiers(ctrlShift)) { - if (shortcutHost.saveAllBuffers()) return true + if (event.action == KeyEvent.ACTION_DOWN && + event.keyCode == KeyEvent.KEYCODE_F && + event.isShiftPressed && + event.isCtrlPressed + ) { + projectRoot?.let { + it.showGlobalSearch() + return true } } return super.dispatchKeyEvent(event) @@ -220,12 +210,11 @@ class ProjectRootActivity : AppCompatActivity() { // Only intercept back when at Home AND there's potential unsaved work to confirm // Otherwise, let Android's default back behavior close the activity - val unsavedBuffers by component.unsavedBuffers.subscribeAsState() - BackHandler(enabled = backEnabled && (unsavedBuffers || shouldConfirmClose.isNotEmpty())) { + BackHandler(enabled = backEnabled && (component.hasUnsavedBuffers() || shouldConfirmClose.isNotEmpty())) { component.requestClose() } - ProjectRootScaffold(component, onCloseRequest = ::finish, shortcutHost = shortcutHost) + ProjectRootScaffold(component, onCloseRequest = ::finish) } companion object { diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectSelectActivity.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectSelectActivity.kt index ecea069c1..7b3b2d475 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectSelectActivity.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/ProjectSelectActivity.kt @@ -14,7 +14,6 @@ import androidx.compose.material3.dynamicLightColorScheme import androidx.compose.runtime.ExperimentalComposeApi import androidx.compose.runtime.getValue import androidx.compose.ui.platform.LocalContext -import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen import androidx.lifecycle.lifecycleScope import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.arkivanov.decompose.retainedComponent @@ -44,7 +43,6 @@ class ProjectSelectActivity : AppCompatActivity() { private var settingsUpdateJob: Job? = null override fun onCreate(savedInstanceState: Bundle?) { - installSplashScreen() super.onCreate(savedInstanceState) enableEdgeToEdge() @@ -63,7 +61,7 @@ class ProjectSelectActivity : AppCompatActivity() { val settingsState by globalSettings.subscribeAsState() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> isSystemInDarkTheme() } diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/preview/ProjectSelectActivity.Preview.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/preview/ProjectSelectActivity.Preview.kt index 09c155676..9f1434baf 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/preview/ProjectSelectActivity.Preview.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/preview/ProjectSelectActivity.Preview.kt @@ -18,7 +18,6 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.projec import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState import com.darkrockstudios.apps.hammer.common.data.Msg import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.fileio.HPath @@ -93,20 +92,16 @@ val component = object : ProjectSelection { override val navRailState: Value = MutableValue(ProjectSelection.NavRailState(expanded = false)) - override val changelog: Value = - MutableValue(ProjectSelection.ChangelogState()) - - override val appUpdate: Value = MutableValue(AppUpdateState.Unsupported) + override val updateNotification: Value = + MutableValue(ProjectSelection.UpdateNotificationState()) override fun isAtRoot() = false override fun onBack() {} override fun showLocation(location: ProjectSelection.Locations) {} override fun toggleNavRailExpanded() {} - override fun openLatestRelease() {} - override fun dismissChangelog() {} - override fun showChangelog() {} - override fun updateApp() {} - override fun dismissUpdate() {} + override fun openReleaseUrl() {} + override fun dismissUpdateNotification(remember: Boolean) {} + override fun showCurrentReleaseDetails() {} override val backHandler = dummyBackHandler } diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteActivity.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteActivity.kt index 3a54625ac..6f4012e9a 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteActivity.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteActivity.kt @@ -97,7 +97,7 @@ class AddNoteActivity : ComponentActivity(), KoinComponent { val settingsState by globalSettings.subscribeAsState() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> isSystemInDarkTheme() } diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteWidgetConfigActivity.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteWidgetConfigActivity.kt index 38f3fceee..aa5ecef3d 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteWidgetConfigActivity.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/AddNoteWidgetConfigActivity.kt @@ -90,7 +90,7 @@ class AddNoteWidgetConfigActivity : ComponentActivity() { val settingsState by globalSettings.subscribeAsState() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> isSystemInDarkTheme() } diff --git a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/StoryInfoWidgetConfigActivity.kt b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/StoryInfoWidgetConfigActivity.kt index a41f53df1..02fdc9cab 100644 --- a/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/StoryInfoWidgetConfigActivity.kt +++ b/android/src/main/kotlin/com/darkrockstudios/apps/hammer/android/widgets/StoryInfoWidgetConfigActivity.kt @@ -88,7 +88,7 @@ class StoryInfoWidgetConfigActivity : ComponentActivity() { val settingsState by globalSettings.subscribeAsState() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> isSystemInDarkTheme() } diff --git a/android/src/main/res/values-de/strings_android.xml b/android/src/main/res/values-de/strings_android.xml index b47af77f3..c884ed268 100644 --- a/android/src/main/res/values-de/strings_android.xml +++ b/android/src/main/res/values-de/strings_android.xml @@ -30,7 +30,7 @@ Configure Story Info Widget Tap to configure § %1$s · STORY - von %1$s + by %1$s WORDS %1$d%% OF %2$s %3$s TODAY diff --git a/android/src/main/res/values-de/strings_wear_pairing_android.xml b/android/src/main/res/values-de/strings_wear_pairing_android.xml deleted file mode 100644 index ad5e04d14..000000000 --- a/android/src/main/res/values-de/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Ablehnen - Schließen - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values-es/strings_android.xml b/android/src/main/res/values-es/strings_android.xml index bb7e3d19f..0bc6d2fe1 100644 --- a/android/src/main/res/values-es/strings_android.xml +++ b/android/src/main/res/values-es/strings_android.xml @@ -30,7 +30,7 @@ Configure Story Info Widget Tap to configure § %1$s · STORY - por %1$s + by %1$s WORDS %1$d%% OF %2$s %3$s TODAY diff --git a/android/src/main/res/values-es/strings_wear_pairing_android.xml b/android/src/main/res/values-es/strings_wear_pairing_android.xml deleted file mode 100644 index 73e8b129e..000000000 --- a/android/src/main/res/values-es/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Rechazar - Cerrar - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values-fr/strings_android.xml b/android/src/main/res/values-fr/strings_android.xml index 79e806fb3..9f7519a39 100644 --- a/android/src/main/res/values-fr/strings_android.xml +++ b/android/src/main/res/values-fr/strings_android.xml @@ -25,24 +25,24 @@ Ajouter la Note au projet Si aucun projet n\'est sélectionné, on vous demandera de choisir un projet à chaque fois. Hammer · Bibliothèque -- Ouvrir une histoire - Hammer · Histoire — Aperçu des statistiques pour un projet + Hammer · Histoire — aperçu des statistiques pour un projet Widget d\'info pour une histoire : Configurer le Widget d\'info pour une histoire Appuyez pour configurer § %1$s · HISTOIRE de %1$s MOTS - %1$d%% SUR %2$s %3$s + %1$d%% / %2$s %3$s AUJOURD\'HUI CETTE SEMAINE +%1$d AUJOURD\'HUI AUCUNE SESSION AUJOURD\'HUI SERIE DE %1$dJ SESSIONS · 7J - %1$s S + %1$s SEM. OUVRIR NOTE § %1$s M - CONTINUER · + CONTINUER diff --git a/android/src/main/res/values-fr/strings_wear_pairing_android.xml b/android/src/main/res/values-fr/strings_wear_pairing_android.xml deleted file mode 100644 index 8fbaab47f..000000000 --- a/android/src/main/res/values-fr/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - APPAIRER LA MONTRE - Se connecter à %1$s sur Hammer ? - La montre sera synchronisée en tant que %1$s avec sa propre session. Vous pouvez la déconnecter depuis la montre à tout moment. - Connectez-vous au serveur sur ce smartphone en premier, puis appairez la montre de nouveau. - Appairer - Refuser - Fermer - Montre appairée - La montre n\'a pas pu être appairée - Appairage de la montre - Appairez votre montre - Tapoter pour que votre montre se synchronise avec votre compte Hammer - diff --git a/android/src/main/res/values-it/strings_android.xml b/android/src/main/res/values-it/strings_android.xml index 9afc7c03d..0716ec255 100644 --- a/android/src/main/res/values-it/strings_android.xml +++ b/android/src/main/res/values-it/strings_android.xml @@ -1,48 +1,48 @@ Hammer - Aggiungi nota - Caricamento… - Configura widget - Menu Altro - Cassetto di navigazione - Aggiungi nota a: - Salva - Annulla - Progetti - Progetto non trovato: %1$s - Scartare la nota? - Scarta - Annulla - Aggiungi nota - Nessun progetto - Nota aggiunta - Aggiungi nota - Aggiungi nota alla storia - L\'aggiunta di note è disabilitata al momento - Configura widget - Configura widget note: - Aggiungi note al progetto specificato - Se non viene selezionato alcun progetto, ti verrà chiesto di sceglierne uno ogni volta. - Hammer · Libreria — apri una storia - Hammer · Storia — statistiche rapide per un progetto - Widget info storia: - Configura widget info storia - Tocca per configurare - § %1$s · STORIA - di %1$s - PAROLE - %1$d%% DI %2$s %3$s - OGGI - QUESTA SETTIMANA - +%1$d OGGI - NESSUNA SESSIONE OGGI - SERIE DI %1$dG - SESSIONI · 7G - %1$s P - APRI - NOTA + Add Note + Loading… + Configure Widget + More Menu + Navigation Drawer + Add Note to: + Save + Cancel + Projects + Project not found: %1$s + Discard Note? + Discard + Cancel + Add Note + No projects + Note Added + Add Note + Add Story Note + Adding notes is disabled right now + Configure Widget + Configure Note Widget: + Add notes to specified project + If no project is selected, you will be asked to choose a project each time. + Hammer · Library — open a story + Hammer · Story — at-a-glance stats for one project + Story Info Widget: + Configure Story Info Widget + Tap to configure + § %1$s · STORY + by %1$s + WORDS + %1$d%% OF %2$s %3$s + TODAY + THIS WEEK + +%1$d TODAY + NO SESSION TODAY + %1$dD STREAK + SESSIONS · 7D + %1$s W + OPEN + NOTE § %1$s - P - CONTINUA · + W + CONTINUE · diff --git a/android/src/main/res/values-it/strings_wear_pairing_android.xml b/android/src/main/res/values-it/strings_wear_pairing_android.xml deleted file mode 100644 index cac4461ed..000000000 --- a/android/src/main/res/values-it/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - ASSOCIA OROLOGIO - Accedere come %1$s su Hammer? - L’orologio si sincronizzerà come %1$s con una propria sessione. Puoi disconnetterlo dall’orologio in qualsiasi momento. - Accedi prima a un server di sincronizzazione su questo telefono, poi associa nuovamente l’orologio. - Associa - Rifiuta - Chiudi - Orologio associato - Impossibile associare l’orologio - Associazione orologio - Associa il tuo orologio - Tocca per consentire all’orologio di sincronizzarsi con il tuo account Hammer - diff --git a/android/src/main/res/values-pt-rBR/strings_android.xml b/android/src/main/res/values-pt-rBR/strings_android.xml index 2be293595..e0b4c4e85 100644 --- a/android/src/main/res/values-pt-rBR/strings_android.xml +++ b/android/src/main/res/values-pt-rBR/strings_android.xml @@ -30,7 +30,7 @@ Configure Story Info Widget Tap to configure § %1$s · STORY - por %1$s + by %1$s WORDS %1$d%% OF %2$s %3$s TODAY diff --git a/android/src/main/res/values-pt-rBR/strings_wear_pairing_android.xml b/android/src/main/res/values-pt-rBR/strings_wear_pairing_android.xml deleted file mode 100644 index 9ad272622..000000000 --- a/android/src/main/res/values-pt-rBR/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Recusar - Fechar - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values-tr/strings_android.xml b/android/src/main/res/values-tr/strings_android.xml deleted file mode 100644 index cb2213594..000000000 --- a/android/src/main/res/values-tr/strings_android.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - Hammer - Not Ekle - Yükleniyor… - Widget\'ı Yapılandır - Diğer Menüler - Gezinti Çekmecesi - Notu Şuraya Ekle: - Kaydet - İptal - Projeler - Proje bulunamadı: %1$s - Nottan Vazgeçilsin mi? - Vazgeç - İptal - Not Ekle - Proje yok - Not Eklendi - Not Ekle - Hikâye Notu Ekle - Not ekleme şu anda devre dışı - Widget\'ı Yapılandır - Not Widget\'ını yapılandır: - Notları belirtilen projeye ekle - Eğer seçili bir proje yoksa her seferinde bir proje seçmen istenir. - Hammer · Kütüphane — bir hikâyeyi aç - Hammer · Hikâye — bir proje için özet istatistikler - Hikâye Bilgisi Widget\'ı: - Hikâye Bilgisi Widget\'ını Yapılandır - Yapılandırmak için dokun - § %1$s · HİKÂYE - - %1$s - WORDS - %1$d%% OF %2$s %3$s - TODAY - THIS WEEK - +%1$d TODAY - NO SESSION TODAY - %1$dD STREAK - SESSIONS · 7D - %1$s W - OPEN - NOTE - § %1$s - W - CONTINUE · - diff --git a/android/src/main/res/values-tr/strings_wear_pairing_android.xml b/android/src/main/res/values-tr/strings_wear_pairing_android.xml deleted file mode 100644 index fdda9aaf4..000000000 --- a/android/src/main/res/values-tr/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Decline - Close - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values-uk/strings_android.xml b/android/src/main/res/values-uk/strings_android.xml index 7c787e0e9..0716ec255 100644 --- a/android/src/main/res/values-uk/strings_android.xml +++ b/android/src/main/res/values-uk/strings_android.xml @@ -7,13 +7,13 @@ More Menu Navigation Drawer Add Note to: - Зберегти - Скасувати - Проєкти + Save + Cancel + Projects Project not found: %1$s Discard Note? - Відхилити - Скасувати + Discard + Cancel Add Note No projects Note Added @@ -30,7 +30,7 @@ Configure Story Info Widget Tap to configure § %1$s · STORY - автор: %1$s + by %1$s WORDS %1$d%% OF %2$s %3$s TODAY diff --git a/android/src/main/res/values-uk/strings_wear_pairing_android.xml b/android/src/main/res/values-uk/strings_wear_pairing_android.xml deleted file mode 100644 index 267ea2f01..000000000 --- a/android/src/main/res/values-uk/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Відхилити - Закрити - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values/strings_wear_pairing_android.xml b/android/src/main/res/values/strings_wear_pairing_android.xml deleted file mode 100644 index fdda9aaf4..000000000 --- a/android/src/main/res/values/strings_wear_pairing_android.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - PAIR WATCH - Sign in %1$s to Hammer? - The watch will sync as %1$s with a session of its own. You can sign it out from the watch at any time. - Sign in to a sync server on this phone first, then pair the watch again. - Pair - Decline - Close - Watch paired - The watch could not be paired - Watch pairing - Pair your watch - Tap to let your watch sync with your Hammer account - diff --git a/android/src/main/res/values/theme.xml b/android/src/main/res/values/theme.xml index fa9ef32bc..1df75deb6 100644 --- a/android/src/main/res/values/theme.xml +++ b/android/src/main/res/values/theme.xml @@ -2,10 +2,4 @@ - - - + \ No newline at end of file diff --git a/android/src/main/res/xml/backup_rules.xml b/android/src/main/res/xml/backup_rules.xml index 8df45f7c2..3541c377c 100644 --- a/android/src/main/res/xml/backup_rules.xml +++ b/android/src/main/res/xml/backup_rules.xml @@ -3,5 +3,4 @@ - diff --git a/android/src/main/res/xml/data_extraction_rules.xml b/android/src/main/res/xml/data_extraction_rules.xml index 26160975f..5835bbc34 100644 --- a/android/src/main/res/xml/data_extraction_rules.xml +++ b/android/src/main/res/xml/data_extraction_rules.xml @@ -4,12 +4,10 @@ - - diff --git a/android/src/nogms/kotlin/com/darkrockstudios/apps/hammer/android/PlayServicesModules.kt b/android/src/nogms/kotlin/com/darkrockstudios/apps/hammer/android/PlayServicesModules.kt deleted file mode 100644 index d6d1d29e1..000000000 --- a/android/src/nogms/kotlin/com/darkrockstudios/apps/hammer/android/PlayServicesModules.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.android - -import org.koin.core.module.Module - -val playServicesModules: List = emptyList() diff --git a/android/src/testGms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandlerTest.kt b/android/src/testGms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandlerTest.kt deleted file mode 100644 index 05a0e7582..000000000 --- a/android/src/testGms/kotlin/com/darkrockstudios/apps/hammer/android/wear/WearPairingHandlerTest.kt +++ /dev/null @@ -1,100 +0,0 @@ -package com.darkrockstudios.apps.hammer.android.wear - -import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test - -class WearPairingHandlerTest { - - private class RecordingResponder : PairingResponder { - val sent = mutableListOf>() - - override suspend fun respond(nodeId: String, response: PairResponse) { - sent += nodeId to response - } - } - - private val phoneSettings = ServerSettings( - url = "hammer.ink", - email = "writer@example.com", - userId = 7, - bearerToken = "phone-auth", - refreshToken = "phone-refresh", - ) - private val watchSettings = phoneSettings.copy(bearerToken = "watch-auth", refreshToken = "watch-refresh") - private val request = PairRequest(requestId = "req-1", installId = "watch-install", deviceLabel = "Pixel Watch") - - private val responder = RecordingResponder() - private val pairedInstalls = mutableListOf() - - private fun handler( - settings: ServerSettings? = phoneSettings, - pairResult: CResult = CResult.success(watchSettings), - ) = WearPairingHandler( - serverSettings = { settings }, - pairInstall = { installId -> - pairedInstalls += installId - pairResult - }, - responder = responder, - ) - - @Test - fun `approving mints a session for the watch's install and sends it back`() = runTest { - val response = handler().approve("watch-node", request) - - assertEquals(PairResponse.Success("req-1", watchSettings), response) - assertEquals(listOf("watch-install"), pairedInstalls) - assertEquals(listOf("watch-node" to response), responder.sent) - } - - @Test - fun `a phone that is not signed in tells the watch so without calling the server`() = runTest { - val response = handler(settings = null).approve("watch-node", request) - - assertEquals(PairResponse.Error("req-1", PairErrorCode.NotSignedIn), response) - assertEquals(emptyList(), pairedInstalls) - assertEquals(listOf("watch-node" to response), responder.sent) - } - - @Test - fun `a server rejection is reported to the watch`() = runTest { - val response = handler(pairResult = CResult.failure(error = "nope")).approve("watch-node", request) - - assertEquals(PairResponse.Error("req-1", PairErrorCode.ServerRejected), response) - assertEquals(listOf("watch-node" to response), responder.sent) - } - - @Test - fun `declining tells the watch without minting anything`() = runTest { - val response = handler().decline("watch-node", request) - - assertEquals(PairResponse.Error("req-1", PairErrorCode.Declined), response) - assertEquals(emptyList(), pairedInstalls) - assertEquals(listOf("watch-node" to response), responder.sent) - } - - @Test - fun `a phone that cannot raise the prompt tells the watch rather than going quiet`() = runTest { - handler().reportUnavailable("watch-node", request) - - assertEquals( - listOf("watch-node" to PairResponse.Error("req-1", PairErrorCode.PhoneUnavailable)), - responder.sent, - ) - assertEquals(emptyList(), pairedInstalls) - } - - @Test - fun `a request from a newer protocol version is refused`() = runTest { - val response = handler().approve("watch-node", request.copy(version = 99)) - - assertEquals(PairResponse.Error("req-1", PairErrorCode.Unsupported), response) - assertEquals(emptyList(), pairedInstalls) - } -} diff --git a/base/build.gradle.kts b/base/build.gradle.kts index d0b8fd23d..2f2dc6fc0 100644 --- a/base/build.gradle.kts +++ b/base/build.gradle.kts @@ -1,5 +1,3 @@ -import com.darkrockstudios.build.distributionChannel -import com.darkrockstudios.build.packageFormat import org.jetbrains.kotlin.gradle.dsl.JvmTarget plugins { @@ -49,6 +47,7 @@ kotlin { api(libs.koin.core) implementation(libs.serialization.core) implementation(libs.coroutines.core) + implementation(libs.kotlinx.datetime) implementation(libs.serialization.json) //implementation("org.kotlincrypto.endians:endians:0.1.0") //api("io.getstream:stream-result:1.1.0") @@ -78,9 +77,6 @@ buildConfig { buildConfigField("String", "APP_VERSION", "\"${libs.versions.app.get()}\"") buildConfigField("String", "DATA_VERSION", "\"${libs.versions.data.version.get()}\"") - - buildConfigField("String", "CHANNEL", "\"${project.distributionChannel().token}\"") - buildConfigField("String", "PACKAGE_FORMAT", "\"${project.packageFormat().token}\"") } val GIT_TASK_NAME = "install-git-hooks" diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannel.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannel.kt deleted file mode 100644 index 9227312cd..000000000 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannel.kt +++ /dev/null @@ -1,45 +0,0 @@ -package com.darkrockstudios.apps.hammer.base - -/** - * The distribution vehicle this build was produced for, baked in at build time from - * `-Pchannel=`. Branch on [current] for the rules that vary per vehicle: self-update - * (forbidden in the app stores, expected for the GitHub and AppImage builds), where "get the app" - * links point, external-payment policy, and sandbox-aware path resolution. - * - * Deliberately a flat enum rather than a set of capability flags. Every branch is a greppable - * `when` on this type, so each channel-conditional behaviour is findable in one search; flags can - * be added later if two channels start sharing a trait and branches begin to duplicate. - * - * Because every branch compiles into every build, a store-forbidden code path is physically - * present in a store binary even when unreachable. If a store ever objects to presence rather - * than behaviour, that is the trigger to promote that one case to a real source set. - * - * Kept in step with the build-side enum in `buildSrc/src/main/java/distributionChannel.kt`. - */ -enum class DistributionChannel(val token: String, val displayName: String) { - DEV("dev", "Development"), - GITHUB("github", "GitHub"), - PLAY("google-play", "Google Play"), - FDROID("fdroid", "F-Droid"), - SNAP("snap", "Snap"), - APPIMAGE("appimage", "AppImage"), - FLATHUB("flathub", "Flathub"), - MICROSOFT_STORE("ms-store", "Microsoft Store"), - MAC_APP_STORE("mac-app-store", "Mac App Store"), - IOS_APP_STORE("ios-app-store", "iOS App Store"), - ; - - companion object { - /** - * An unrecognised token falls back to [DEV] rather than throwing: the build validates the - * token, so reaching here with an unknown one means something is already wrong and taking - * down the app over a log-header string would be worse. - */ - val current: DistributionChannel = - entries.firstOrNull { it.token == BuildMetadata.CHANNEL } ?: DEV - - /** The sandboxed, App Review facing desktop build. */ - val isMacAppStore: Boolean - get() = current == MAC_APP_STORE - } -} diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormat.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormat.kt deleted file mode 100644 index 8a5a6a863..000000000 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormat.kt +++ /dev/null @@ -1,30 +0,0 @@ -package com.darkrockstudios.apps.hammer.base - -/** - * The installer format this build was packaged as, baked in at build time from `-Pformat=`. - * The second axis next to [DistributionChannel]: the channel says which vehicle the build is for - * and whether it may update itself, the format says which installer artifact it came from. Dev - * runs and anything built without a packaging task report [NONE]. - * - * Kept in step with the build-side enum in `buildSrc/src/main/java/packageFormat.kt`. - */ -enum class PackageFormat(val token: String) { - NONE("none"), - MSI("msi"), - EXE("exe"), - DEB("deb"), - RPM("rpm"), - DMG("dmg"), - PKG("pkg"), - APPIMAGE("appimage"), - MSIX("msix"), - SNAP("snap"), - FLATPAK("flatpak"), - ; - - companion object { - /** An unrecognised token falls back to [NONE] for the same reason [DistributionChannel.current] falls back to DEV. */ - val current: PackageFormat = - entries.firstOrNull { it.token == BuildMetadata.PACKAGE_FORMAT } ?: NONE - } -} diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/community.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/community.kt index 206d4c905..dec205d95 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/community.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/community.kt @@ -1,8 +1,7 @@ package com.darkrockstudios.apps.hammer.base const val GITHUB_URL = "https://github.com/Darkrock-Studios/hammer-editor/" -const val RELEASES_LATEST_URL = "${GITHUB_URL}releases/latest" -const val DISCORD_URL = "https://discord.gg/49Kj5mMj6d" +const val DISCORD_URL = "https://discord.gg/GTmgjZcupk" const val REDDIT_URL = "https://www.reddit.com/r/hammereditor/" const val VERSION_CHECK_URL = "https://api.github.com/repos/Darkrock-Studios/hammer-editor/releases/latest" const val HAMMER_INK_URL = "https://hammer.ink/" diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/ApiProjectEntity.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/ApiProjectEntity.kt index 570716456..ead9a14bc 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/ApiProjectEntity.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/ApiProjectEntity.kt @@ -99,7 +99,6 @@ sealed interface ApiProjectEntity { val tags: Set, val image: Image?, val aliases: List = emptyList(), - val excludeFromDictionary: Boolean = false, ) : ApiProjectEntity { @Serializable data class Image( @@ -115,7 +114,6 @@ sealed interface ApiProjectEntity { tags = tags, image = image, aliases = aliases, - excludeFromDictionary = excludeFromDictionary, ) } diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/HttpResponseError.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/HttpResponseError.kt index 3a091f477..3a6b456d5 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/HttpResponseError.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/HttpResponseError.kt @@ -8,30 +8,6 @@ data class HttpResponseError( val error: String, /** A translated message to display to the user */ val displayMessage: String, - /** - * Stable, machine-readable reason from [ApiErrorCode]. Null when the server predates - * error codes, or when the failure has no code worth branching on. - */ - val errorCode: String? = null, ) { override fun toString() = displayMessage -} - -/** - * Reasons a request failed, stable across releases and independent of the translated - * [HttpResponseError.displayMessage]. Plain strings rather than an enum so an unknown - * value from a newer server deserializes instead of throwing. - */ -object ApiErrorCode { - /** Wrong password, or no such account. Deliberately one code: see AccountsRepository.login. */ - const val INVALID_CREDENTIALS = "invalid_credentials" - const val ACCOUNT_EXISTS = "account_exists" - const val ACCOUNT_PENDING_DELETION = "account_pending_deletion" - const val INVALID_EMAIL = "invalid_email" - // Wire error codes, not secrets. - const val PASSWORD_TOO_SHORT = "password_too_short" // nosemgrep: generic.secrets.gitleaks.hashicorp-tf-password.hashicorp-tf-password - const val PASSWORD_TOO_LONG = "password_too_long" // nosemgrep: generic.secrets.gitleaks.hashicorp-tf-password.hashicorp-tf-password - const val PASSWORD_INVALID = "password_invalid" // nosemgrep: generic.secrets.gitleaks.hashicorp-tf-password.hashicorp-tf-password - const val NOT_WHITELISTED = "not_whitelisted" - const val TOKEN_INVALID = "token_invalid" } \ No newline at end of file diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/JsonSerializer.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/JsonSerializer.kt index a3125b868..82c24c1d2 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/JsonSerializer.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/JsonSerializer.kt @@ -2,9 +2,7 @@ package com.darkrockstudios.apps.hammer.base.http import kotlinx.serialization.ExperimentalSerializationApi import kotlinx.serialization.json.Json -import org.koin.core.qualifier.named -/** For human-facing files on disk: indented, and forgiving of hand edits. */ @OptIn(ExperimentalSerializationApi::class) fun createJsonSerializer(): Json { return Json { @@ -15,22 +13,4 @@ fun createJsonSerializer(): Json { allowTrailingComma = true ignoreUnknownKeys = true } -} - -/** - * For machine-facing content on the wire. Matches Ktor's `DefaultJson` plus `ignoreUnknownKeys`, - * which the sync protocol depends on: synced models gain fields without a protocol bump, so a peer - * must drop fields a newer build wrote rather than failing the decode. See `SYNCING-PROTOCOL.md`. - */ -fun createNetworkJsonSerializer(): Json { - return Json { - encodeDefaults = true - isLenient = true - allowSpecialFloatingPointValues = true - allowStructuredMapKeys = true - ignoreUnknownKeys = true - } -} - -/** Resolves [createNetworkJsonSerializer]; an unqualified `Json` is the file serializer. */ -val NetworkJsonQualifier = named("networkJson") +} \ No newline at end of file diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/projectdata/ProjectData.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/projectdata/ProjectData.kt index c792738b4..973955f1e 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/projectdata/ProjectData.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/projectdata/ProjectData.kt @@ -9,12 +9,6 @@ data class ProjectData( val wordCountGoal: WordCountGoal? = null, /** Picked as a unit during conflict resolution — the whole set comes from one side, never a merge. */ val tags: Set = emptySet(), - /** BCP-47 tag of the language the project is written in (e.g. "en", "pt-BR"); null when unset. */ - val language: String? = null, - /** Whether Encyclopedia entry names feed the spell-check session dictionary for this project. */ - val encyclopediaDictionary: Boolean = true, - /** User-added spell-check words. Unlike [tags], a conflict merges both sides by union. */ - val dictionaryWords: Set = emptySet(), ) /** Picked as a unit during conflict resolution — one device's primary paired with another's secondary is undesigned. */ diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasher.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasher.kt index 35fc74981..a5e870701 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasher.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasher.kt @@ -99,7 +99,6 @@ object EntityHasher { tags: Set, image: ApiProjectEntity.EncyclopediaEntryEntity.Image?, aliases: List, - excludeFromDictionary: Boolean = false, ): String { val buf = buff() val d = Algorithm.MurmurHash3_X64_128().createDigest() @@ -122,11 +121,6 @@ object EntityHasher { d.update(image.fileExtension, buf) } - // Zero bytes at the default (false): pre-existing hashes must stay identical. - if (excludeFromDictionary) { - d.update(1, buf) - } - return d.digest().base64Url } diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasher.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasher.kt index ced8f3bc0..82a0c73e8 100644 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasher.kt +++ b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasher.kt @@ -46,34 +46,6 @@ object ProjectDataHasher { data.tags.sorted().forEach { tag -> d.update(tag, buf) } } - // Zero bytes when null, same rule as tags: pre-language hashes must stay identical. - // The -1 marker can never be a tags size and the length prefix bounds the string, - // so a language block cannot be read as a continuation of the tags block - // (tags=["x"] and language="x" must not collide). - if (data.language != null) { - d.update(-1, buf) - d.update(data.language.length, buf) - d.update(data.language, buf) - } - - // Zero bytes at the default (true): pre-existing hashes must stay identical. - // -2 marker: -1 is taken by the language block. - if (!data.encyclopediaDictionary) { - d.update(-2, buf) - } - - // Zero bytes when empty, same rule as tags. -3 marker: -1 and -2 are taken. Each word - // carries its length: update(String) writes bare char codes, so without it - // {"a","bc"} and {"ab","c"} would collide. - if (data.dictionaryWords.isNotEmpty()) { - d.update(-3, buf) - d.update(data.dictionaryWords.size, buf) - data.dictionaryWords.sorted().forEach { word -> - d.update(word.length, buf) - d.update(word, buf) - } - } - return d.digest().base64Url } } diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/ProseHtml.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/ProseHtml.kt deleted file mode 100644 index 616597ae8..000000000 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/ProseHtml.kt +++ /dev/null @@ -1,148 +0,0 @@ -package com.darkrockstudios.apps.hammer.base.markdown - -import org.intellij.markdown.IElementType -import org.intellij.markdown.MarkdownElementTypes -import org.intellij.markdown.MarkdownTokenTypes -import org.intellij.markdown.ast.ASTNode -import org.intellij.markdown.ast.LeafASTNode -import org.intellij.markdown.ast.accept -import org.intellij.markdown.flavours.MarkdownFlavourDescriptor -import org.intellij.markdown.html.GeneratingProvider -import org.intellij.markdown.html.HtmlGenerator -import org.intellij.markdown.html.SimpleTagProvider -import org.intellij.markdown.html.TrimmingInlineHolderProvider -import org.intellij.markdown.parser.LinkMap - -/** - * How a story's markdown becomes HTML, shared by every surface that renders prose for a reader: the - * web pages the server serves and the EPUB the client exports. - * - * CommonMark reflows prose. A run of single-newline lines collapses into one block and any run of - * blank lines collapses to one paragraph break, so a page of dialogue arrives as a wall of text that - * looks nothing like what the writer sees in the editor. These providers lay the text out as it was - * typed instead: every newline starts a new line, and every blank line is a blank line. - * - * Only prose is touched. Lists, tables, code and headings keep markdown's own layout, and blank - * lines next to them add nothing — those blocks carry their own spacing already. - */ -object ProseHtml { - - /** Upper bound on the breaks one run of blank lines can produce. */ - const val MAX_CONSECUTIVE_BREAKS = 6 - - /** - * The generating providers [flavour] would use, with prose layout applied. Pass the result to - * [HtmlGenerator]. With [keepBlankLines] off, a lone blank line between paragraphs produces - * nothing and a run of two or more produces a single break. - */ - fun providers( - flavour: MarkdownFlavourDescriptor, - linkMap: LinkMap, - keepBlankLines: Boolean = true, - ): Map = - flavour.createHtmlGeneratingProviders(linkMap, null) + mapOf( - MarkdownElementTypes.PARAGRAPH to ProseParagraphProvider, - MarkdownElementTypes.MARKDOWN_FILE to ProseContainerProvider("body", keepBlankLines), - MarkdownElementTypes.BLOCK_QUOTE to ProseContainerProvider("blockquote", keepBlankLines), - ) - - /** - * The parser only ends a line on `\n`. Content written on Windows, or imported from a file that - * was, arrives with `\r\n` and would otherwise parse as one run-on paragraph. - */ - fun normalizeLineEndings(markdown: String): String = markdown.replace(CARRIAGE_RETURN, "\n") - - private val CARRIAGE_RETURN = Regex("\r\n?") -} - -/** - * A paragraph of prose keeps the lines the author typed: each becomes its own paragraph. - * - * This relies on the reader's stylesheet giving paragraph siblings no vertical margin, so - * consecutive lines sit directly under one another and each picks up the first-line indent, exactly - * as the editor draws them. - */ -private object ProseParagraphProvider : TrimmingInlineHolderProvider() { - override fun openTag(visitor: HtmlGenerator.HtmlGeneratingVisitor, text: String, node: ASTNode) { - visitor.consumeTagOpen(node, "p") - } - - override fun closeTag(visitor: HtmlGenerator.HtmlGeneratingVisitor, text: String, node: ASTNode) { - visitor.consumeTagClose("p") - } - - override fun processNode( - visitor: HtmlGenerator.HtmlGeneratingVisitor, - text: String, - node: ASTNode, - ) { - val children = childrenToRender(node) - openTag(visitor, text, node) - - children.forEachIndexed { index, child -> - when { - // An edge newline would only open or close an empty paragraph. - child.type == MarkdownTokenTypes.EOL -> { - if (index != 0 && index != children.lastIndex) { - closeTag(visitor, text, node) - openTag(visitor, text, node) - } - } - - // The trailing spaces of a hard break are redundant: the newline itself breaks here. - child.type == MarkdownTokenTypes.HARD_LINE_BREAK -> Unit - - child is LeafASTNode -> visitor.visitLeaf(child) - else -> child.accept(visitor) - } - } - - closeTag(visitor, text, node) - } -} - -/** Emits a break for each blank line the author left between two paragraphs. */ -private class ProseContainerProvider( - tag: String, - private val keepBlankLines: Boolean, -) : SimpleTagProvider(tag) { - override fun processNode( - visitor: HtmlGenerator.HtmlGeneratingVisitor, - text: String, - node: ASTNode, - ) { - openTag(visitor, text, node) - - var newlines = 0 - var afterParagraph = false - for (child in node.children) { - when (child.type) { - MarkdownTokenTypes.EOL -> newlines++ - // A quote's own '>' markers sit between the lines they mark, and neither they nor - // stray indentation say anything about how far apart two passages are. - MarkdownTokenTypes.WHITE_SPACE, MarkdownTokenTypes.BLOCK_QUOTE -> Unit - else -> { - val isParagraph = child.type == MarkdownElementTypes.PARAGRAPH - if (afterParagraph && isParagraph) { - val blanks = (newlines - 1).coerceIn(0, ProseHtml.MAX_CONSECUTIVE_BREAKS) - val breaks = when { - keepBlankLines -> blanks - blanks >= 2 -> 1 - else -> 0 - } - repeat(breaks) { visitor.consumeHtml(BREAK) } - } - child.accept(visitor) - afterParagraph = isParagraph - newlines = 0 - } - } - } - - closeTag(visitor, text, node) - } - - private companion object { - const val BREAK = "
" - } -} diff --git a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCount.kt b/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCount.kt deleted file mode 100644 index d889351dd..000000000 --- a/base/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCount.kt +++ /dev/null @@ -1,20 +0,0 @@ -package com.darkrockstudios.apps.hammer.base.markdown - -/** - * Counts runs of non-whitespace that contain at least one letter or digit, so standalone - * Markdown markers (`---`, `#`, `-`, `>`) are not words. Single pass: a whole manuscript is - * one string, not a word list. - */ -fun countWords(text: String): Int { - var count = 0 - var counted = false - for (char in text) { - if (char.isWhitespace()) { - counted = false - } else if (!counted && char.isLetterOrDigit()) { - counted = true - count++ - } - } - return count -} diff --git a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannelTest.kt b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannelTest.kt deleted file mode 100644 index f05e3b10c..000000000 --- a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/DistributionChannelTest.kt +++ /dev/null @@ -1,35 +0,0 @@ -package com.darkrockstudios.apps.hammer.base - -import kotlin.test.Test -import kotlin.test.assertEquals - -class DistributionChannelTest { - - /** - * Pins the tokens against the build-side enum in - * `buildSrc/src/main/java/distributionChannel.kt`. A channel added or renamed on one side and - * not the other would otherwise ship a build whose reported channel silently falls back to - * [DistributionChannel.DEV]. - */ - @Test - fun `tokens match the build side enum`() { - val expected = listOf( - "dev", - "github", - "google-play", - "fdroid", - "snap", - "appimage", - "flathub", - "ms-store", - "mac-app-store", - "ios-app-store", - ) - assertEquals(expected, DistributionChannel.entries.map { it.token }) - } - - @Test - fun `current resolves the baked in token`() { - assertEquals(BuildMetadata.CHANNEL, DistributionChannel.current.token) - } -} diff --git a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormatTest.kt b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormatTest.kt deleted file mode 100644 index 8233e2d28..000000000 --- a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/PackageFormatTest.kt +++ /dev/null @@ -1,34 +0,0 @@ -package com.darkrockstudios.apps.hammer.base - -import kotlin.test.Test -import kotlin.test.assertEquals - -class PackageFormatTest { - - /** - * Pins the tokens against the build-side enum in `buildSrc/src/main/java/packageFormat.kt`, - * the same way [DistributionChannelTest] pins the channel tokens. - */ - @Test - fun `tokens match the build side enum`() { - val expected = listOf( - "none", - "msi", - "exe", - "deb", - "rpm", - "dmg", - "pkg", - "appimage", - "msix", - "snap", - "flatpak", - ) - assertEquals(expected, PackageFormat.entries.map { it.token }) - } - - @Test - fun `current resolves the baked in token`() { - assertEquals(BuildMetadata.PACKAGE_FORMAT, PackageFormat.current.token) - } -} diff --git a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasherTest.kt b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasherTest.kt index 7bd35d76f..affeecfcd 100644 --- a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasherTest.kt +++ b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/EntityHasherTest.kt @@ -136,23 +136,6 @@ class EntityHasherTest { assertNotEquals(base, different, "hashEncyclopediaEntry must include aliases in the digest") } - @Test - fun `hashEncyclopediaEntry differs when excludeFromDictionary differs`() { - val included = EntityHasher.hashEncyclopediaEntry( - id = 2, name = "Robert", entryType = "person", - text = "text", tags = emptySet(), image = null, - aliases = emptyList(), - excludeFromDictionary = false, - ) - val excluded = EntityHasher.hashEncyclopediaEntry( - id = 2, name = "Robert", entryType = "person", - text = "text", tags = emptySet(), image = null, - aliases = emptyList(), - excludeFromDictionary = true, - ) - assertNotEquals(included, excluded, "hashEncyclopediaEntry must include excludeFromDictionary in the digest") - } - @Test fun `hashEncyclopediaEntry alias order is significant`() { // aliases is a List, not a Set - reordering is a meaningful change that should diff --git a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasherTest.kt b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasherTest.kt index 1320d791d..3b23e831c 100644 --- a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasherTest.kt +++ b/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/http/synchronizer/ProjectDataHasherTest.kt @@ -56,82 +56,6 @@ class ProjectDataHasherTest { ) } - @Test - fun `language affects hash`() { - val unset = ProjectData(authorName = "Pat") - val set = unset.copy(language = "en-US") - assertNotEquals(ProjectDataHasher.hash(unset), ProjectDataHasher.hash(set)) - } - - @Test - fun `language region affects hash`() { - val en = ProjectData(language = "en") - val enUs = ProjectData(language = "en-US") - assertNotEquals(ProjectDataHasher.hash(en), ProjectDataHasher.hash(enUs)) - } - - @Test - fun `language block does not collide with a one-element tags block`() { - val tagged = ProjectData(tags = setOf("en")) - val languaged = ProjectData(language = "en") - assertNotEquals( - ProjectDataHasher.hash(tagged), - ProjectDataHasher.hash(languaged), - "tags=[x] and language=x must hash differently", - ) - } - - @Test - fun `encyclopedia dictionary affects hash`() { - val on = ProjectData(authorName = "Pat") - val off = on.copy(encyclopediaDictionary = false) - assertNotEquals(ProjectDataHasher.hash(on), ProjectDataHasher.hash(off)) - } - - @Test - fun `dictionary words affect hash`() { - val without = ProjectData(authorName = "Pat") - val with = without.copy(dictionaryWords = setOf("kvothe")) - assertNotEquals(ProjectDataHasher.hash(without), ProjectDataHasher.hash(with)) - } - - @Test - fun `dictionary word insertion order does not affect hash`() { - val ab = ProjectData(dictionaryWords = setOf("alpha", "beta")) - val ba = ProjectData(dictionaryWords = setOf("beta", "alpha")) - assertEquals(ProjectDataHasher.hash(ab), ProjectDataHasher.hash(ba)) - } - - @Test - fun `dictionary word boundaries affect hash`() { - val joined = ProjectData(dictionaryWords = setOf("ab")) - val split = ProjectData(dictionaryWords = setOf("a", "b")) - assertNotEquals(ProjectDataHasher.hash(joined), ProjectDataHasher.hash(split)) - - // Same size and same concatenation: only a per-word length keeps these apart. - val left = ProjectData(dictionaryWords = setOf("a", "bc")) - val right = ProjectData(dictionaryWords = setOf("ab", "c")) - assertNotEquals(ProjectDataHasher.hash(left), ProjectDataHasher.hash(right)) - } - - @Test - fun `dictionary block does not collide with tags or language`() { - val words = ProjectData(dictionaryWords = setOf("en")) - assertNotEquals(ProjectDataHasher.hash(ProjectData(tags = setOf("en"))), ProjectDataHasher.hash(words)) - assertNotEquals(ProjectDataHasher.hash(ProjectData(language = "en")), ProjectDataHasher.hash(words)) - } - - @Test - fun `null vs empty language distinguishable`() { - val nullLanguage = ProjectData(language = null) - val emptyLanguage = ProjectData(language = "") - assertNotEquals( - ProjectDataHasher.hash(nullLanguage), - ProjectDataHasher.hash(emptyLanguage), - "null and empty-string language must hash differently", - ) - } - @Test fun `same input produces same hash`() { val data = ProjectData( diff --git a/build.gradle.kts b/build.gradle.kts index 9887bd8c5..8b070e242 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,20 +1,16 @@ import com.darkrockstudios.build.APPLE_STORE_LIMIT import com.darkrockstudios.build.PLAY_STORE_LIMIT -import com.darkrockstudios.build.Platform import com.darkrockstudios.build.configureRelease import com.darkrockstudios.build.extractLatestChangelog import com.darkrockstudios.build.formatStoreNotes import com.darkrockstudios.build.isPlatformReleaseTag import com.darkrockstudios.build.registerLinuxDistributionTasks import com.darkrockstudios.build.registerPublishTasks -import com.darkrockstudios.build.registerUpdateMetadataTasks import com.darkrockstudios.build.releaseNotesUrl import com.darkrockstudios.build.storeNotesLength import com.darkrockstudios.build.updateFlatpakFiles import com.darkrockstudios.build.updateIosShortVersion import com.darkrockstudios.build.updateSnapcraftYaml -import com.darkrockstudios.build.wearVersionCode -import com.darkrockstudios.build.writeBakedChangelog import com.darkrockstudios.build.writeChangelogMarkdown import com.darkrockstudios.build.writeSemvar import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask @@ -46,9 +42,6 @@ allprojects { tasks.withType { useJUnitPlatform() - // The Koin compiler plugin's compile-safety hints are not tests, and as of plugin - // 1.1.0 they carry duplicate method signatures that JUnit's scan chokes on. - exclude("org/koin/plugin/hints/**") } // Compiler flags applied globally @@ -129,19 +122,11 @@ kover { registerPublishTasks() registerLinuxDistributionTasks(libs.versions.app.get()) -registerUpdateMetadataTasks(libs.versions.app.get()) - -// The pre-commit hook runs Gradle, so git's hook env leaks into the daemon and Gradle -// blanks rather than unsets it later; a blank GIT_INDEX_FILE reads as an empty index. -fun ProcessBuilder.scrubGitEnv(): ProcessBuilder = apply { - environment().keys.removeAll { it.startsWith("GIT_") } -} val releasePreFlightChecks = tasks.register("releasePreFlightChecks") { doLast { fun runGit(vararg args: String): String { val process = ProcessBuilder(*args) - .scrubGitEnv() .directory(project.rootDir) .start() val stdout = process.inputStream.bufferedReader().readText().trim() @@ -150,7 +135,7 @@ val releasePreFlightChecks = tasks.register("releasePreFlightChecks") { } println("Fetching origin...") - ProcessBuilder("git", "fetch", "origin").scrubGitEnv().directory(project.rootDir).inheritIO().start().waitFor() + ProcessBuilder("git", "fetch", "origin").directory(project.rootDir).inheritIO().start().waitFor() // Check for unstaged/uncommitted changes val statusText = runGit("git", "status", "--porcelain") @@ -186,43 +171,34 @@ tasks.register("prepareForRelease") { val versionsFile = project.rootDir.resolve(versionsPath) writeSemvar(libs.versions.app.get(), releaseInfo.semVar, versionsFile) - // Store listings carry the app-only notes, written per sink in the release - // dialog. Google Play also gets a link to the GitHub release, which holds the - // full text including the web and server changes; the Apple stores must not - // (see releaseNotesUrl) and get the notes alone. A sink with no notes is one - // this release does not reach: leave its metadata alone rather than blanking - // the notes the last client release published. + // Store listings carry the app-only notes plus a link to the GitHub release, + // which holds the full text including the web and server changes. A release + // that reaches no store has no store notes; leave the existing metadata alone + // rather than blanking the notes the last client release published. val fullNotesUrl = releaseNotesUrl(releaseInfo.tag) - val storeNotes = releaseInfo.storeNotes - val playNotes = storeNotes.notesFor(Platform.GOOGLE_PLAY) - val appleNotes = storeNotes.notesFor(Platform.IOS_APP_STORE) - val writePlayNotes = playNotes.isNotBlank() - val writeAppleNotes = appleNotes.isNotBlank() - val writeSharedNotes = storeNotes.shared.isNotBlank() - val playNotesLength = storeNotesLength(playNotes, fullNotesUrl) - val playChangelog = formatStoreNotes(playNotes, PLAY_STORE_LIMIT, fullNotesUrl) + val storeNotes = releaseInfo.storeChangeLog + val writeStoreNotes = storeNotes.isNotBlank() + val notesLength = storeNotesLength(storeNotes, fullNotesUrl) + val playChangelog = formatStoreNotes(storeNotes, PLAY_STORE_LIMIT, fullNotesUrl) // Write the Fastlane changelog file val rootDir: File = project.rootDir val changelogsPath = "fastlane/metadata/android/en-US/changelogs".replace("/", File.separator) val changeLogsDir = rootDir.resolve(changelogsPath) - // The watch app ships in the same listing under its own version code. - val changeLogFiles = listOf(versionCode, wearVersionCode(versionCode)).map { File(changeLogsDir, "$it.txt") } - if (writePlayNotes) { - changeLogFiles.forEach { file -> - file.writeText(playChangelog) - println("Changelog for version ${releaseInfo.semVar} written to $changelogsPath/${file.name}") - } - if (playNotesLength > PLAY_STORE_LIMIT) { + val changeLogFile = File(changeLogsDir, "$versionCode.txt") + if (writeStoreNotes) { + changeLogFile.writeText(playChangelog) + println("Changelog for version ${releaseInfo.semVar} written to $changelogsPath/$versionCode.txt") + if (notesLength > PLAY_STORE_LIMIT) { println(" Google Play notes truncated to $PLAY_STORE_LIMIT characters; full text at $fullNotesUrl") } } else { - println("No Google Play notes for this release; store metadata left untouched") + println("No store notes for this release; store metadata left untouched") } - val appleChangelog = formatStoreNotes(appleNotes, APPLE_STORE_LIMIT, null) - if (writeAppleNotes && storeNotesLength(appleNotes, null) > APPLE_STORE_LIMIT) { + val appleChangelog = formatStoreNotes(storeNotes, APPLE_STORE_LIMIT, fullNotesUrl) + if (writeStoreNotes && notesLength > APPLE_STORE_LIMIT) { println("App Store notes truncated to $APPLE_STORE_LIMIT characters; full text at $fullNotesUrl") } @@ -231,11 +207,7 @@ tasks.register("prepareForRelease") { val macReleaseNotesDir = rootDir.resolve(macReleaseNotesPath) macReleaseNotesDir.mkdirs() val macReleaseNotesFile = File(macReleaseNotesDir, "release_notes.txt") - // Both Apple listings share one set of notes but each has its own file, so a - // release to one leaves the other's file holding what it last published. - val writeMacNotes = writeAppleNotes && Platform.MAC_APP_STORE in releaseInfo.platforms - val writeIosNotes = writeAppleNotes && Platform.IOS_APP_STORE in releaseInfo.platforms - if (writeMacNotes) { + if (writeStoreNotes) { macReleaseNotesFile.writeText(appleChangelog) println("macOS release notes written to $macReleaseNotesPath/release_notes.txt") } @@ -245,21 +217,14 @@ tasks.register("prepareForRelease") { val iosReleaseNotesDir = rootDir.resolve(iosReleaseNotesPath) iosReleaseNotesDir.mkdirs() val iosReleaseNotesFile = File(iosReleaseNotesDir, "release_notes.txt") - if (writeIosNotes) { + if (writeStoreNotes) { iosReleaseNotesFile.writeText(appleChangelog) println("iOS release notes written to $iosReleaseNotesPath/release_notes.txt") } // Write the Global changelog file val globalChangelogFile = File("${project.rootDir}/CHANGELOG.md") - val changelogEntry = writeChangelogMarkdown(releaseInfo, globalChangelogFile) - - // Bake the same entry into the app. Written for every release, including server-only - // ones, so the resource never drifts from the version in libs.versions.toml. - val bakedChangelogPath = - "common/src/commonMain/composeResources/files/changelog.md".replace("/", File.separator) - val bakedChangelogFile = project.rootDir.resolve(bakedChangelogPath) - writeBakedChangelog(changelogEntry, bakedChangelogFile) + writeChangelogMarkdown(releaseInfo, globalChangelogFile) // Update snapcraft.yaml with new version and JVM version val snapcraftPath = "snap/snapcraft.yaml".replace("/", File.separator) @@ -272,17 +237,10 @@ tasks.register("prepareForRelease") { val flatpakManifestFile = project.rootDir.resolve(flatpakManifestPath) val flatpakMetainfoPath = "flatpak/studio.darkrock.hammer.metainfo.xml".replace("/", File.separator) val flatpakMetainfoFile = project.rootDir.resolve(flatpakMetainfoPath) - // Flathub is a store listing with no tab of its own, so it gets the shared - // app-only notes. They are blank unless the release reaches Flathub (see - // reachesFlathub), and then it gets no release entry either. - if (writeSharedNotes) { - updateFlatpakFiles( - releaseInfo.semVar, - jvmVersion, - flatpakManifestFile, - flatpakMetainfoFile, - storeNotes.shared, - ) + // Flathub is a store listing, so it gets the app-only notes. A release with + // none of them is not going to Flathub, so it gets no release entry either. + if (writeStoreNotes) { + updateFlatpakFiles(releaseInfo.semVar, jvmVersion, flatpakManifestFile, flatpakMetainfoFile, storeNotes) } // Keep the iOS marketing version in sync with the semver. macOS pulls this @@ -295,7 +253,6 @@ tasks.register("prepareForRelease") { val cmd = listOf("git") + args.toList() println("> ${cmd.joinToString(" ")}") val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(project.rootDir) .redirectErrorStream(true) .start() @@ -307,22 +264,15 @@ tasks.register("prepareForRelease") { } // Commit the changes to the repo - if (writePlayNotes) { - changeLogFiles.forEach { git("add", it.absolutePath) } - } - if (writeMacNotes) { + if (writeStoreNotes) { + git("add", changeLogFile.absolutePath) git("add", macReleaseNotesFile.absolutePath) - } - if (writeIosNotes) { git("add", iosReleaseNotesFile.absolutePath) - } - if (writeSharedNotes) { git("add", flatpakManifestFile.absolutePath) git("add", flatpakMetainfoFile.absolutePath) } git("add", versionsFile.absolutePath) git("add", globalChangelogFile.absolutePath) - git("add", bakedChangelogFile.absolutePath) git("add", snapcraftFile.absolutePath) git("add", iosInfoPlistFile.absolutePath) git("commit", "-m", "Prepared for release: v${releaseInfo.semVar}") @@ -334,7 +284,6 @@ tasks.register("prepareForRelease") { val cmd = listOf("git") + args.toList() println("> (${dir.name}) ${cmd.joinToString(" ")}") val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(dir) .redirectErrorStream(true) .start() @@ -363,7 +312,7 @@ tasks.register("prepareForRelease") { // Tag the merge commit explicitly; the main tree stays on develop. val tagMessageFile = File(project.rootDir, "build/release-tag-message.txt") tagMessageFile.parentFile.mkdirs() - tagMessageFile.writeText(releaseInfo.tagMessage) + tagMessageFile.writeText(releaseInfo.changeLog) git("tag", "-a", releaseInfo.tag, "-F", tagMessageFile.absolutePath, "release") // Push the branches and only this release's tag. Pushing --tags would try @@ -384,7 +333,6 @@ tasks.register("backoutLastRelease") { val cmd = listOf("git") + args.toList() println("> ${cmd.joinToString(" ")}") val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(project.rootDir) .redirectErrorStream(true) .start() @@ -402,7 +350,6 @@ tasks.register("backoutLastRelease") { // the prefix (`vX.Y.Z+rc1`, `vX.Y.Z+sbom`) aren't included. fun findReleaseTags(): List { val proc = ProcessBuilder("git", "tag", "-l", tagName, "$tagName+*") - .scrubGitEnv() .directory(project.rootDir) .start() val tags = proc.inputStream.bufferedReader().readLines().filter { it.isNotBlank() } @@ -415,7 +362,6 @@ tasks.register("backoutLastRelease") { // Check if HEAD commit is the release commit val headProcess = ProcessBuilder("git", "log", "-1", "--format=%s") - .scrubGitEnv() .directory(project.rootDir).start() val headMessage = headProcess.inputStream.bufferedReader().readText().trim() headProcess.waitFor() @@ -463,7 +409,6 @@ tasks.register("revertLastRelease") { val cmd = listOf("git") + args.toList() println("> ${cmd.joinToString(" ")}") val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(project.rootDir) .redirectErrorStream(true) .start() @@ -476,7 +421,6 @@ tasks.register("revertLastRelease") { val cmd = listOf("git") + args.toList() println("> ${cmd.joinToString(" ")}") val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(project.rootDir) .redirectErrorStream(true) .start() @@ -489,7 +433,6 @@ tasks.register("revertLastRelease") { fun gitOutput(vararg args: String): String { val cmd = listOf("git") + args.toList() val process = ProcessBuilder(cmd) - .scrubGitEnv() .directory(project.rootDir) .redirectErrorStream(true) .start() diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index 9f8dca2a3..d2b1b89ce 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -8,6 +8,8 @@ repositories { dependencies { implementation(kotlin("stdlib")) + //implementation(libs.markdown) + implementation(libs.kotlinx.datetime) // for the prepareForRelease dialog. implementation(libs.flatlaf) testImplementation(kotlin("test")) diff --git a/buildSrc/src/main/java/changelog.kt b/buildSrc/src/main/java/changelog.kt index d42f7dc19..23ecfddba 100644 --- a/buildSrc/src/main/java/changelog.kt +++ b/buildSrc/src/main/java/changelog.kt @@ -57,43 +57,28 @@ fun extractLatestChangelog(changelogFile: File): String? { return body.trim().ifEmpty { null } } -/** Prepends this release's entry to CHANGELOG.md and returns the entry text. */ -fun writeChangelogMarkdown(releaseInfo: ReleaseInfo, changelogFile: File): String { +fun writeChangelogMarkdown(releaseInfo: ReleaseInfo, changelogFile: File) { val currentChangelog = changelogFile.readText() val withoutHeader = currentChangelog.substring(currentChangelog.indexOf('\n') + 1) val headerDate = LocalDate.now().format(DateTimeFormatter.ofPattern("yyyy-M-d")) - val entry = "## [${releaseInfo.semVar}] - $headerDate\n\n" + releaseInfo.changeLog + "\n" + val newEntry = "## [${releaseInfo.semVar}] - $headerDate\n\n" + releaseInfo.changeLog + "\n\n" - val newChangeLog = "# Changelog\n\n" + entry + "\n" + withoutHeader + val newChangeLog = "# Changelog\n\n" + newEntry + withoutHeader changelogFile.writeText(newChangeLog) println("CHANGELOG.md written") - - return entry } -/** The same entry, baked into the app so the client can show it without calling GitHub. */ -fun writeBakedChangelog(entry: String, bakedFile: File) { - bakedFile.parentFile.mkdirs() - bakedFile.writeText(entry) - println("Baked changelog written to ${bakedFile.path}") -} - -/** Tag-message trailer that tells CI to publish the release instead of leaving it a draft. */ -const val AUTO_PUBLISH_TRAILER = "Auto-Publish: true" - /** * @param changeLog The full release notes: CHANGELOG.md and the GitHub release. - * @param storeNotes The app-only text each store listing carries. - * @param autoPublish Publish the GitHub release once every CI build job passes. + * @param storeChangeLog The app-only subset every store listing carries. */ data class ReleaseInfo( val semVar: SemVar, val changeLog: String, - val storeNotes: StoreChangelogs, + val storeChangeLog: String, val platforms: Set, - val autoPublish: Boolean = false, ) { init { // Fail fast at construction so we never get halfway through prepareForRelease @@ -104,11 +89,6 @@ data class ReleaseInfo( /** The git tag for this release: `vX.Y.Z` for full, `vX.Y.Z+token+token` for partial. */ val tag: String get() = "v$semVar${tagSuffix(platforms)}" - - // The trailer is the only channel that reaches CI per-release: the tag name already - // encodes platform scope, and a `+` suffix there would read as a partial release. - /** The annotated-tag message: the notes, plus the auto-publish trailer when asked for. */ - val tagMessage: String get() = if (autoPublish) "$changeLog\n\n$AUTO_PUBLISH_TRAILER" else changeLog } /** @@ -132,10 +112,6 @@ private fun droppedSummary(dropped: List): String { return if (rest > 0) "$shown · +$rest more" else shown } -/** A store editor's character count against its limit, and by how much it is over. */ -private fun counterText(length: Int, limit: Int): String = - if (length > limit) "$length/$limit · over by ${length - limit}" else "$length/$limit" - /** Small muted caption above a changelog editor. */ private fun tabHint(text: String): JLabel = JLabel(wrapped(text)).apply { font = font.deriveFont(Font.ITALIC, font.size - 1f) @@ -143,64 +119,6 @@ private fun tabHint(text: String): JLabel = JLabel(wrapped(text)).apply { border = BorderFactory.createEmptyBorder(0, 2, 2, 2) } -/** Tab positions in the changelog tab strip. */ -private const val TAB_FULL = 0 -private const val TAB_STORE = 1 -private const val TAB_PLAY = 2 -private const val TAB_APPLE = 3 - -/** - * A changelog editor that mirrors [derive] until it is hand-edited, after which it - * keeps its own text until [resync] is called. Chaining these gives the dialog its - * default: the full notes are the only thing anyone has to write, and a store tab - * is touched only when that store needs something different. - */ -private class MirroredEditor(private val derive: () -> String) { - val editor = JTextArea().apply { - lineWrap = true - wrapStyleWord = true - rows = 12 - } - - var edited = false - private set - - private var syncing = false - - val text: String get() = editor.text - - fun onChange(listener: () -> Unit) { - editor.document.addDocumentListener(OnChangeListener { - if (!syncing) edited = true - listener() - }) - } - - /** Pulls the source text in, unless this editor has been hand-edited. */ - fun sync() { - if (!edited) write(derive()) - } - - /** Discards hand edits and follows the source again. */ - fun resync() { - edited = false - sync() - } - - /** Replaces the text with a hand edit the dialog made, such as trim-to-fit. */ - fun overwrite(value: String) { - write(value) - edited = true - } - - private fun write(value: String) { - syncing = true - editor.text = value - editor.caretPosition = 0 - syncing = false - } -} - class OnChangeListener( val onChange: (e: DocumentEvent?) -> Unit ) : DocumentListener { @@ -223,8 +141,7 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n SwingUtilities.invokeAndWait { val frame = JFrame() frame.defaultCloseOperation = JFrame.DISPOSE_ON_CLOSE - // The fixed sections take the height they need; this leaves the changelog editor ~250px. - frame.setSize(620, 1080) + frame.setSize(620, 900) fun refreshTitle() { frame.title = "Prepare Release — $curSemVar → $newSemVar" @@ -246,8 +163,7 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n // --- Tag preview label + commit button declared early so refresh can close over them --- val warningColor: Color = UIManager.getColor("Label.disabledForeground") ?: Color.GRAY val normalColor: Color = UIManager.getColor("Label.foreground") ?: Color.LIGHT_GRAY - val editedColor = Color(0xE0, 0x9B, 0x2B) - val errorColor = Color(0xD0, 0x4A, 0x4A) + val truncateColor = Color(0xE0, 0x9B, 0x2B) val tagFontBig = Font(Font.MONOSPACED, Font.BOLD, 18) val tagFontWarn = Font(Font.MONOSPACED, Font.ITALIC, 14) @@ -260,21 +176,18 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n font = font.deriveFont(Font.BOLD, 14f) } - // Editors, previews and tabs are declared up here so the refresh below can - // close over them; the Changelog section further down only places them. + // Editors and store preview are declared up here so the refresh below can close + // over them; they are laid out in the Changelog section further down. val changeLog = JTextArea().apply { lineWrap = true wrapStyleWord = true rows = 12 } - - // Each store editor mirrors its source until hand-edited: the shared notes - // follow a filtered copy of the full changelog, and each store follows the - // shared notes. Stores diverge only when someone makes them. - val storeNotes = MirroredEditor { deriveStoreNotes(changeLog.text).notes } - val playNotes = MirroredEditor { storeNotes.text } - val appleNotes = MirroredEditor { storeNotes.text } - + val storeNotes = JTextArea().apply { + lineWrap = true + wrapStyleWord = true + rows = 12 + } val playPreview = JTextArea().apply { isEditable = false lineWrap = true @@ -282,100 +195,15 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n rows = 6 font = Font(Font.MONOSPACED, Font.PLAIN, 12) } - fun counterLabel() = JLabel().apply { + val characterCount = JLabel().apply { font = font.deriveFont(font.size - 1f) foreground = warningColor } - val playCount = counterLabel() - val appleCount = counterLabel() - - // What the filter took out, and whether a store still follows its source, so - // nothing leaves a listing unnoticed. + // What the filter took out, so nothing leaves the store listing unnoticed. val storeStatus = tabHint("") - val playStatus = tabHint("") - val appleStatus = tabHint("") - - fun smallButton(label: String) = JButton(label).apply { + val resyncButton = JButton("Re-sync from full notes").apply { font = font.deriveFont(font.size - 1f) } - val storeResync = smallButton("Re-sync from full notes") - val playResync = smallButton("Re-sync from store notes") - val appleResync = smallButton("Re-sync from store notes") - val trimButton = smallButton("Trim to fit") - - fun tabHeader(hint: String, status: JLabel, buttons: List): JPanel = JPanel().apply { - layout = BoxLayout(this, BoxLayout.Y_AXIS) - add(tabHint(hint).apply { alignmentX = Component.LEFT_ALIGNMENT }) - add(status.apply { alignmentX = Component.LEFT_ALIGNMENT }) - add( - JPanel(FlowLayout(FlowLayout.LEFT, 6, 2)).apply { - alignmentX = Component.LEFT_ALIGNMENT - buttons.forEach { add(it) } - }, - ) - } - - fun editorTab(header: JComponent, center: JComponent, counter: JLabel?): JPanel = - JPanel(BorderLayout(0, 4)).apply { - border = BorderFactory.createEmptyBorder(8, 0, 0, 0) - add(header, BorderLayout.NORTH) - add(center, BorderLayout.CENTER) - if (counter != null) { - add( - JPanel(FlowLayout(FlowLayout.RIGHT, 0, 4)).apply { add(counter) }, - BorderLayout.SOUTH, - ) - } - } - - val fullTab = editorTab( - tabHint("Goes to CHANGELOG.md and the GitHub release. Write everything here."), - JScrollPane(changeLog), - null, - ) - val storeTab = editorTab( - tabHeader( - "The app-only base every listing starts from. Entries tagged for the web or server are filtered out, because stores reject notes about anything but the app. Google Play and Apple follow this text on their own tabs; Flathub publishes it as it stands, on releases to every store.", - storeStatus, - listOf(storeResync), - ), - JScrollPane(storeNotes.editor), - null, - ) - val playTab = editorTab( - tabHeader( - "Goes to Google Play and F-Droid, which read the same file. 500 characters, including the link to the full notes on GitHub.", - playStatus, - listOf(playResync, trimButton), - ), - JSplitPane( - JSplitPane.VERTICAL_SPLIT, - JScrollPane(playNotes.editor), - JScrollPane(playPreview).apply { - border = BorderFactory.createTitledBorder("Google Play preview") - }, - ).apply { - resizeWeight = 0.6 - border = null - }, - playCount, - ) - val appleTab = editorTab( - tabHeader( - "Goes to the iOS and Mac App Stores. 4000 characters, and no link: App Store review rejects notes pointing at the GitHub releases page.", - appleStatus, - listOf(appleResync), - ), - JScrollPane(appleNotes.editor), - appleCount, - ) - - val changelogTabs = JTabbedPane().apply { - addTab("Full", fullTab) - addTab("App stores", storeTab) - addTab("Google Play", playTab) - addTab("Apple", appleTab) - } /** The platforms the current scope selection targets, empty if the selection is incomplete. */ fun currentPlatforms(): Set = when (scope) { @@ -384,20 +212,30 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n ReleaseScope.SERVER_ONLY -> setOf(Platform.SERVER) } - // Without a full selection there is no tag yet, so the notes preview falls back - // to the bare version tag. - fun currentTag(): String { - val platforms = currentPlatforms() - return if (platforms.isEmpty()) "v$newSemVar" else "v$newSemVar${tagSuffix(platforms)}" + // The store editor mirrors a filtered copy of the full notes until it is + // edited by hand, after which it is left alone. + var storeNotesEdited = false + var syncingStoreNotes = false + + fun syncStoreNotes() { + if (storeNotesEdited) return + syncingStoreNotes = true + storeNotes.text = deriveStoreNotes(changeLog.text).notes + storeNotes.caretPosition = 0 + syncingStoreNotes = false } - fun followStatus(edited: Boolean) = - if (edited) "Hand-edited, so it no longer follows the store notes." - else "Following the store notes." + fun resyncStoreNotes() { + storeNotesEdited = false + syncStoreNotes() + } fun refresh() { val platforms = currentPlatforms() - val tag = currentTag() + // Without a full selection there is no tag yet, so the notes preview falls + // back to the bare version tag. + val tag = + if (platforms.isEmpty()) "v$newSemVar" else "v$newSemVar${tagSuffix(platforms)}" if (platforms.isNotEmpty()) { tagLabel.text = tag @@ -409,80 +247,42 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n tagLabel.foreground = warningColor } - // A sink only matters when the release reaches it, and a store outside the - // scope has its tab disabled so nobody writes notes that go nowhere. - // The shared tab stays enabled for any store release because the store tabs - // follow it, but it is only required when it is published itself. - val needsShared = reachesFlathub(platforms) - val needsPlay = reachesPlay(platforms) - val needsApple = reachesApple(platforms) - - changelogTabs.setEnabledAt(TAB_STORE, reachesAnyStore(platforms)) - changelogTabs.setEnabledAt(TAB_PLAY, needsPlay) - changelogTabs.setEnabledAt(TAB_APPLE, needsApple) - if (!changelogTabs.isEnabledAt(changelogTabs.selectedIndex)) { - changelogTabs.selectedIndex = TAB_FULL - } + // Empty notes would publish a "What's new" that describes nothing, which + // App Store review rejects — after the tag has already been pushed. A + // server-only release reaches no store, so it needs no store notes. + val needsStoreNotes = platforms.any { it in Platform.CLIENT_STORES } + commitButton.isEnabled = platforms.isNotEmpty() && + changeLog.text.isNotBlank() && + (!needsStoreNotes || storeNotes.text.isNotBlank()) val dropped = deriveStoreNotes(changeLog.text).dropped storeStatus.text = wrapped( when { - storeNotes.edited -> "Hand-edited, so it no longer follows the full notes." + storeNotesEdited -> "Hand-edited, so it no longer follows the full notes." dropped.isEmpty() -> "Nothing was removed." else -> "Removed ${dropped.size}: " + droppedSummary(dropped) } ) - storeStatus.foreground = if (storeNotes.edited) editedColor else warningColor - storeResync.isEnabled = storeNotes.edited + storeStatus.foreground = if (storeNotesEdited) truncateColor else warningColor + resyncButton.isEnabled = storeNotesEdited - playStatus.text = wrapped(followStatus(playNotes.edited)) - playStatus.foreground = if (playNotes.edited) editedColor else warningColor - playResync.isEnabled = playNotes.edited - - appleStatus.text = wrapped(followStatus(appleNotes.edited)) - appleStatus.foreground = if (appleNotes.edited) editedColor else warningColor - appleResync.isEnabled = appleNotes.edited - - // Over-limit blocks the commit instead of truncating quietly: the Play tab - // exists so the 500 characters are chosen, not cut off at a bullet boundary. val url = releaseNotesUrl(tag) - val playLength = storeNotesLength(playNotes.text, url) - val playOver = playLength > PLAY_STORE_LIMIT - playPreview.text = formatStoreNotes(playNotes.text, PLAY_STORE_LIMIT, url) + val needed = storeNotesLength(storeNotes.text, url) + playPreview.text = formatStoreNotes(storeNotes.text, PLAY_STORE_LIMIT, url) playPreview.caretPosition = 0 - playCount.text = counterText(playLength, PLAY_STORE_LIMIT) - playCount.foreground = if (playOver) errorColor else warningColor - trimButton.isEnabled = playOver - - val appleLength = storeNotesLength(appleNotes.text, null) - val appleOver = appleLength > APPLE_STORE_LIMIT - appleCount.text = counterText(appleLength, APPLE_STORE_LIMIT) - appleCount.foreground = if (appleOver) errorColor else warningColor - - // Empty notes would publish a "What's new" that describes nothing, which App - // Store review rejects, after the tag has already been pushed. - commitButton.isEnabled = platforms.isNotEmpty() && - changeLog.text.isNotBlank() && - (!needsShared || storeNotes.text.isNotBlank()) && - (!needsPlay || (playNotes.text.isNotBlank() && !playOver)) && - (!needsApple || (appleNotes.text.isNotBlank() && !appleOver)) + characterCount.text = if (needed > PLAY_STORE_LIMIT) { + "Store notes: ${storeNotes.document.length} · Play: $needed/$PLAY_STORE_LIMIT — will truncate" + } else { + "Store notes: ${storeNotes.document.length} · Play: $needed/$PLAY_STORE_LIMIT" + } + characterCount.foreground = + if (needed > PLAY_STORE_LIMIT) truncateColor else warningColor } - - changeLog.document.addDocumentListener(OnChangeListener { storeNotes.sync(); refresh() }) - storeNotes.onChange { playNotes.sync(); appleNotes.sync(); refresh() } - playNotes.onChange { refresh() } - appleNotes.onChange { refresh() } - - storeResync.addActionListener { storeNotes.resync(); refresh() } - playResync.addActionListener { playNotes.resync(); refresh() } - appleResync.addActionListener { appleNotes.resync(); refresh() } - // Trim puts the fitted text in the editor instead of letting the write path cut - // it later, so what the store gets is text someone looked at. - trimButton.addActionListener { - val budget = storeNotesBudget(PLAY_STORE_LIMIT, releaseNotesUrl(currentTag())) - playNotes.overwrite(fitStoreNotes(playNotes.text, budget)) + changeLog.document.addDocumentListener(OnChangeListener { syncStoreNotes(); refresh() }) + storeNotes.document.addDocumentListener(OnChangeListener { + if (!syncingStoreNotes) storeNotesEdited = true refresh() - } + }) // --- Label-value row helper for the Version section --- fun labelPair(label: String, value: JComponent): JPanel = JPanel().apply { @@ -564,22 +364,58 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n // ============= Section: Will push tag ============= val tagSection = section("Will push tag").apply { add(tagLabel) } - // ============= Section: After the build ============= - val autoPublishBox = JCheckBox("Auto-publish the GitHub release").apply { - alignmentX = Component.LEFT_ALIGNMENT - } - val autoPublishSection = section("After the build").apply { - add(autoPublishBox) - add( - tabHint("Off leaves a draft. Publishing starts the store workflow.") - .apply { alignmentX = Component.LEFT_ALIGNMENT }, - ) - } - // ============= Section: Changelog ============= val changelogSection = section("Changelog") - changelogSection.add(changelogTabs) + val fullTab = JPanel(BorderLayout(0, 4)).apply { + border = BorderFactory.createEmptyBorder(8, 0, 0, 0) + add(tabHint("Goes to CHANGELOG.md and the GitHub release. Write everything here."), BorderLayout.NORTH) + add(JScrollPane(changeLog), BorderLayout.CENTER) + } + resyncButton.addActionListener { resyncStoreNotes(); refresh() } + val storeHeader = JPanel().apply { + layout = BoxLayout(this, BoxLayout.Y_AXIS) + add( + tabHint("Goes to every store listing. Entries tagged for the web or server are filtered out — stores reject notes about anything but the app.").apply { + alignmentX = Component.LEFT_ALIGNMENT + }, + ) + add(storeStatus.apply { alignmentX = Component.LEFT_ALIGNMENT }) + add( + JPanel(FlowLayout(FlowLayout.LEFT, 0, 2)).apply { + alignmentX = Component.LEFT_ALIGNMENT + add(resyncButton) + }, + ) + } + val storeTab = JPanel(BorderLayout(0, 4)).apply { + border = BorderFactory.createEmptyBorder(8, 0, 0, 0) + add(storeHeader, BorderLayout.NORTH) + add(JScrollPane(storeNotes), BorderLayout.CENTER) + } + val changelogTabs = JTabbedPane().apply { + addTab("Full", fullTab) + addTab("App stores", storeTab) + } + + val counterRow = JPanel(FlowLayout(FlowLayout.RIGHT, 0, 4)).apply { + alignmentX = Component.LEFT_ALIGNMENT + add(characterCount) + } + val editorPane = JPanel(BorderLayout()).apply { + add(changelogTabs, BorderLayout.CENTER) + add(counterRow, BorderLayout.SOUTH) + } + val previewPane = JScrollPane(playPreview).apply { + border = BorderFactory.createTitledBorder("Google Play preview") + } + + val splitPane = JSplitPane(JSplitPane.VERTICAL_SPLIT, editorPane, previewPane).apply { + resizeWeight = 0.6 + border = null + alignmentX = Component.LEFT_ALIGNMENT + } + changelogSection.add(splitPane) // ============= Release-type change listeners (after newVersionLabel exists) ============= // A patch carries the same notes as the release it patches, so pre-fill the @@ -619,15 +455,8 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n result = ReleaseInfo( semVar = newSemVar, changeLog = changeLog.text, - // Mirroring fills every editor whatever the scope, so the sinks this - // release does not reach are dropped here rather than published. - storeNotes = StoreChangelogs( - shared = storeNotes.text, - play = playNotes.text, - apple = appleNotes.text, - ).restrictedTo(currentPlatforms()), + storeChangeLog = storeNotes.text, platforms = currentPlatforms(), - autoPublish = autoPublishBox.isSelected, ) frame.dispose() } @@ -647,8 +476,6 @@ fun configureRelease(currentSemVarStr: String, lastReleaseChangelog: String? = n add(Box.createRigidArea(Dimension(0, 8))) add(tagSection) add(Box.createRigidArea(Dimension(0, 8))) - add(autoPublishSection) - add(Box.createRigidArea(Dimension(0, 8))) } val root = JPanel(BorderLayout()).apply { border = BorderFactory.createEmptyBorder(16, 20, 16, 20) diff --git a/buildSrc/src/main/java/distributionChannel.kt b/buildSrc/src/main/java/distributionChannel.kt deleted file mode 100644 index 11d6dab85..000000000 --- a/buildSrc/src/main/java/distributionChannel.kt +++ /dev/null @@ -1,57 +0,0 @@ -package com.darkrockstudios.build - -import org.gradle.api.Project - -/** - * Build-side mirror of the runtime `DistributionChannel` enum in `:base`. The two lists have to - * stay in step; `DistributionChannelTest` in `:base` pins the token strings so a change to one - * without the other fails a test rather than shipping a build that reports the wrong channel. - * - * Tokens match [Platform.tagToken] wherever the two overlap. - */ -enum class DistributionChannel(val token: String) { - DEV("dev"), - GITHUB("github"), - PLAY("google-play"), - FDROID("fdroid"), - SNAP("snap"), - APPIMAGE("appimage"), - FLATHUB("flathub"), - MICROSOFT_STORE("ms-store"), - MAC_APP_STORE("mac-app-store"), - IOS_APP_STORE("ios-app-store"), - ; - - companion object { - fun fromToken(token: String): DistributionChannel? = entries.firstOrNull { it.token == token } - } -} - -/** - * Resolves the channel for this build from `-Pchannel=`, defaulting to [FDROID] when the - * F-Droid build flags are set and [DEV] otherwise. Throws on an unknown token, so a typo in a - * release workflow fails the build instead of quietly shipping a store binary as [DEV]. - */ -fun resolveDistributionChannel( - channelProperty: String?, - isFDroid: Boolean, -): DistributionChannel { - val requested = channelProperty?.trim()?.takeIf { it.isNotEmpty() } - ?: return if (isFDroid) DistributionChannel.FDROID else DistributionChannel.DEV - - return DistributionChannel.fromToken(requested) - ?: error( - "Unknown -Pchannel=$requested. Valid channels: " + - DistributionChannel.entries.joinToString(", ") { it.token } - ) -} - -/** - * The channel this build is for. The F-Droid detection mirrors settings.gradle.kts, which cannot - * see buildSrc, so a plain F-Droid build reports its channel without passing -Pchannel too. - */ -fun Project.distributionChannel(): DistributionChannel { - val isFDroid = findProperty("fdroid")?.toString()?.isNotEmpty() == true || - System.getenv("FDROID_BUILD") != null - return resolveDistributionChannel(findProperty("channel")?.toString(), isFDroid) -} diff --git a/buildSrc/src/main/java/packageFormat.kt b/buildSrc/src/main/java/packageFormat.kt deleted file mode 100644 index 1fdc3c719..000000000 --- a/buildSrc/src/main/java/packageFormat.kt +++ /dev/null @@ -1,45 +0,0 @@ -package com.darkrockstudios.build - -import org.gradle.api.Project - -/** - * Build-side mirror of the runtime `PackageFormat` enum in `:base`. The two lists have to stay - * in step; `PackageFormatTest` in `:base` pins the token strings so a change to one without the - * other fails a test rather than shipping a build that reports the wrong format. - */ -enum class PackageFormat(val token: String) { - NONE("none"), - MSI("msi"), - EXE("exe"), - DEB("deb"), - RPM("rpm"), - DMG("dmg"), - PKG("pkg"), - APPIMAGE("appimage"), - MSIX("msix"), - SNAP("snap"), - FLATPAK("flatpak"), - ; - - companion object { - fun fromToken(token: String): PackageFormat? = entries.firstOrNull { it.token == token } - } -} - -/** - * Resolves the installer format for this build from `-Pformat=`, defaulting to [NONE] - * for anything that is not a packaging run. Throws on an unknown token, so a typo in a release - * workflow fails the build instead of quietly shipping an installer that cannot name itself. - */ -fun resolvePackageFormat(formatProperty: String?): PackageFormat { - val requested = formatProperty?.trim()?.takeIf { it.isNotEmpty() } ?: return PackageFormat.NONE - - return PackageFormat.fromToken(requested) - ?: error( - "Unknown -Pformat=$requested. Valid formats: " + - PackageFormat.entries.joinToString(", ") { it.token } - ) -} - -/** The installer format this build is packaged as, from `-Pformat`. */ -fun Project.packageFormat(): PackageFormat = resolvePackageFormat(findProperty("format")?.toString()) diff --git a/buildSrc/src/main/java/storeNotes.kt b/buildSrc/src/main/java/storeNotes.kt index 5017d975f..cbf709095 100644 --- a/buildSrc/src/main/java/storeNotes.kt +++ b/buildSrc/src/main/java/storeNotes.kt @@ -25,14 +25,7 @@ private val SECTION_HEADER = Regex("""^\[[^]]+]$""") /** The longest `Label:` prefix treated as an audience label rather than prose. */ private const val MAX_LABEL_LENGTH = 20 -/** - * The GitHub release page for a release tag, where the untruncated notes live. - * - * Only Google Play is given this link. App Store review rejects release notes that - * link to the project's GitHub page — it offers the app outside the App Store — so - * the Apple stores pass `null` as the footer URL. The link shipped to iOS and macOS - * from v3.7.0 onward and drew "invalid metadata" rejections until it was removed. - */ +/** The GitHub release page for a release tag, where the untruncated notes live. */ fun releaseNotesUrl(tag: String): String = "$GITHUB_REPO/releases/tag/$tag" /** @@ -163,9 +156,8 @@ fun deriveStoreNotes(fullChangelog: String): StoreNotesDerivation { } /** - * Fits [changelog] into a store's character limit, leaving room for a footer pointing - * at the full notes when [fullNotesUrl] is given — see [releaseNotesUrl] for why the - * Apple stores pass null. Whole entries are kept so the text does not end + * Fits [changelog] into a store's character limit, always leaving room for a footer + * pointing at the full notes. Whole entries are kept so the text does not end * mid-bullet, and an entry too long for the remaining budget is skipped rather than * ending the notes. The `…` mark is appended only when an entry was actually left * out; text that fits once its blank lines are collapsed is not marked truncated. @@ -177,34 +169,18 @@ fun deriveStoreNotes(fullChangelog: String): StoreNotesDerivation { * A blank changelog yields an empty string: store metadata that is only a link * describes nothing, and App Store review rejects it. */ -fun formatStoreNotes(changelog: String, limit: Int, fullNotesUrl: String?): String { +fun formatStoreNotes(changelog: String, limit: Int, fullNotesUrl: String): String { val body = normalizeNotes(changelog) if (body.isEmpty()) return "" val footer = footerFor(fullNotesUrl) - val budget = storeNotesBudget(limit, fullNotesUrl) + val budget = limit - footer.length require(budget > 0) { "Limit $limit is too small to hold the changelog footer" } - return fitStoreNotes(body, budget) + footer -} - -/** How much of a store's limit is left for the notes once its footer is subtracted. */ -fun storeNotesBudget(limit: Int, fullNotesUrl: String?): Int = limit - footerFor(fullNotesUrl).length - -/** - * [changelog] cut down to [limit] characters, footer excluded. Returns the body on - * its own so the release dialog can put the fitted text back in the Google Play - * editor for the user to improve, rather than appending a footer that the next - * [formatStoreNotes] call would append again. - */ -fun fitStoreNotes(changelog: String, limit: Int): String { - val body = normalizeNotes(changelog) - if (body.isEmpty()) return "" - require(limit > 0) { "Limit $limit leaves no room for notes" } - if (body.length <= limit) return body + if (body.length <= budget) return body + footer val entries = parseEntries(body) - val truncatedBudget = limit - TRUNCATION_MARK.length + val truncatedBudget = budget - TRUNCATION_MARK.length val kept = mutableListOf() for (entry in entries) { val candidate = pruneEmptySections(kept + entry) @@ -218,27 +194,21 @@ fun fitStoreNotes(changelog: String, limit: Int): String { val hardCut = body.take(truncatedBudget).trimEnd() val lastSpace = hardCut.lastIndexOf(' ') val cut = if (lastSpace > 0) hardCut.take(lastSpace) else hardCut - return cut.trimEnd() + TRUNCATION_MARK + return cut.trimEnd() + TRUNCATION_MARK + footer } val fitted = render(pruneEmptySections(kept)).trimEnd() val mark = if (kept.size == entries.size) "" else TRUNCATION_MARK - return fitted + mark + return fitted + mark + footer } -/** - * How many characters [changelog] needs at a store, including the footer when - * [fullNotesUrl] is given. Pass the same URL the store's [formatStoreNotes] call - * gets — null for the Apple stores — or the "will it truncate?" comparison is off - * by the footer's length. - */ -fun storeNotesLength(changelog: String, fullNotesUrl: String?): Int { +/** How many characters [changelog] needs at a store, footer included. */ +fun storeNotesLength(changelog: String, fullNotesUrl: String): Int { val body = normalizeNotes(changelog) return if (body.isEmpty()) 0 else body.length + footerFor(fullNotesUrl).length } -private fun footerFor(fullNotesUrl: String?) = - if (fullNotesUrl == null) "" else "\n\n$FOOTER_LABEL\n$fullNotesUrl" +private fun footerFor(fullNotesUrl: String) = "\n\n$FOOTER_LABEL\n$fullNotesUrl" /** * CHANGELOG.md is checked out with CRLF on Windows and seeds the release dialog, so @@ -246,55 +216,3 @@ private fun footerFor(fullNotesUrl: String?) = * lines with LF) and the verbatim path would disagree with the counted length. */ private fun normalizeNotes(changelog: String) = changelog.replace("\r\n", "\n").trim() - -/** - * The release notes each store listing carries. - * - * [shared] is the app-only text produced by filtering the full changelog; [play] - * and [apple] begin as copies of it and diverge only when hand-edited in the - * release dialog. The split exists because the two sinks have incompatible - * budgets (500 characters with a footer link at Google Play against 4000 with no - * link at Apple), so text written to fill one is machine-mangled at the other. - * - * Stores with no tab of their own take [shared]: F-Droid and Google Play read the - * same fastlane file, so F-Droid is covered by [play]. - */ -data class StoreChangelogs( - val shared: String, - val play: String = shared, - val apple: String = shared, -) { - fun notesFor(platform: Platform): String = when (platform) { - Platform.GOOGLE_PLAY, Platform.FDROID -> play - Platform.IOS_APP_STORE, Platform.MAC_APP_STORE -> apple - Platform.SNAP, Platform.MS_STORE, Platform.SERVER -> shared - } - - /** The same notes with every sink this release does not reach blanked out. */ - fun restrictedTo(platforms: Set) = StoreChangelogs( - shared = if (reachesFlathub(platforms)) shared else "", - play = if (reachesPlay(platforms)) play else "", - apple = if (reachesApple(platforms)) apple else "", - ) - - /** True when no listing would carry any text at all. */ - val isBlank: Boolean get() = shared.isBlank() && play.isBlank() && apple.isBlank() -} - -/** Whether a release to [platforms] reaches the Google Play file, which F-Droid also reads. */ -fun reachesPlay(platforms: Set) = - Platform.GOOGLE_PLAY in platforms || Platform.FDROID in platforms - -/** Whether a release to [platforms] reaches either Apple listing. */ -fun reachesApple(platforms: Set) = - Platform.IOS_APP_STORE in platforms || Platform.MAC_APP_STORE in platforms - -/** Whether a release to [platforms] reaches any store listing at all. */ -fun reachesAnyStore(platforms: Set) = platforms.any { it in Platform.CLIENT_STORES } - -/** - * Whether a release to [platforms] is a Flathub release. Flathub is published by hand - * with `publishFlathub`, outside the tag's store scope, so only a release that ships - * every client store counts; a targeted hotfix names its stores and Flathub is not one. - */ -fun reachesFlathub(platforms: Set) = platforms.containsAll(Platform.CLIENT_STORES) diff --git a/buildSrc/src/main/java/updateMetadata.kt b/buildSrc/src/main/java/updateMetadata.kt deleted file mode 100644 index effbe4224..000000000 --- a/buildSrc/src/main/java/updateMetadata.kt +++ /dev/null @@ -1,145 +0,0 @@ -package com.darkrockstudios.build - -import org.gradle.api.Project -import java.io.File -import java.security.MessageDigest -import java.time.Instant -import java.time.temporal.ChronoUnit -import java.util.Base64 - -/** One attached installer as the update metadata describes it. */ -data class UpdateAsset(val name: String, val size: Long, val sha512: String) - -/** - * The metadata files the desktop updater reads, each listing its platform's installers in - * preference order. The format is electron-builder's `latest.yml`, which Nucleus parses; the - * `url` is the bare asset name and the client prefixes the release URL. - */ -private val UPDATE_METADATA_FILES: Map> = mapOf( - "latest.yml" to listOf("hammer.msi", "hammer.exe"), - "latest-mac.yml" to listOf("hammer.zip", "hammer.dmg", "hammer.pkg"), - "latest-linux.yml" to listOf("hammer.deb", "hammer.rpm", "hammer.AppImage"), -) - -/** Assets a release may legitimately lack; every other listed name must have a digest. */ -private val OPTIONAL_ASSETS: Set = setOf("hammer.zip") - -/** Suffix of the sidecar each platform job writes next to its installer: ` `. */ -const val DIGEST_SUFFIX = ".sha512" - -private const val SHA512_BUFFER_SIZE = 1 shl 16 - -fun renderUpdateMetadata(version: String, releaseDate: String, assets: List): String = - buildString { - appendLine("version: $version") - appendLine("releaseDate: $releaseDate") - appendLine("files:") - for (asset in assets) { - appendLine(" - url: ${asset.name}") - appendLine(" sha512: ${asset.sha512}") - appendLine(" size: ${asset.size}") - } - } - -/** Base64 of the SHA-512 digest, which is how Nucleus's checksum verifier compares it. */ -fun sha512Base64(file: File): String { - val digest = MessageDigest.getInstance("SHA-512") - file.inputStream().use { input -> - val buffer = ByteArray(SHA512_BUFFER_SIZE) - while (true) { - val read = input.read(buffer) - if (read < 0) break - digest.update(buffer, 0, read) - } - } - return Base64.getEncoder().encodeToString(digest.digest()) -} - -/** The one-line sidecar content for an installer. */ -fun assetDigestLine(file: File): String = "${sha512Base64(file)} ${file.length()}" - -fun parseAssetDigest(name: String, line: String): UpdateAsset { - val parts = line.trim().split(' ') - require(parts.size == 2) { "Digest for $name should be ' ', got '$line'" } - val size = parts[1].toLongOrNull() ?: error("Digest for $name has a non-numeric size: '$line'") - return UpdateAsset(name = name, size = size, sha512 = parts[0]) -} - -/** - * Builds every metadata file from the digest sidecars anywhere under [digestsDir], keyed by file - * name: upload-artifact keeps each installer's format subdirectory. A required installer with no - * sidecar fails loudly: a yml that omits it would silently leave that format with no update path. - */ -fun updateMetadataFiles(digestsDir: File, version: String, releaseDate: String): Map { - val sidecars = digestsDir.walk() - .filter { it.isFile && it.name.endsWith(DIGEST_SUFFIX) } - .groupBy { it.name } - .mapValues { (name, found) -> - found.singleOrNull() ?: error("$digestsDir has more than one $name: $found") - } - return UPDATE_METADATA_FILES.mapValues { (metadataFile, names) -> - val assets = names.mapNotNull { name -> - val sidecar = sidecars[name + DIGEST_SUFFIX] - when { - sidecar != null -> parseAssetDigest(name, sidecar.readText()) - name in OPTIONAL_ASSETS -> null - else -> error("$metadataFile needs $name$DIGEST_SUFFIX, but $digestsDir has no such file") - } - } - renderUpdateMetadata(version, releaseDate, assets) - } -} - -/** - * Registers the two halves of the update metadata: - * - * - `writeAssetDigests -PassetFiles=` runs in each platform job right after it - * packages and renames its installers, writing `.sha512` beside each one. The - * sidecars travel to the final job as a workflow artifact, so no installer is downloaded - * twice and no release lookup is needed. - * - `writeUpdateMetadata -PreleaseDigestsDir=` runs once in the final job over the - * collected sidecars and writes the yml files to `build/update-metadata/`. - */ -fun Project.registerUpdateMetadataTasks(appVersion: String) { - tasks.register("writeAssetDigests") { - group = "distribution" - description = "Writes a .sha512 sidecar beside each installer in -PassetFiles (comma separated)." - - doLast { - val files = findProperty("assetFiles")?.toString() - ?.split(',') - ?.map { it.trim() } - ?.filter { it.isNotEmpty() } - ?.takeIf { it.isNotEmpty() } - ?: error("Pass -PassetFiles=[,...]") - for (path in files) { - val file = File(path) - check(file.isFile) { "No installer at $path" } - val sidecar = File(file.path + DIGEST_SUFFIX) - sidecar.writeText(assetDigestLine(file)) - println("Wrote $sidecar") - } - } - } - - tasks.register("writeUpdateMetadata") { - group = "distribution" - description = "Writes the latest*.yml files the desktop updater reads, from the digest sidecars in -PreleaseDigestsDir." - - doLast { - val digestsDir = File( - findProperty("releaseDigestsDir")?.toString() - ?: error("Pass -PreleaseDigestsDir=") - ) - val outputDir = layout.buildDirectory.dir("update-metadata").get().asFile - outputDir.mkdirs() - - val releaseDate = Instant.now().truncatedTo(ChronoUnit.SECONDS).toString() - for ((name, content) in updateMetadataFiles(digestsDir, appVersion, releaseDate)) { - val target = outputDir.resolve(name) - target.writeText(content) - println("Wrote $target") - } - } - } -} diff --git a/buildSrc/src/main/java/versioncode.kt b/buildSrc/src/main/java/versioncode.kt index 977202cbe..7589e7c34 100644 --- a/buildSrc/src/main/java/versioncode.kt +++ b/buildSrc/src/main/java/versioncode.kt @@ -8,29 +8,9 @@ fun getVersionCode(semVarStr: String): Int { val semVar = parseSemVar(semVarStr) val versionCode = semVar.createVersionCode(isRelease, buildNumber) - require(versionCode in 0 until WEAR_VERSION_CODE_OFFSET) { - "Version $semVarStr produces version code $versionCode, which runs into the Wear OS band at " + - "$WEAR_VERSION_CODE_OFFSET. Rework the version code scheme before releasing 10.0.0." - } - return versionCode } -/** - * Play needs unique version codes across every bundle in a listing. Phone codes stay below this - * while the major version is below 10, and phone plus offset stays under Play's 2,100,000,000 cap. - */ -private const val WEAR_VERSION_CODE_OFFSET = 1_000_000_000 - -fun getWearVersionCode(semVarStr: String): Int = wearVersionCode(getVersionCode(semVarStr)) - -fun wearVersionCode(phoneVersionCode: Int): Int { - require(phoneVersionCode in 0 until WEAR_VERSION_CODE_OFFSET) { - "Phone version code $phoneVersionCode leaves no room for the wear offset" - } - return phoneVersionCode + WEAR_VERSION_CODE_OFFSET -} - data class SemVar( val major: Int, val minor: Int, diff --git a/buildSrc/src/test/java/DistributionChannelTest.kt b/buildSrc/src/test/java/DistributionChannelTest.kt deleted file mode 100644 index d9eacd9be..000000000 --- a/buildSrc/src/test/java/DistributionChannelTest.kt +++ /dev/null @@ -1,50 +0,0 @@ -import com.darkrockstudios.build.DistributionChannel -import com.darkrockstudios.build.resolveDistributionChannel -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith - -class DistributionChannelTest { - - @Test - fun `no channel property is a dev build`() { - assertEquals(DistributionChannel.DEV, resolveDistributionChannel(null, isFDroid = false)) - assertEquals(DistributionChannel.DEV, resolveDistributionChannel("", isFDroid = false)) - assertEquals(DistributionChannel.DEV, resolveDistributionChannel(" ", isFDroid = false)) - } - - @Test - fun `the fdroid build flag stands in for the channel property`() { - assertEquals(DistributionChannel.FDROID, resolveDistributionChannel(null, isFDroid = true)) - } - - @Test - fun `an explicit channel wins over the fdroid flag`() { - assertEquals( - DistributionChannel.GITHUB, - resolveDistributionChannel("github", isFDroid = true) - ) - } - - @Test - fun `every token resolves to its own channel`() { - for (channel in DistributionChannel.entries) { - assertEquals(channel, resolveDistributionChannel(channel.token, isFDroid = false)) - } - } - - /** A typo in a release workflow must fail the build, not ship a store binary as DEV. */ - @Test - fun `an unknown token fails the build`() { - val error = assertFailsWith { - resolveDistributionChannel("microsoftStore", isFDroid = false) - } - assertEquals(true, error.message?.contains("ms-store")) - } - - @Test - fun `tokens are unique`() { - val tokens = DistributionChannel.entries.map { it.token } - assertEquals(tokens.size, tokens.toSet().size) - } -} diff --git a/buildSrc/src/test/java/PackageFormatTest.kt b/buildSrc/src/test/java/PackageFormatTest.kt deleted file mode 100644 index e542031e9..000000000 --- a/buildSrc/src/test/java/PackageFormatTest.kt +++ /dev/null @@ -1,34 +0,0 @@ -import com.darkrockstudios.build.PackageFormat -import com.darkrockstudios.build.resolvePackageFormat -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith - -class PackageFormatTest { - - @Test - fun `no format property means not packaged`() { - assertEquals(PackageFormat.NONE, resolvePackageFormat(null)) - assertEquals(PackageFormat.NONE, resolvePackageFormat("")) - assertEquals(PackageFormat.NONE, resolvePackageFormat(" ")) - } - - @Test - fun `every token resolves to its own format`() { - for (format in PackageFormat.entries) { - assertEquals(format, resolvePackageFormat(format.token)) - } - } - - @Test - fun `an unknown token fails the build`() { - val error = assertFailsWith { resolvePackageFormat("windows") } - assertEquals(true, error.message?.contains("Unknown -Pformat=windows")) - } - - @Test - fun `tokens are unique`() { - val tokens = PackageFormat.entries.map { it.token } - assertEquals(tokens.toSet().size, tokens.size) - } -} diff --git a/buildSrc/src/test/java/ReleaseInfoTest.kt b/buildSrc/src/test/java/ReleaseInfoTest.kt deleted file mode 100644 index 735df7c08..000000000 --- a/buildSrc/src/test/java/ReleaseInfoTest.kt +++ /dev/null @@ -1,65 +0,0 @@ -package com.darkrockstudios.build - -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class ReleaseInfoTest { - - private fun releaseInfo(autoPublish: Boolean) = ReleaseInfo( - semVar = SemVar(1, 2, 3), - changeLog = "Added a thing\n- detail one", - storeNotes = StoreChangelogs("Added a thing"), - platforms = Platform.ALL, - autoPublish = autoPublish, - ) - - @Test - fun `Auto-publish is off by default`() { - assertFalse( - ReleaseInfo( - semVar = SemVar(1, 2, 3), - changeLog = "notes", - storeNotes = StoreChangelogs("notes"), - platforms = Platform.ALL, - ).autoPublish - ) - } - - @Test - fun `Tag message is the changelog alone when auto-publish is off`() { - assertEquals("Added a thing\n- detail one", releaseInfo(autoPublish = false).tagMessage) - } - - @Test - fun `Tag message appends the trailer as its own last line when auto-publish is on`() { - val lines = releaseInfo(autoPublish = true).tagMessage.lines() - assertEquals(AUTO_PUBLISH_TRAILER, lines.last()) - // The blank line keeps the trailer out of the last changelog paragraph, so - // set-release-body strips it without leaving a dangling line in the body. - assertEquals("", lines[lines.size - 2]) - } - - // set-release-body greps for this exact whole line; a reword here silently stops - // CI from publishing. - @Test - fun `Trailer wire format is stable`() { - assertEquals("Auto-Publish: true", AUTO_PUBLISH_TRAILER) - } - - @Test - fun `Dropping the trailer restores the plain changelog`() { - val stripped = releaseInfo(autoPublish = true).tagMessage - .lines() - .filterNot { it == AUTO_PUBLISH_TRAILER } - .joinToString("\n") - .trimEnd() - assertEquals(releaseInfo(autoPublish = false).tagMessage, stripped) - } - - @Test - fun `Trailer never leaks into a release that did not ask for it`() { - assertTrue(AUTO_PUBLISH_TRAILER !in releaseInfo(autoPublish = false).tagMessage) - } -} diff --git a/buildSrc/src/test/java/StoreChangelogsTest.kt b/buildSrc/src/test/java/StoreChangelogsTest.kt deleted file mode 100644 index 72dddbb6d..000000000 --- a/buildSrc/src/test/java/StoreChangelogsTest.kt +++ /dev/null @@ -1,151 +0,0 @@ -package com.darkrockstudios.build - -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class StoreChangelogsTest { - - private val url = releaseNotesUrl("v3.7.0") - - @Test - fun `A store with no tab of its own takes the shared notes`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals("shared", notes.notesFor(Platform.SNAP)) - assertEquals("shared", notes.notesFor(Platform.MS_STORE)) - assertEquals("shared", notes.notesFor(Platform.SERVER)) - } - - // F-Droid and Google Play read the same fastlane file, so they cannot disagree. - @Test - fun `F-Droid takes the Google Play notes`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals(notes.notesFor(Platform.GOOGLE_PLAY), notes.notesFor(Platform.FDROID)) - } - - @Test - fun `Both Apple stores take the Apple notes`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals("apple", notes.notesFor(Platform.IOS_APP_STORE)) - assertEquals("apple", notes.notesFor(Platform.MAC_APP_STORE)) - } - - @Test - fun `Stores follow the shared notes until they are given their own`() { - val notes = StoreChangelogs(shared = "shared") - - Platform.values().forEach { platform -> - assertEquals("shared", notes.notesFor(platform), "$platform diverged") - } - } - - @Test - fun `Blank is only blank when every sink is`() { - assertTrue(StoreChangelogs(shared = "").isBlank) - assertFalse(StoreChangelogs(shared = "", play = "play", apple = "").isBlank) - assertFalse(StoreChangelogs(shared = "shared").isBlank) - } - - @Test - fun `Fitted notes carry no footer`() { - val changelog = (1..40).joinToString("\n") { "- [New] Feature number $it in this release" } - - val fitted = fitStoreNotes(changelog, storeNotesBudget(PLAY_STORE_LIMIT, url)) - - assertFalse(url in fitted, "The footer url leaked into the fitted body") - assertTrue(fitted.length <= storeNotesBudget(PLAY_STORE_LIMIT, url)) - } - - // The dialog's Trim to fit puts fitted text back in the editor, which is then - // formatted again on the way to the store. A footer in the fitted body would be - // published twice and eat the budget a second time. - @Test - fun `Trimming then publishing stays within the limit with one footer`() { - val changelog = (1..40).joinToString("\n") { "- [New] Feature number $it in this release" } - - val trimmed = fitStoreNotes(changelog, storeNotesBudget(PLAY_STORE_LIMIT, url)) - val published = formatStoreNotes(trimmed, PLAY_STORE_LIMIT, url) - - assertTrue(published.length <= PLAY_STORE_LIMIT, "Notes were ${published.length} characters") - assertEquals(1, published.split(url).size - 1, "The footer was published more than once") - } - - @Test - fun `Trimming already fitted notes changes nothing`() { - val changelog = (1..40).joinToString("\n") { "- [New] Feature number $it in this release" } - val budget = storeNotesBudget(PLAY_STORE_LIMIT, url) - - val once = fitStoreNotes(changelog, budget) - - assertEquals(once, fitStoreNotes(once, budget)) - } - - @Test - fun `Publishing is fitting plus the footer`() { - val changelog = (1..40).joinToString("\n") { "- [New] Feature number $it in this release" } - - assertEquals( - fitStoreNotes(changelog, storeNotesBudget(PLAY_STORE_LIMIT, url)) + "\n\nFull changelog:\n$url", - formatStoreNotes(changelog, PLAY_STORE_LIMIT, url), - ) - } - - @Test - fun `The Apple budget is the whole limit because it carries no footer`() { - assertEquals(APPLE_STORE_LIMIT, storeNotesBudget(APPLE_STORE_LIMIT, null)) - } - - @Test - fun `A server-only release publishes no store notes`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertTrue(notes.restrictedTo(setOf(Platform.SERVER)).isBlank) - } - - @Test - fun `A release skips the sinks it does not reach`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - val playOnly = notes.restrictedTo(setOf(Platform.GOOGLE_PLAY)) - - assertEquals("play", playOnly.play) - assertEquals("", playOnly.apple) - assertEquals("", playOnly.shared) - } - - @Test - fun `Only a release to every client store reaches Flathub`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals("shared", notes.restrictedTo(Platform.CLIENT_STORES).shared) - assertEquals("", notes.restrictedTo(Platform.CLIENT_STORES - Platform.SNAP).shared) - } - - @Test - fun `An F-Droid release still fills the Google Play file they share`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals("play", notes.restrictedTo(setOf(Platform.FDROID)).play) - } - - @Test - fun `A mac-only release keeps the Apple notes both listings share`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - val macOnly = notes.restrictedTo(setOf(Platform.MAC_APP_STORE)) - - assertEquals("apple", macOnly.apple) - assertEquals("", macOnly.play) - } - - @Test - fun `A full release keeps every sink`() { - val notes = StoreChangelogs(shared = "shared", play = "play", apple = "apple") - - assertEquals(notes, notes.restrictedTo(Platform.ALL)) - } -} diff --git a/buildSrc/src/test/java/StoreNotesTest.kt b/buildSrc/src/test/java/StoreNotesTest.kt index b969ca3ea..c921b72a7 100644 --- a/buildSrc/src/test/java/StoreNotesTest.kt +++ b/buildSrc/src/test/java/StoreNotesTest.kt @@ -213,47 +213,6 @@ class StoreNotesTest { assertEquals(shortNotes.length, storeNotesLength(short, url)) } - @Test - fun `A null url publishes the notes with no footer and no link`() { - val changelog = "- [Fix] A bug\n- [New] A feature" - - val notes = formatStoreNotes(changelog, APPLE_STORE_LIMIT, null) - - assertEquals(changelog, notes) - assertEquals(changelog.length, storeNotesLength(changelog, null)) - } - - @Test - fun `Apple notes never carry a link that App Store review would reject`() { - // The regression that broke every iOS and macOS submission from v3.7.0: the - // footer was appended for Apple too, so the notes ended in a github.com URL. - val changelog = (1..400).joinToString("\n") { "- [New] Feature number $it in this release" } - - listOf( - formatStoreNotes("- [Fix] A bug", APPLE_STORE_LIMIT, null), - formatStoreNotes(changelog, APPLE_STORE_LIMIT, null), - formatStoreNotes("word ".repeat(2000).trim(), APPLE_STORE_LIMIT, null), - ).forEach { notes -> - assertTrue(!notes.contains("github.com"), "Apple notes carry a GitHub link:\n$notes") - assertTrue(!notes.contains("Full changelog:"), "Apple notes carry the footer:\n$notes") - assertTrue(notes.length <= APPLE_STORE_LIMIT, "Notes were ${notes.length} characters") - } - } - - @Test - fun `Dropping the footer gives the body more of the budget`() { - val changelog = (1..40).joinToString("\n") { "- [New] Feature number $it in this release" } - - val withFooter = formatStoreNotes(changelog, PLAY_STORE_LIMIT, url) - val without = formatStoreNotes(changelog, PLAY_STORE_LIMIT, null) - - assertTrue( - publishedBody(without).length > publishedBody(withFooter).length, - "The footer's characters were not returned to the body", - ) - assertTrue(without.length <= PLAY_STORE_LIMIT, "Notes were ${without.length} characters") - } - @Test fun `Release url points at the tag`() { assertEquals( diff --git a/buildSrc/src/test/java/UpdateMetadataTest.kt b/buildSrc/src/test/java/UpdateMetadataTest.kt deleted file mode 100644 index 7847fa53a..000000000 --- a/buildSrc/src/test/java/UpdateMetadataTest.kt +++ /dev/null @@ -1,140 +0,0 @@ -import com.darkrockstudios.build.DIGEST_SUFFIX -import com.darkrockstudios.build.UpdateAsset -import com.darkrockstudios.build.assetDigestLine -import com.darkrockstudios.build.parseAssetDigest -import com.darkrockstudios.build.renderUpdateMetadata -import com.darkrockstudios.build.sha512Base64 -import com.darkrockstudios.build.updateMetadataFiles -import java.io.File -import java.nio.file.Files -import java.security.MessageDigest -import java.util.Base64 -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith -import kotlin.test.assertNull - -class UpdateMetadataTest { - - private val installers = listOf( - "hammer.msi", "hammer.exe", "hammer.dmg", "hammer.pkg", "hammer.deb", "hammer.rpm", "hammer.AppImage", - ) - - @Test - fun `renders the electron-builder layout Nucleus parses`() { - val yml = renderUpdateMetadata( - version = "3.12.0", - releaseDate = "2026-10-20T18:04:11Z", - assets = listOf( - UpdateAsset("hammer.msi", 190034708, "abc="), - UpdateAsset("hammer.exe", 190100000, "def="), - ), - ) - - val expected = """ - |version: 3.12.0 - |releaseDate: 2026-10-20T18:04:11Z - |files: - | - url: hammer.msi - | sha512: abc= - | size: 190034708 - | - url: hammer.exe - | sha512: def= - | size: 190100000 - |""".trimMargin() - assertEquals(expected, yml) - } - - @Test - fun `sha512 is base64 of the digest`() { - val file = tempDir().resolve("asset.bin").apply { writeBytes(ByteArray(100_000) { it.toByte() }) } - - val expected = Base64.getEncoder().encodeToString( - MessageDigest.getInstance("SHA-512").digest(file.readBytes()) - ) - assertEquals(expected, sha512Base64(file)) - } - - @Test - fun `a digest line round-trips through the sidecar`() { - val file = tempDir().resolve("hammer.msi").apply { writeBytes(ByteArray(12_345) { (it * 3).toByte() }) } - - val asset = parseAssetDigest("hammer.msi", assetDigestLine(file) + "\n") - - assertEquals(UpdateAsset("hammer.msi", 12_345, sha512Base64(file)), asset) - } - - @Test - fun `a malformed sidecar is rejected`() { - assertFailsWith { parseAssetDigest("hammer.msi", "abc=") } - assertFailsWith { parseAssetDigest("hammer.msi", "abc= many") } - } - - @Test - fun `every platform file lists its installers from the sidecars`() { - val dir = tempDir() - installers.forEachIndexed { i, name -> dir.sidecar(name, "digest$i= ${100 + i}") } - - val files = updateMetadataFiles(dir, "3.12.0", "2026-10-20T18:04:11Z") - - assertEquals(setOf("latest.yml", "latest-mac.yml", "latest-linux.yml"), files.keys) - assertEquals(listOf("hammer.msi", "hammer.exe"), urlsIn(files.getValue("latest.yml"))) - assertEquals(listOf("hammer.dmg", "hammer.pkg"), urlsIn(files.getValue("latest-mac.yml"))) - assertEquals( - listOf("hammer.deb", "hammer.rpm", "hammer.AppImage"), - urlsIn(files.getValue("latest-linux.yml")), - ) - assertEquals(" sha512: digest0=", files.getValue("latest.yml").lines()[4]) - assertEquals(" size: 100", files.getValue("latest.yml").lines()[5]) - } - - @Test - fun `sidecars are found inside the per-format subdirectories the artifacts keep`() { - val dir = tempDir() - installers.forEach { dir.resolve(it.substringAfter('.').lowercase()).apply { mkdirs() }.sidecar(it, "x= 1") } - - val files = updateMetadataFiles(dir, "1", "d") - - assertEquals(listOf("hammer.msi", "hammer.exe"), urlsIn(files.getValue("latest.yml"))) - assertEquals(listOf("hammer.deb", "hammer.rpm", "hammer.AppImage"), urlsIn(files.getValue("latest-linux.yml"))) - } - - @Test - fun `a duplicated sidecar fails instead of picking one`() { - val dir = tempDir() - installers.forEach { dir.sidecar(it, "x= 1") } - dir.resolve("msi").apply { mkdirs() }.sidecar("hammer.msi", "y= 2") - - assertFailsWith { updateMetadataFiles(dir, "1", "d") } - } - - @Test - fun `the mac zip is listed first when present and skipped when absent`() { - val dir = tempDir() - installers.forEach { dir.sidecar(it, "x= 1") } - - assertNull(urlsIn(updateMetadataFiles(dir, "1", "d").getValue("latest-mac.yml")).firstOrNull { it == "hammer.zip" }) - - dir.sidecar("hammer.zip", "z= 2") - assertEquals( - listOf("hammer.zip", "hammer.dmg", "hammer.pkg"), - urlsIn(updateMetadataFiles(dir, "1", "d").getValue("latest-mac.yml")), - ) - } - - @Test - fun `a missing required installer fails instead of publishing a gap`() { - val dir = tempDir() - installers.filter { it != "hammer.exe" }.forEach { dir.sidecar(it, "x= 1") } - - val error = assertFailsWith { updateMetadataFiles(dir, "1", "d") } - assertEquals(true, error.message?.startsWith("latest.yml needs hammer.exe$DIGEST_SUFFIX")) - } - - private fun File.sidecar(name: String, line: String) = resolve(name + DIGEST_SUFFIX).writeText(line) - - private fun urlsIn(yml: String): List = - yml.lines().filter { it.trim().startsWith("- url:") }.map { it.substringAfter("- url:").trim() } - - private fun tempDir(): File = Files.createTempDirectory("update-metadata-test").toFile().apply { deleteOnExit() } -} diff --git a/buildSrc/src/test/java/VersionCodeTest.kt b/buildSrc/src/test/java/VersionCodeTest.kt index 0534bd9bb..4256fee15 100644 --- a/buildSrc/src/test/java/VersionCodeTest.kt +++ b/buildSrc/src/test/java/VersionCodeTest.kt @@ -28,27 +28,4 @@ class VersionCodeTest { versionCode = semVar.createVersionCode(true, 1) assertEquals(102040000, versionCode, "Release: True Build: 1") } - - @Test - fun `Wear version code sits above every phone version code`() { - val phoneCode = parseSemVar("9.99.99").createVersionCode(false, 9_999) - - assertEquals(1_999_999_999, wearVersionCode(phoneCode)) - assertEquals(1_102_030_001, wearVersionCode(102_030_001)) - } - - @Test(expected = IllegalArgumentException::class) - fun `Wear version code rejects a phone code that reaches the offset`() { - wearVersionCode(1_000_000_000) - } - - @Test(expected = IllegalArgumentException::class) - fun `A version that collides with the wear band is refused for every target`() { - getVersionCode("10.0.0") - } - - @Test - fun `The last version below the wear band is still allowed`() { - assertEquals(999_990_000, getVersionCode("9.99.99")) - } } \ No newline at end of file diff --git a/common/build.gradle.kts b/common/build.gradle.kts index 9a30c48aa..db9fbbffa 100644 --- a/common/build.gradle.kts +++ b/common/build.gradle.kts @@ -155,7 +155,7 @@ kotlin { api(libs.serialization.jvm) api(libs.coroutines.swing) implementation(libs.appdirs) - implementation(libs.ktor.client.okhttp) + implementation(libs.ktor.client.java) implementation(libs.turbine) } } diff --git a/common/src/androidHostTest/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStoreTest.kt b/common/src/androidHostTest/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStoreTest.kt deleted file mode 100644 index 58c96f1a7..000000000 --- a/common/src/androidHostTest/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStoreTest.kt +++ /dev/null @@ -1,150 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource - -import android.content.SharedPreferences -import kotlinx.serialization.json.Json -import javax.crypto.AEADBadTagException -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class EncryptedSharedPrefsAuthTokenStoreTest { - - private val disk = FakeEncryptedPrefsDisk() - - private fun createStore() = EncryptedSharedPrefsAuthTokenStore( - json = Json, - openPrefs = disk::open, - resetPrefs = disk::reset, - ) - - @Test - fun `tokens round trip`() { - val store = createStore() - - store.put(URL, USER_ID, TOKENS) - - assertEquals(TOKENS, createStore().get(URL, USER_ID)) - } - - @Test - fun `keyset the master key cannot decrypt is treated as no tokens`() { - disk.keysetDecryptable = false - val store = createStore() - - val tokens = store.get(URL, USER_ID) - - assertNull(tokens) - } - - @Test - fun `store is usable again after an undecryptable keyset`() { - disk.keysetDecryptable = false - createStore().get(URL, USER_ID) - - createStore().put(URL, USER_ID, TOKENS) - - assertEquals(TOKENS, createStore().get(URL, USER_ID)) - } - - @Test - fun `value that cannot be decrypted is treated as no tokens`() { - createStore().put(URL, USER_ID, TOKENS) - disk.valuesDecryptable = false - - val tokens = createStore().get(URL, USER_ID) - - assertNull(tokens) - } - - @Test - fun `put replaces a value that cannot be decrypted`() { - createStore().put(URL, USER_ID, TOKENS) - disk.valuesDecryptable = false - val replacement = AuthTokens(bearerToken = "new-bearer", refreshToken = "new-refresh") - - createStore().put(URL, USER_ID, replacement) - - assertEquals(replacement, createStore().get(URL, USER_ID)) - } - - companion object { - private const val URL = "https://hammer.example" - private const val USER_ID = 7L - private val TOKENS = AuthTokens(bearerToken = "bearer", refreshToken = "refresh") - } -} - -/** - * Models the encrypted prefs file: [open] fails like EncryptedSharedPreferences.create - * when the Keystore master key cannot decrypt the stored keyset, and [reset] removes - * the file (keyset included) so the next open generates a fresh one. - */ -private class FakeEncryptedPrefsDisk { - val values = mutableMapOf() - var keysetDecryptable = true - var valuesDecryptable = true - - fun open(): SharedPreferences { - if (!keysetDecryptable) throw AEADBadTagException() - return FakePrefs() - } - - fun reset() { - values.clear() - keysetDecryptable = true - valuesDecryptable = true - } - - private inner class FakePrefs : SharedPreferences { - override fun getString(key: String, defValue: String?): String? { - val stored = values[key] ?: return defValue - if (!valuesDecryptable) throw SecurityException("Could not decrypt value") - return stored - } - - override fun contains(key: String): Boolean = key in values - override fun getAll(): MutableMap = values.toMutableMap() - override fun edit(): SharedPreferences.Editor = FakeEditor() - - override fun getStringSet(key: String, defValues: MutableSet?) = unsupported() - override fun getInt(key: String, defValue: Int): Int = unsupported() - override fun getLong(key: String, defValue: Long): Long = unsupported() - override fun getFloat(key: String, defValue: Float): Float = unsupported() - override fun getBoolean(key: String, defValue: Boolean): Boolean = unsupported() - override fun registerOnSharedPreferenceChangeListener( - listener: SharedPreferences.OnSharedPreferenceChangeListener - ) = unsupported() - - override fun unregisterOnSharedPreferenceChangeListener( - listener: SharedPreferences.OnSharedPreferenceChangeListener - ) = unsupported() - } - - private inner class FakeEditor : SharedPreferences.Editor { - private val pending = mutableMapOf() - private var clearAll = false - - override fun putString(key: String, value: String?) = apply { pending[key] = value } - override fun remove(key: String) = apply { pending[key] = null } - override fun clear() = apply { clearAll = true } - - override fun commit(): Boolean { - if (clearAll) values.clear() - pending.forEach { (key, value) -> if (value == null) values.remove(key) else values[key] = value } - valuesDecryptable = true - return true - } - - override fun apply() { - commit() - } - - override fun putStringSet(key: String, values: MutableSet?) = unsupported() - override fun putInt(key: String, value: Int) = unsupported() - override fun putLong(key: String, value: Long) = unsupported() - override fun putFloat(key: String, value: Float) = unsupported() - override fun putBoolean(key: String, value: Boolean) = unsupported() - } -} - -private fun unsupported(): Nothing = throw UnsupportedOperationException() diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/CrashHandler.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/CrashHandler.kt deleted file mode 100644 index d2c84bf46..000000000 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/CrashHandler.kt +++ /dev/null @@ -1,36 +0,0 @@ -package com.darkrockstudios.apps.hammer.common - -import io.github.aakira.napier.Napier -import java.io.File - -/** - * Catch, log, and hand off any otherwise-unhandled exception. The async [FileLogger] can't be - * relied on to flush before the process dies, so we also write a synchronous crash dump straight - * to disk, then chain to the platform default handler so Android still terminates and reports. - */ -fun installGlobalExceptionHandler() { - val previous = Thread.getDefaultUncaughtExceptionHandler() - Thread.setDefaultUncaughtExceptionHandler { thread, throwable -> - runCatching { - Napier.e( - "Uncaught exception on thread '${thread.name}', terminating", - throwable - ) - } - runCatching { writeCrashDump(thread, throwable) } - previous?.uncaughtException(thread, throwable) - } -} - -/** Synchronous, self-contained crash record in the logs dir: the guaranteed artifact when the app dies. */ -private fun writeCrashDump(thread: Thread, throwable: Throwable) { - val dir = File(getConfigDirectory(), "logs") - dir.mkdirs() - File(dir, "crash-${System.currentTimeMillis()}.txt").writeText( - buildString { - append(startupBanner() + "\n") - append("Uncaught exception on thread '${thread.name}'\n\n") - append(throwable.stackTraceToString()) - } - ) -} diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt deleted file mode 100644 index d706a944f..000000000 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -actual val supportsInAppChangelog: Boolean = true diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStore.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStore.kt index 18407af83..bdfb5e2d9 100644 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStore.kt +++ b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/EncryptedSharedPrefsAuthTokenStore.kt @@ -9,46 +9,31 @@ import io.github.aakira.napier.Napier import kotlinx.atomicfu.locks.reentrantLock import kotlinx.atomicfu.locks.withLock import kotlinx.serialization.json.Json -import java.io.IOException -import java.security.GeneralSecurityException -import java.security.KeyStore /** * [AuthTokenStore] backed by [EncryptedSharedPreferences] with an Android * Keystore-backed master key. The account-keyed token map is stored as JSON in a * single encrypted preferences entry. */ -class EncryptedSharedPrefsAuthTokenStore internal constructor( +class EncryptedSharedPrefsAuthTokenStore( + context: Context, private val json: Json, - private val openPrefs: () -> SharedPreferences, - private val resetPrefs: () -> Unit, ) : AuthTokenStore { - constructor(context: Context, json: Json) : this( - json = json, - openPrefs = { openEncryptedPrefs(context) }, - resetPrefs = { resetEncryptedPrefs(context) }, - ) - private val lock = reentrantLock() private val prefs: SharedPreferences by lazy { - try { - openPrefs() - } catch (e: GeneralSecurityException) { - recreatePrefs(e) - } catch (e: IOException) { - recreatePrefs(e) - } - } + val masterKey = MasterKey.Builder(context) + .setKeyScheme(MasterKey.KeyScheme.AES256_GCM) + .build() - // The keyset lives in the prefs file but its master key lives in the Keystore, which is - // never backed up, so a restored or orphaned file is undecryptable, and some keystores - // leave the master key itself unusable. Start over with both (forces re-login). - private fun recreatePrefs(cause: Exception): SharedPreferences { - Napier.w("Auth token keyset is unreadable; recreating the store", cause) - resetPrefs() - return openPrefs() + EncryptedSharedPreferences.create( + context, + PREFS_NAME, + masterKey, + EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV, + EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM, + ) } override fun get(url: String, userId: Long): AuthTokens? = lock.withLock { @@ -69,11 +54,11 @@ class EncryptedSharedPrefsAuthTokenStore internal constructor( } private fun loadMap(): Map { + val stored = prefs.getString(TOKENS_KEY, null) ?: return emptyMap() return try { - val stored = prefs.getString(TOKENS_KEY, null) ?: return emptyMap() json.decodeFromString>(stored) } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.w("Failed to read encrypted auth tokens; treating as empty", e) + Napier.w("Failed to parse encrypted auth tokens; treating as empty", e) emptyMap() } } @@ -85,26 +70,5 @@ class EncryptedSharedPrefsAuthTokenStore internal constructor( companion object { private const val PREFS_NAME = "hammer_auth_tokens" private const val TOKENS_KEY = "tokens" - private const val ANDROID_KEYSTORE = "AndroidKeyStore" - - private fun openEncryptedPrefs(context: Context): SharedPreferences { - val masterKey = MasterKey.Builder(context) - .setKeyScheme(MasterKey.KeyScheme.AES256_GCM) - .build() - - return EncryptedSharedPreferences.create( - context, - PREFS_NAME, - masterKey, - EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV, - EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM, - ) - } - - private fun resetEncryptedPrefs(context: Context) { - context.deleteSharedPreferences(PREFS_NAME) - KeyStore.getInstance(ANDROID_KEYSTORE).apply { load(null) } - .deleteEntry(MasterKey.DEFAULT_MASTER_KEY_ALIAS) - } } } diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt index ac7891da1..130055b91 100644 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt +++ b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt @@ -1,8 +1,5 @@ package com.darkrockstudios.apps.hammer.common.dependencyinjection -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.appupdate.NoOpAppUpdater - import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AndroidPlatformSettingsComponent import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.PlatformSettings import com.darkrockstudios.apps.hammer.common.components.storyeditor.focusmode.FocusModeService @@ -22,7 +19,6 @@ actual val platformModule = module { single() single() bind StrRes::class single() - single() single() bind UrlLauncher::class single() factory { params -> @@ -39,5 +35,4 @@ actual val platformModule = module { single() single() single { get() } - single { NoOpAppUpdater } } \ No newline at end of file diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt deleted file mode 100644 index 648861890..000000000 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt +++ /dev/null @@ -1,11 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -actual class AvailableLocalesProvider { - actual fun allLocales(): List = - java.util.Locale.getAvailableLocales() - // Parse the full tag rather than language+country so script-distinct - // locales (zh-Hans vs zh-Hant) stay separate entries. - .map { Locale.forLanguageTag(it.toLanguageTag()) } - .filter { it.language != null } - .distinctBy { it.toLanguageTag() } -} diff --git a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt index 23b43987d..d73964c15 100644 --- a/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt +++ b/common/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt @@ -1,11 +1,7 @@ package com.darkrockstudios.apps.hammer.common.util -import kotlinx.datetime.LocalDateTime -import kotlinx.datetime.TimeZone -import kotlinx.datetime.toJavaLocalDateTime -import kotlinx.datetime.toLocalDateTime +import kotlinx.datetime.* import java.time.format.DateTimeFormatter -import kotlin.time.Instant actual fun Instant.formatLocal(format: String): String = toLocalDateTime(TimeZone.currentSystemDefault()).format(format) diff --git a/common/src/androidMain/res/xml/network_security_config.xml b/common/src/androidMain/res/xml/network_security_config.xml deleted file mode 100644 index a99f62af6..000000000 --- a/common/src/androidMain/res/xml/network_security_config.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/common/src/commonMain/composeResources/files/changelog.md b/common/src/commonMain/composeResources/files/changelog.md deleted file mode 100644 index 416bb9a40..000000000 --- a/common/src/commonMain/composeResources/files/changelog.md +++ /dev/null @@ -1,32 +0,0 @@ -## [3.12.0] - 2026-10-5 - -New features -- Reader Mode: read your story as prose, one chapter at a time, instead of through the scene editor. Open it from the Read button under the scene list, the book icon in the scene editor, or the editor menu. The scene list becomes a table of contents, and the reader has its own font size -- Export: three new options in the Export Story dialog. Number chapter titles, pick a font (Word, RTF and EPUB), and choose whether to keep blank lines between paragraphs -- Android and iOS: an OLED theme, the dark theme on a pure black background -- Desktop (Windows and Linux installs from GitHub): Hammer tells you when a newer release is out and can update itself from the project list or the About screen. macOS DMG installs are told and sent to the release page. Automatic checks can be turned off in Settings -- Text editor 3.0: Huge improvements in input and performance -- Text editor: change the text size with Ctrl/Cmd and Plus, Minus or 0, or from the format bar's overflow menu -- Text editor: Delete in the right-click menu -- Turkish translation -- Web: a fifth reader reaction on public stories, "Surprised me" - -Improvements -- Syncing with unsaved work now asks Save, Discard or Cancel first, where before it silently saved every unsaved scene -- Open notes, timeline events, encyclopedia entries and the scene title, outline and notes refresh when a sync or conflict resolution changes them. An edit in progress keeps its draft -- The Backup Manager lists backups of projects that are no longer on disk, so a deleted project can be restored -- Exports no longer number chapter titles unless you turn the new option on. Word, RTF, PDF and Markdown used to number them always -- Text editor: the heading button writes real Markdown headings, and Hammer's shortcuts land on the same keys on non-QWERTY layouts -- Android: a launch splash screen on every supported version -- Translations and dependencies updated - -Fixes -- Android: unsaved scene edits could be lost when the app was closed in the background. They now come back as unsaved scenes the next time the project opens [#983] -- Export: unsaved scene edits were left out of the exported file [#983] -- Restoring a backup from the Backup Manager made the project disappear from the project list -- Choosing Discard on close with automatic sync on still saved and uploaded the discarded scenes -- PDF export: long paragraphs ran off the bottom of the page or left large blank gaps -- Android: a crash on launch when the saved login could not be decrypted, for example after restoring the device from a backup. You are asked to sign in again -- iOS: a crash when tapping into a text editor -- Server URL, number, tag and word-list fields no longer autocorrect or capitalize, which put a space after each "." in a server URL -- Encyclopedia references no longer match a name inside a longer word with accented or non-Latin letters ("Ana" in "Anaïs") diff --git a/common/src/commonMain/composeResources/values-de/strings.xml b/common/src/commonMain/composeResources/values-de/strings.xml index 9660024ab..70265b756 100644 --- a/common/src/commonMain/composeResources/values-de/strings.xml +++ b/common/src/commonMain/composeResources/values-de/strings.xml @@ -22,7 +22,6 @@ Nein Erweitern Einklappen - Text size Textgröße verringern Textgröße vergrößern Textgröße zurücksetzen diff --git a/common/src/commonMain/composeResources/values-de/strings_about_app.xml b/common/src/commonMain/composeResources/values-de/strings_about_app.xml index 9fcafdc58..03970ec10 100644 --- a/common/src/commonMain/composeResources/values-de/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-de/strings_about_app.xml @@ -1,40 +1,26 @@ Ein einfaches Werkzeug zum Erstellen von Geschichten. - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. + Ein freies und quelloffenes Projekt. Community Discord Reddit Github Quellen Bibliotheken - Dark Rock Studios - Changes - GitHub Release - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - What's New + Version %s ist jetzt verfügbar + Aktualisiert! + Update anzeigen + Versionshinweise + Eine neue Version von Hammer ist verfügbar + Versionshinweise für %s Versionshinweise Keine Versionshinweise vorhanden. Release öffnen + Schließen Anwendungsprotokolle Protokollverzeichnis: Protokolle exportieren Keine Protokolldateien gefunden Protokollverzeichnis öffnen - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. diff --git a/common/src/commonMain/composeResources/values-de/strings_account_settings.xml b/common/src/commonMain/composeResources/values-de/strings_account_settings.xml index 2afd0484b..c98b12fb1 100644 --- a/common/src/commonMain/composeResources/values-de/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-de/strings_account_settings.xml @@ -9,7 +9,6 @@ Farbschema HELL DUNKEL - OLED SYSTEM Anfangsbildschirm des Projekts Startseite @@ -37,27 +36,15 @@ Bist du sicher, dass du diesen Server entfernen möchtest? Server einrichten Server-URL: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. E-Mail: user@example.com Passwort - %1$d-%2$d characters Passwort anzeigen Passwort verstecken Anmelden Erstellen Abbrechen - Merge existing projects with the server? - PROJECT DATA - Merge - Ersetzen - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + Lokalen Inhalt löschen? + Sollen wir deine aktuellen lokalen Inhalte vor der Synchronisierung entfernen? Falls nicht, werden wir versuchen, deine lokalen Inhalte mit den Serverinhalten zusammenzuführen. Wenn der Inhalt nicht miteinander kompatibel ist, kann es zu Problemen kommen. Plattform-Einstellungen Keine plattformspezifischen Einstellungen. Bildschirm nicht ausschalten @@ -74,8 +61,6 @@ Falls es Probleme verursacht, schalten Sie es einfach aus. Rechtschreibprüfung aktivieren Im Fokusmodus aktivieren - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Wörterbuch Sprache der Rechtschreibprüfung Unter Android wird die Sprache der Rechtschreibprüfung von Ihrem Gerät festgelegt, nicht von der App. Ändern Sie sie in den Android-Einstellungen über die System- und Tastatursprachen. @@ -86,7 +71,6 @@ Fehler beim Laden der Backups: %1$s Fehler beim Laden der Backups für das Projekt: %1$s Fehler beim Löschen der Backups: %1$s - Failed to restore backup: %1$s Backup wiederherstellen Warnung: Das Wiederherstellen dieses Backups ersetzt den aktuellen Inhalt des Projekts vollständig. Alle vorhandenen Dateien werden gelöscht und mit den Backup-Daten ersetzt. Diese Aktion kann nicht rückgängig gemacht werden. Wiederherstellen @@ -126,6 +110,4 @@ Der Server reagiert nicht. Überprüfen Sie Ihre Internetverbindung und versuchen Sie es erneut. Server nicht gefunden. Überprüfen Sie die Serveradresse und Ihre Internetverbindung. Netzwerkfehler beim Verbinden mit %1$s. Überprüfen Sie Ihre Verbindung und versuchen Sie es erneut. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values-de/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-de/strings_encyclopedia.xml index 0189cdffc..1e9f57b33 100644 --- a/common/src/commonMain/composeResources/values-de/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-de/strings_encyclopedia.xml @@ -30,12 +30,10 @@ Abbruch Eintrag erstellt Name des Eintrags ist zu lang. Max. %1$d - The entry name contains invalid characters + Der Name des Eintrags muss alphanumerisch sein Tag ist zu lang. Max. %1$d Alias ist zu lang. Max. %1$d Aliase - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled Alias hinzufügen Hinzufügen Spitzname oder anderer Name diff --git a/common/src/commonMain/composeResources/values-de/strings_project_home.xml b/common/src/commonMain/composeResources/values-de/strings_project_home.xml index 76f715526..f02f65c29 100644 --- a/common/src/commonMain/composeResources/values-de/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-de/strings_project_home.xml @@ -78,16 +78,6 @@ RTF (.rtf) Abbrechen Exportieren - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Szenen - %1$d of %2$d selected - Alle auswählen - Alle entfernen Mehr über Exportformate Ein Exportformat wählen Jedes Format eignet sich für einen anderen Zweck. Wählen Sie das, das zu Ihrer geplanten Verwendung der exportierten Geschichte passt. @@ -114,12 +104,7 @@ Kapitelgruppen erstellen Vorschau Nichts zu importieren - Reading your manuscript Erstellt %1$d Szene(n) - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W Abbrechen Importieren Einstellungen diff --git a/common/src/commonMain/composeResources/values-de/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-de/strings_project_navigation.xml index 20a758b15..f1bdfb3e9 100644 --- a/common/src/commonMain/composeResources/values-de/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-de/strings_project_navigation.xml @@ -4,7 +4,7 @@ Geschichte Notiz Lexikon - Zeitstrahl + Timeline STRT GESC NOTZ diff --git a/common/src/commonMain/composeResources/values-de/strings_projects_list.xml b/common/src/commonMain/composeResources/values-de/strings_projects_list.xml index f28d26f01..93ceda51c 100644 --- a/common/src/commonMain/composeResources/values-de/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-de/strings_projects_list.xml @@ -7,7 +7,6 @@ Projekt erstellen Projekte synchronisiert Fehler beim Synchronisieren der Projekte - Could not delete the project. Check that its folder is accessible and try again. Mehr %1$s Wörter von %1$s diff --git a/common/src/commonMain/composeResources/values-de/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-de/strings_reader_mode.xml deleted file mode 100644 index c4c0588e8..000000000 --- a/common/src/commonMain/composeResources/values-de/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Textgröße verringern - Textgröße vergrößern - Textgröße zurücksetzen - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-de/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-de/strings_scene_editor.xml index 6df2a0b94..6c1da3b68 100644 --- a/common/src/commonMain/composeResources/values-de/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-de/strings_scene_editor.xml @@ -24,8 +24,6 @@ Archivieren Speichern Schließen - Read - Add to dictionary Szene archivieren Möchten Sie '%1$s' wirklich archivieren? Die Szene wird aus der Szenenliste ausgeblendet, kann aber später wiederhergestellt werden. Archivieren diff --git a/common/src/commonMain/composeResources/values-de/strings_scene_list.xml b/common/src/commonMain/composeResources/values-de/strings_scene_list.xml index c640c8f1d..6983cd26a 100644 --- a/common/src/commonMain/composeResources/values-de/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-de/strings_scene_list.xml @@ -16,8 +16,7 @@ Erstellen Abbrechen Gliederung - Gliederung - Read + Gliederungsübersicht <keine Gliederung> Schließen Manuskript @@ -53,7 +52,6 @@ Verschieben Abbrechen %1$d · %2$d GR - %1$d SZN Neue Szene Neue Gruppe Hinzufügen diff --git a/common/src/commonMain/composeResources/values-de/strings_sync.xml b/common/src/commonMain/composeResources/values-de/strings_sync.xml index 25a04b501..40b6920ad 100644 --- a/common/src/commonMain/composeResources/values-de/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-de/strings_sync.xml @@ -34,13 +34,6 @@ Tags ↵ zum Hinzufügen Fantasy, Entwurf, NaNoWriMo… - Language - Not set - Choose a language - Schließen - Search languages - Clear (not set) - No languages match Bearbeiten Abbrechen OK @@ -51,12 +44,6 @@ von %1$s von (kein Autor festgelegt) Rechtschreibprüfung - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ zum Hinzufügen - Words the spell checker should accept in this project Projekteinstellungen · %1$s §§ %1$d Projekteinstellungen-Konflikt @@ -65,14 +52,9 @@ Projekt-Farbschema Wortzahlziel Tags - Language - Learn Encyclopedia Names (nicht festgelegt) - On - Off Tag Woche - Project dictionary words from both sides are kept. Auflösen Name: Typ: @@ -116,20 +98,15 @@ Projekt vom Server konnte nicht umbenannt werden: %1$s Projekt auf dem Server erstellt: %1$s Projekt konnte auf dem Server nicht erstellt werden: %1$s - Project created on server, but failed to save its ID locally: %1$s Lokales Projekt erstellt: %1$s Server-ID des lokalen Projekts wird gesetzt: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + Serverprojekt konnte nicht erstellt werden: %1$s Konto wird synchronisiert... Projekte werden synchronisiert... Projektsynchronisierung abgeschlossen Projekt wird synchronisiert: %1$s - No changes, skipped - Synchronisierung fehlgeschlagen: %1$s Im Projekt %1$s besteht ein Konflikt. Öffnen Sie dieses Projekt und synchronisieren Sie, um ihn aufzulösen. Client-Entitätsdaten berechnet - The server no longer has this project. It will be recreated the next time you sync. Serverdaten empfangen Client-Daten geladen Lokales Backup erstellt: %1$s @@ -193,8 +170,7 @@ Patreon Hammer.Ink Registrierung - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - + Standardmäßig ist die Registrierung auf Servern geschlossen, das heißt, Sie müssen zur Whitelist des jeweiligen Servers hinzugefügt werden, um ein Konto erstellen zu können. Einrichtung Geben Sie die URL des Servers ein, etwa "hammer.ink" für den offiziellen Server. Geben Sie Ihre E-Mail und Ihr Passwort ein und tippen Sie dann auf "Erstellen", um Ihr Konto zu erstellen. diff --git a/common/src/commonMain/composeResources/values-de/strings_timeline.xml b/common/src/commonMain/composeResources/values-de/strings_timeline.xml index d500f47fb..d95cade95 100644 --- a/common/src/commonMain/composeResources/values-de/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-de/strings_timeline.xml @@ -39,7 +39,7 @@ Löschen Ereignis löschen? Dies kann nicht rückgängig gemacht werden! - Zeitstrahl + Timeline %1$d EINTRÄGE · %2$d TAGS Zeitstrahl durchsuchen Zeitstrahl durchsuchen diff --git a/common/src/commonMain/composeResources/values-es/strings.xml b/common/src/commonMain/composeResources/values-es/strings.xml index 95f8b1a33..fe6cbaf0f 100644 --- a/common/src/commonMain/composeResources/values-es/strings.xml +++ b/common/src/commonMain/composeResources/values-es/strings.xml @@ -22,7 +22,6 @@ No Expandir Contraer - Text size Reducir el tamaño del texto Aumentar el tamaño del texto Restablecer el tamaño del texto diff --git a/common/src/commonMain/composeResources/values-es/strings_about_app.xml b/common/src/commonMain/composeResources/values-es/strings_about_app.xml index 7ad3757c2..fd2c6ed65 100644 --- a/common/src/commonMain/composeResources/values-es/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-es/strings_about_app.xml @@ -1,40 +1,26 @@ Una herramienta sencilla para crear historias. - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. + Un proyecto gratuito y de código abierto. Comunidad Discord Reddit Github Atribución Bibliotecas - Dark Rock Studios - Changes - GitHub Release - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - What's New + La versión %s ya está disponible + ¡Actualizado! + Ver actualización + Notas de la versión + Hay una nueva versión de Hammer disponible + Notas de la versión %s Notas de la versión No se proporcionaron notas de la versión. Abrir versión + Descartar Registros de la aplicación Carpeta de registros: Exportar registros No se encontraron archivos de registro Abrir carpeta de registros - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. diff --git a/common/src/commonMain/composeResources/values-es/strings_account_settings.xml b/common/src/commonMain/composeResources/values-es/strings_account_settings.xml index ada703829..39d9b7fe0 100644 --- a/common/src/commonMain/composeResources/values-es/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-es/strings_account_settings.xml @@ -9,7 +9,6 @@ Tema de la interfaz CLARO OSCURO - OLED SISTEMA Pantalla inicial del proyecto Inicio @@ -37,27 +36,15 @@ ¿Seguro que quieres quitar el servidor? Configurar servidor URL del servidor: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. Correo: user@example.com Contraseña - %1$d-%2$d characters Mostrar contraseña Ocultar contraseña Iniciar sesión Crear Cancelar - Merge existing projects with the server? - PROJECT DATA - Merge - Reemplazar - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + ¿Quitar el contenido local? + ¿Debemos quitar tu contenido local actual antes de sincronizar? Si no, intentaremos combinar tu contenido local con el del servidor. Si el contenido no está relacionado, podría causar problemas. Ajustes de la plataforma No hay ajustes específicos de la plataforma. Mantener la pantalla encendida @@ -74,8 +61,6 @@ Si causa problemas, simplemente desactívala. Activar la corrección ortográfica Activar en el modo concentración - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Diccionario Idioma de la corrección ortográfica En Android, el idioma de la corrección ortográfica lo elige tu dispositivo, no la aplicación. Para cambiarlo, actualiza los idiomas del sistema y del teclado en los ajustes de Android. @@ -86,7 +71,6 @@ No se pudieron cargar las copias de seguridad: %1$s No se pudieron cargar las copias de seguridad del proyecto: %1$s No se pudo eliminar la copia de seguridad: %1$s - Failed to restore backup: %1$s Restaurar copia de seguridad Advertencia: restaurar esta copia de seguridad reemplazará por completo el contenido actual del proyecto. Todos los archivos existentes se eliminarán y se reemplazarán con los datos de la copia de seguridad. Esta acción no se puede deshacer. Restaurar @@ -126,6 +110,4 @@ El servidor no responde. Comprueba tu conexión a internet e inténtalo de nuevo. Servidor no encontrado. Comprueba la dirección del servidor y tu conexión a internet. Error de red al conectar con %1$s. Comprueba tu conexión e inténtalo de nuevo. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values-es/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-es/strings_encyclopedia.xml index a1ddf04d0..d68addf6f 100644 --- a/common/src/commonMain/composeResources/values-es/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-es/strings_encyclopedia.xml @@ -30,12 +30,10 @@ Cancelar Entrada creada El nombre de la entrada era demasiado largo. Máx. %1$d - The entry name contains invalid characters + El nombre de la entrada debe ser alfanumérico La etiqueta es demasiado larga. Máx. %1$d El alias es demasiado largo. Máx. %1$d Alias - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled Añadir alias Añadir Apodo u otro nombre diff --git a/common/src/commonMain/composeResources/values-es/strings_project_home.xml b/common/src/commonMain/composeResources/values-es/strings_project_home.xml index 23a789b00..9bfeca1e8 100644 --- a/common/src/commonMain/composeResources/values-es/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-es/strings_project_home.xml @@ -78,16 +78,6 @@ RTF (.rtf) Cancelar Exportar - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Escenas - %1$d of %2$d selected - Seleccionar todo - Borrar todo Más información sobre los formatos de exportación Elegir un formato de exportación Cada formato sirve para un propósito diferente. Elige el que se ajuste a cómo planeas usar la historia exportada. @@ -114,12 +104,7 @@ Crear grupos de capítulos Vista previa Nada que importar - Reading your manuscript Creará %1$d escena(s) - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W Cancelar Importar Ajustes diff --git a/common/src/commonMain/composeResources/values-es/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-es/strings_project_navigation.xml index 348c43edb..ee9f255e2 100644 --- a/common/src/commonMain/composeResources/values-es/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-es/strings_project_navigation.xml @@ -4,7 +4,7 @@ Historia Notas Enciclopedia - Cronología + Timeline INIC HIST NOTA diff --git a/common/src/commonMain/composeResources/values-es/strings_projects_list.xml b/common/src/commonMain/composeResources/values-es/strings_projects_list.xml index 47e053825..1d44f6a2a 100644 --- a/common/src/commonMain/composeResources/values-es/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-es/strings_projects_list.xml @@ -7,7 +7,6 @@ Crear proyecto Proyectos sincronizados No se pudieron sincronizar los proyectos - Could not delete the project. Check that its folder is accessible and try again. Más %1$s palabras por %1$s diff --git a/common/src/commonMain/composeResources/values-es/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-es/strings_reader_mode.xml deleted file mode 100644 index 9e2de7738..000000000 --- a/common/src/commonMain/composeResources/values-es/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Reducir el tamaño del texto - Aumentar el tamaño del texto - Restablecer el tamaño del texto - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-es/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-es/strings_scene_editor.xml index 0412e7a76..cfffa8700 100644 --- a/common/src/commonMain/composeResources/values-es/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-es/strings_scene_editor.xml @@ -24,8 +24,6 @@ Archivar Guardar Cerrar - Read - Add to dictionary Archivar escena ¿Seguro que quieres archivar «%1$s»? La escena se ocultará de la lista de escenas, pero podrás restaurarla más tarde. Archivar diff --git a/common/src/commonMain/composeResources/values-es/strings_scene_list.xml b/common/src/commonMain/composeResources/values-es/strings_scene_list.xml index 0b13c235c..0e72d0b80 100644 --- a/common/src/commonMain/composeResources/values-es/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-es/strings_scene_list.xml @@ -16,8 +16,7 @@ Crear Cancelar Esquema de la historia - Esquema - Read + Vista del esquema <sin esquema> Descartar Manuscrito @@ -53,7 +52,6 @@ Mover Cancelar %1$d · %2$d GR - %1$d ESC Nueva escena Nuevo grupo Añadir diff --git a/common/src/commonMain/composeResources/values-es/strings_sync.xml b/common/src/commonMain/composeResources/values-es/strings_sync.xml index ae0a6cf3e..a57676194 100644 --- a/common/src/commonMain/composeResources/values-es/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-es/strings_sync.xml @@ -34,13 +34,6 @@ Etiquetas ↵ para añadir fantasía, borrador, nanowrimo… - Language - Not set - Choose a language - Cerrar - Search languages - Clear (not set) - No languages match Editar Cancelar OK @@ -51,12 +44,6 @@ por %1$s por (sin autor definido) Corrección ortográfica - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ para añadir - Words the spell checker should accept in this project Ajustes del proyecto · %1$s §§ %1$d Conflicto de ajustes del proyecto @@ -65,14 +52,9 @@ Tema del proyecto Meta de recuento de palabras Etiquetas - Language - Learn Encyclopedia Names (sin definir) - On - Off día semana - Project dictionary words from both sides are kept. Resolver Nombre: Tipo: @@ -116,20 +98,15 @@ No se pudo renombrar el proyecto desde el servidor: %1$s Proyecto creado en el servidor: %1$s No se pudo crear el proyecto en el servidor: %1$s - Project created on server, but failed to save its ID locally: %1$s Proyecto local creado: %1$s Estableciendo el ID de servidor del proyecto local: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + No se pudo crear el proyecto en el servidor: %1$s Sincronizando la cuenta… Sincronizando los proyectos… Sincronización de proyectos completada Sincronizando el proyecto: %1$s - No changes, skipped - La sincronización falló: %1$s Hay un conflicto en el proyecto: %1$s. Abre ese proyecto y sincroniza para resolverlo. Datos de entidades del cliente calculados - The server no longer has this project. It will be recreated the next time you sync. Datos del servidor recibidos Datos del cliente cargados Copia de seguridad local creada: %1$s @@ -193,8 +170,7 @@ Patreon Hammer.Ink Registro - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - + De forma predeterminada, los servidores tienen el registro cerrado, lo que significa que debes ser añadido a la lista blanca del servidor para poder crear una cuenta. Configuración Introduce la URL del servidor, como «hammer.ink» para el servidor oficial. Introduce tu correo y contraseña, luego pulsa «Crear» para crear tu cuenta. diff --git a/common/src/commonMain/composeResources/values-es/strings_timeline.xml b/common/src/commonMain/composeResources/values-es/strings_timeline.xml index fcbd9a5f8..e94f4073c 100644 --- a/common/src/commonMain/composeResources/values-es/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-es/strings_timeline.xml @@ -39,7 +39,7 @@ Eliminar ¿Eliminar el evento de cronología? ¡Esta acción no se puede deshacer! - Cronología + Timeline %1$d ENTRADAS · %2$d ETIQUETAS Buscar en la cronología Buscar en la cronología diff --git a/common/src/commonMain/composeResources/values-fr/strings.xml b/common/src/commonMain/composeResources/values-fr/strings.xml index abb9b31e7..5ca9b4285 100644 --- a/common/src/commonMain/composeResources/values-fr/strings.xml +++ b/common/src/commonMain/composeResources/values-fr/strings.xml @@ -1,7 +1,7 @@ Hammer - Scènes enregistrées + Toutes les scènes enregistrées Scènes non enregistrées Que faire des scènes non enregistrées ? Entrée d'encyclopédie non enregistrée @@ -22,20 +22,19 @@ Non Développer Réduire - Taille du texte Réduire la taille du texte Augmenter la taille du texte Réinitialiser la taille du texte Rechercher et remplacer Gras Italique - Barrer - En-tête + Barré + Titre Citation Liste à puces Liste numérotée - Règle horizontale + Ligne horizontale Annuler Rétablir - ECHAP annuler + ESC annuler diff --git a/common/src/commonMain/composeResources/values-fr/strings_about_app.xml b/common/src/commonMain/composeResources/values-fr/strings_about_app.xml index 474b77d32..1786dd156 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_about_app.xml @@ -1,40 +1,26 @@ - Un outil pour rédiger des histoires. - Studio - Hammer a été créé par Dark Rock Studios, aux côtés d'autres applications open source et respectueuse de votre vie privée. + Un outil simple pour construire des histoires. + Un projet libre et open source. Communauté Discord Reddit GitHub Attribution Bibliothèques - Dark Rock Studios - Changements - Version GitHub - Vérifier les mises à jour - Recherche de mises à jour… - Hammer est à jour. - Hammer %1$s est disponible. - Mettre à jour ver %1$s - Télécharger Hammer %1$s (%2$s) - Installation de Hammer %1$s. Hammer va redémarrer. - Impossible de mettre à jour vers la %1$s: %2$s - Réessayer - Plus tard - Hammer va se fermer pour installer la mise à jour, puis se rouvrira. - Nouveautés + La version %s est désormais disponible + À jour ! + Voir la mise-à jour + Notes de version + Une nouvelle version de Hammer est disponible + Notes de version pour %s Notes de version - Aucune note de version publiée. + Aucune note de version fournie. Ouvrir la version + Ignorer Journaux de l'application Dossier des journaux : Exporter les journaux Aucun fichier journal trouvé Ouvrir le dossier des journaux - Journeaux exportés. - Impossible d'exporter les journeaux. Voir le répertoire des journeaux. - Copier les diagnostics - Les diagnostics ont été copier dans le presse-papiers. - Impossible de copier les diagnostics. diff --git a/common/src/commonMain/composeResources/values-fr/strings_account_settings.xml b/common/src/commonMain/composeResources/values-fr/strings_account_settings.xml index 075385b0a..5d787622d 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_account_settings.xml @@ -4,23 +4,22 @@ INSTALLATION LOCALE PARAMÈTRES DU COMPTE Sauvegardes - Ce système de sauvegarde est destiné à protéger contre la perte et la corruption des données. Il n'est PAS conçu pour conserver d'anciennes versions de vos histoires. Utilisez le système de brouillons pour conserver vos données + Ce système de sauvegarde est destiné à protéger contre la perte et la corruption des données. Il n'est PAS conçu pour conserver d'anciennes versions de vos histoires. Utilisez le système de brouillons pour cela. Gérer les sauvegardes Thème de l'interface CLAIR SOMBRE - OLED SYSTÈME Écran initial du projet Accueil Éditeur de scène Dossier des projets - Définissez le dossier que Hammer utilisera pour stocker les données de vos projets. - Sélectionnez un dossier - Projet de démonstration - Installez un projet de démonstration pour voir comment les différentes fonctionnalités sont utilisées + Définissez le dossier que Hammer utilisera pour stocker les données des projets. + Choisir un dossier + Projet d'exemple + Installez un projet d'exemple pour voir comment les différentes fonctionnalités sont utilisées. Réinstaller - Projet de démonstration créé. + Projet d'exemple créé. CONNECTÉ NON CONNECTÉ URL @@ -29,7 +28,7 @@ Configurer Synchronisation automatique Sauvegarder lors de la synchronisation - Fermer les dialogues de synchronisation en cas de succès + Fermer les boîtes de synchronisation en cas de succès Sauvegardes max par projet Doit être compris entre 1 et %1$d Supprimer le serveur @@ -37,27 +36,15 @@ Voulez-vous vraiment supprimer le serveur ? Configurer le serveur URL du serveur : hammer.ink - HTTP en clair : votre email, mot de passe et vos écrits non chiffrés. Utilisez cela uniquement sur un réseau de confiance. - E-mail : utilisateur@exemple.com + E-mail : user@example.com Mot de passe - %1$d-%2$d personnages Afficher le mot de passe Masquer le mot de passe Se connecter Créer Annuler - Fusionner les projets existants avec le serveur ? - DONNÉES DU PROJET - Fusionner - Remplacer - Hammer fera correspondre vos projets locaux aux projets déjà présents sur le serveur. Les projets qui n'existent que sur le serveur seront téléchargés, et les projets présents en local seront téléversés sur le serveur. - Tous vos projets locaux seront supprimés et remplacés par ceux présents sur le serveur. - Continuer - Supprimer tous les projets locaux ? - Cela supprime de façon permanente tous les projets de cet appareil et les remplacera avec les projets présents sur le serveur. Cette action ne peut pas être annulé. - Supprimer et remplacer - Vérifier automatiquement les mises à jour - Recherche les nouvelles versions sur GitHub peu après le lancement et toutes les heures. Rien n'est téléchargé ou installé sans votre intervention. + Supprimer le contenu local ? + Devons-nous supprimer votre contenu local actuel avant la synchronisation ? Sinon, nous tenterons de fusionner votre contenu local avec celui du serveur. Si les contenus n'ont aucun rapport, cela pourrait causer des problèmes. Paramètres de la plateforme Aucun paramètre spécifique à la plateforme. Garder l'écran allumé @@ -74,8 +61,6 @@ Si cela pose problème, désactivez-la simplement. Activer la correction orthographique Activer en mode concentration - Apprendre les noms de l'encyclopédie - Les noms d'entrés et les alias ne seront pas marqués comme mal orthographiés pendant que leur projet est ouvert Dictionnaire Langue de correction orthographique Sur Android, la langue de correction orthographique est choisie par votre appareil, pas par l'application. Pour la modifier, changez les langues de votre système et de votre clavier dans les paramètres Android. @@ -86,7 +71,6 @@ Échec du chargement des sauvegardes : %1$s Échec du chargement des sauvegardes du projet : %1$s Échec de la suppression de la sauvegarde : %1$s - Échec de la suppression de la sauvegarde : %1$s Restaurer la sauvegarde Avertissement : la restauration de cette sauvegarde remplacera entièrement le contenu actuel du projet. Tous les fichiers existants seront supprimés et remplacés par les données de la sauvegarde. Cette action est irréversible. Restaurer @@ -96,7 +80,7 @@ Sélectionnez un projet Aucune sauvegarde pour ce projet Restaurer - Supprimer la sauvegarde + Delete backup Afficher dans le dossier Exporter Annuler la synchronisation ? @@ -126,6 +110,4 @@ Le serveur ne répond pas. Vérifiez votre connexion Internet et réessayez. Serveur introuvable. Vérifiez l'adresse du serveur et votre connexion Internet. Erreur réseau lors de la connexion à %1$s. Vérifiez votre connexion et réessayez. - Impossible d'établir une connection sécurisée à %1$s. Hammer se connecte uniquement via HTTPS, le serveur a besoin de son propre certificat TLS ou d'un proxy inverse qui lui en fournit un - Hammer ne peut pas établir une connexion réseau sur cet appareil, la requête ne peut donc pas atteindre le serveur. Un système de sécurité, un VPN ou un pare-feu peuvent être la source du problème. diff --git a/common/src/commonMain/composeResources/values-fr/strings_desktop.xml b/common/src/commonMain/composeResources/values-fr/strings_desktop.xml index 0975f195a..444000e0b 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_desktop.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_desktop.xml @@ -8,9 +8,11 @@ Projets récents Bienvenue dans Hammer - Hammer range vos projets à l'intérieur du dossier que vous avez défini, vos écrits restes entre vos mains.\n\nSur le prochain écran, sélectionnez un dossier de projet Hammer existant ou créez en un nouveau. Vous pourrez effectuer des modifications plus tard dans les Paramètres de l'application. + Hammer stores your projects in a folder you choose, so your writing stays in + your hands.\n\nOn the next screen, pick an existing hammer projects folder or create a new one. You can change + this later in Settings. Choisissez où stocker vos projets Hammer Choisir un dossier Quitter - Hammer a besoin d'un dossier pour ranger vos projets.\nChoisissez un dossier maintenant, ou quittez l'application + Hammer needs a folder to store your projects.\nChoose a folder now, or quit. diff --git a/common/src/commonMain/composeResources/values-fr/strings_drafts.xml b/common/src/commonMain/composeResources/values-fr/strings_drafts.xml index fc3ef0c86..10edb294b 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_drafts.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_drafts.xml @@ -2,10 +2,10 @@ Fusionner avec l'actuel Copiez ici des parties du brouillon - Fusionner + Prendre la fusion Brouillon : %1$s - Copiez les parties voulues dans le brouillon actuel, ou accepter tout cela. - Prendre tout le brouillon + Copiez les parties voulues dans l'actuel, ou acceptez tout ceci. + Prendre tout ce brouillon Brouillon Actuel Brouillons de %1$s : diff --git a/common/src/commonMain/composeResources/values-fr/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-fr/strings_encyclopedia.xml index feec43cb9..703f838f2 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_encyclopedia.xml @@ -9,39 +9,37 @@ Événement Idée Aucune entrée trouvée - Créer une Entrée + Créer une entrée Créer une entrée Nouveau Brouillon Nom p. ex. Chat du Cheshire - Étiquettes - ↵ ajouter + Tags + ↵ pour ajouter rituel, magique, récurrent… Description Illustration Déposez une image · ou Parcourir les fichiers - 1 pièce jointe + 1 jointe Remplacer L'image est trop volumineuse. La taille maximale est de %1$d Mo. Impossible de lire l'image sélectionnée. Créer une entrée Annuler Entrée créée - Le nom de l'entrée est trop longue. Max %1$d - Le nom de l'entrée contient des caractères invalides - L'Étiquette est trop longue. Max %1$d + Le nom de l'entrée était trop long. Max %1$d + Le nom de l'entrée doit être alphanumérique + Le tag est trop long. Max %1$d L'alias est trop long. Max %1$d Alias - Ajouter dans le correcteur orthographique - Le nom de cette entrée et les alias ne seront pas marqués comme mal orthographiés Ajouter un alias Ajouter Surnom ou autre nom Apparaît dans les scènes - Encore référencé dans aucune scène - Le nom d'entrée ne peut pas être vide + Pas encore référencé dans aucune scène + Entry name cannot be empty Abandonner la nouvelle entrée ? Erreur : échec du chargement de l'entrée ! Cliquez pour saisir une description @@ -67,11 +65,11 @@ Modifier Détails Type - Étiquettes + Tags Alias Scènes - Étiquettes - étiquette + Tags + tag alias Fig. I · Entrée Fig. I diff --git a/common/src/commonMain/composeResources/values-fr/strings_globalsearch.xml b/common/src/commonMain/composeResources/values-fr/strings_globalsearch.xml index 137d563ed..a65b65ab6 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_globalsearch.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_globalsearch.xml @@ -2,7 +2,7 @@ Rechercher dans le projet Rechercher dans le projet - Saisissez pour rechercher, utilisez #étiquette pour filtrer… + Saisissez pour rechercher, utilisez #tag pour filtrer… Effacer la recherche Aucun résultat Saisissez au moins 2 caractères pour rechercher diff --git a/common/src/commonMain/composeResources/values-fr/strings_ideas.xml b/common/src/commonMain/composeResources/values-fr/strings_ideas.xml index b5ce4668f..aa1d844e3 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_ideas.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_ideas.xml @@ -1,18 +1,18 @@ - Mes idées + Idées d'histoire IDÉE - Mes idées - %1$d IDÉES · %2$d ÉTIQUETTES - Vous n'avez déposé aucune de vos idées pour le moment. Une petite étincelle peut être le début de toutes choses. + Idées d'histoire + %1$d IDÉES · %2$d TAGS + Aucune idée d'histoire pour l'instant. Capturez votre première étincelle. Aucune idée archivée. %1$d M - %1$d Étiquettes - Rechercher mes idées - Rechercher mes idées + %1$d TAGS + Rechercher des idées + Rechercher des idées Effacer la recherche Fermer la recherche - Tous + Toutes Archivées FILTRÉ %1$d / %2$d Tout effacer @@ -30,14 +30,14 @@ Idée d'histoire Modification NON ENREGISTRÉ - MES IDÉES + IDÉES D'HISTOIRE Fermer l'idée Modifier Titre Titre facultatif - Étiquettes - Entrée ou virgule ajoute une étiquette - Ajouter une étiquette… + Tags + Entrée ou virgule ajoute un tag + Ajouter un tag… %1$d / %2$d C Créer Enregistrer @@ -78,6 +78,6 @@ Conflit laissé non résolu pour l'idée : %1$s Conflit d'idée d'histoire Titre - Étiquettes + Tags Contenu diff --git a/common/src/commonMain/composeResources/values-fr/strings_notes.xml b/common/src/commonMain/composeResources/values-fr/strings_notes.xml index 7e8b2c8a6..0a06b8acd 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_notes.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_notes.xml @@ -12,15 +12,15 @@ Créer Annuler Note créée - La note est trop longue - La note est vide - L'étiquette est trop longue (max %1$d) - Étiquettes - ↵ ajouter + La note était trop longue + La note était vide + Le tag était trop long (max %1$d) + Tags + ↵ pour ajouter idée, à faire, suivi… Supprimer la note ? Cette action est irréversible ! - Note Supprimée + Note Deleted Note Supprimer Note @@ -31,12 +31,12 @@ Enregistrer NON ENREGISTRÉ %1$d M · %2$d C - ECHAP POUR ANNULER + ESC POUR ANNULER Rechercher des notes Rechercher des notes Fermer la recherche Effacer la recherche - %1$d NOTES · %2$d ÉTIQUETTES + %1$d NOTES · %2$d TAGS %1$d M TOUT FILTRÉ · %1$d SUR %2$d diff --git a/common/src/commonMain/composeResources/values-fr/strings_project_home.xml b/common/src/commonMain/composeResources/values-fr/strings_project_home.xml index 5a50aadc0..d8b89d89b 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_project_home.xml @@ -1,7 +1,7 @@ Créé : %1$s - Calcul des statistiques... + Calcul des statistiques… Actualiser les statistiques Les statistiques peuvent être obsolètes Scènes @@ -10,7 +10,7 @@ Mots par chapitre Chapitre %1$s : %2$s mots - Mots moyens / scène + Mots moy. / scène Notes Événements de chronologie Scène la plus longue @@ -26,7 +26,7 @@ aucun changement vs semaine dernière aucune donnée la semaine dernière Aujourd'hui - Moy. quot. + Moy. quotidienne Série %1$d jours Plus longue : %1$d @@ -54,7 +54,7 @@ %1$d des 4 types Distribution Affichage de %1$d sur %2$d - Rang · Étiquette · Portée · Utilisations + Rang · Tag · Portée · Utilisations Scènes Notes Encyclopédie @@ -78,16 +78,6 @@ RTF (.rtf) Annuler Exporter - Nombre de titres de chapitre - Police - Conserver les lignes vides entre les paragraphes - Désactivez si vous séparez les paragraphes avec une ligne vide et ne voulez pas de paragraphes vides dans l'export. Les pauses de scène et les exécutions de deux ou plusieurs lignes vierges sont conservées. - Limiter aux scènes spécifiques - Seules les scènes sélectionnées seront incluse dans l'export - Scènes - %1$d sur %2$d sélectionnés - Tout sélectionner - Tout effacer En savoir plus sur les formats d'exportation Choisir un format d'exportation Chaque format répond à un besoin différent. Choisissez celui qui correspond à l'usage que vous ferez de l'histoire exportée. @@ -114,12 +104,7 @@ Créer des groupes de chapitres Aperçu Rien à importer - Lecture de votre manuscrit Créera %1$d scène(s) - Scène large - Une scène contient %1$s mots, donc la détection de chapitre a probablement manqué les titres de votre chapitre. Essayez un autre paramètre de détection - Les scènes %1$d contiennent des mots %2$s ou plus, donc la détection de chapitre a probablement manqué certains titres de chapitre. Essayez un autre paramètre de détection - %1$s S Annuler Importer Paramètres diff --git a/common/src/commonMain/composeResources/values-fr/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-fr/strings_project_navigation.xml index 2fd36bf67..b5655fde9 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_project_navigation.xml @@ -4,7 +4,7 @@ Histoire Notes Encyclopédie - Chronologie + Timeline ACCU HIST NOTE diff --git a/common/src/commonMain/composeResources/values-fr/strings_projects_list.xml b/common/src/commonMain/composeResources/values-fr/strings_projects_list.xml index cd74dd754..c45d89793 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_projects_list.xml @@ -7,7 +7,6 @@ Créer un projet Projets synchronisés Échec de la synchronisation des projets - Could not delete the project. Check that its folder is accessible and try again. Plus %1$s mots par %1$s @@ -15,7 +14,7 @@ Projet %1$s Rechercher des projets Fermer la recherche - filtrer par nom ou #étiquette + filtrer par nom ou #tag Effacer le filtre Aucun projet ne correspond à votre filtre Hammer · Bibliothèque diff --git a/common/src/commonMain/composeResources/values-fr/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-fr/strings_reader_mode.xml deleted file mode 100644 index a0eb81b31..000000000 --- a/common/src/commonMain/composeResources/values-fr/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Lecteur - Chapitre %1$d sur %2$d - Modifier - × Fermer - Réduire la taille du texte - Augmenter la taille du texte - Réinitialiser la taille du texte - Afficher les en-têtes de scène - ← Chapitre précédent - Chapitre suivant → - Ce chapitre n'a pas encore de scène - Il n'y a rien à lire pour le moment - Fin de l'histoire - diff --git a/common/src/commonMain/composeResources/values-fr/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-fr/strings_scene_editor.xml index da2c69aea..487a30dc6 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_scene_editor.xml @@ -24,8 +24,6 @@ Archiver Enregistrer Fermer - Lire - Ajouter au dictionnaire Archiver la scène Voulez-vous vraiment archiver « %1$s » ? La scène sera masquée de la liste des scènes mais pourra être restaurée plus tard. Archiver @@ -40,7 +38,7 @@ « %1$s » a été restaurée « %1$s » a été archivée Voir les archives - Mode Focus + Mode concentration Métadonnées Masquer les infos Mots : @@ -73,11 +71,11 @@ Rechercher des entrées… Aucune entrée correspondante. Fermer la boîte de dialogue - Étiquettes + Tags Aucun tag pour l'instant + Ajouter un tag Ajouter des tags - étiquette1 étiquette2 … + tag1 tag2 … Terminé Sélectionnez une scène à modifier Nouveau brouillon diff --git a/common/src/commonMain/composeResources/values-fr/strings_scene_list.xml b/common/src/commonMain/composeResources/values-fr/strings_scene_list.xml index 03641839f..a688e16f3 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_scene_list.xml @@ -16,8 +16,7 @@ Créer Annuler Plan de l'histoire - Plan - Lire + Aperçu du plan <aucun plan> Ignorer Manuscrit @@ -46,14 +45,13 @@ Déplacer vers Destination Rechercher des groupes - Niveau Haut + Niveau supérieur Aucun groupe correspondant Position (1–%1$d) Saisissez une position entre 1 et %1$d Déplacer Annuler %1$d · %2$d GR - %1$d SCN Nouvelle scène Nouveau groupe Ajouter diff --git a/common/src/commonMain/composeResources/values-fr/strings_sync.xml b/common/src/commonMain/composeResources/values-fr/strings_sync.xml index 12191b9ff..11fde1fed 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_sync.xml @@ -15,7 +15,7 @@ Entrée d'encyclopédie Brouillon de scène Paramètres du projet - Vous pouvez prendre la copie locale ou distante telle quelle, ou fusionner les deux manuellement en copiant des parties de la version distante dans votre copie locale + Vous pouvez prendre la copie locale ou distante telle quelle, ou fusionner les deux manuellement en copiant des parties de la version distante dans votre copie locale, puis en la retenant. Conflit d'entrée d'encyclopédie Auteur Thème personnalisé @@ -30,17 +30,10 @@ Semaine Effectif M / jour - Étiquettes - Étiquettes - ↵ ajouter - fantaisie, brouillon, nanowrimo… - Langue - Non défini - Choisir une langue - Fermer - Choisir une langue - Effacer (non défini) - Aucune langue ne correspond + Tags + Tags + ↵ pour ajouter + fantasy, brouillon, nanowrimo… Modifier Annuler OK @@ -51,12 +44,6 @@ par %1$s par (aucun auteur défini) Correction orthographique - La vérification orthographique est désactivée : la langue du projet (%1$s) ne correspond pas à votre dictionnaire (%2$s). Changez là pour la réactiver. - Apprendre les noms du dictionnaire dans ce projet - Désactivez pour garder les noms d'entrés en dehors du dictionnaire de vérification orthographique - Dictionnaire du projet - ↵ ajouter - Les mots que le correcteur orthographique devrait accepter dans ce projet Paramètres du projet · %1$s §§ %1$d Conflit de paramètres du projet @@ -64,15 +51,10 @@ Nom de l'auteur Thème du projet Objectif de nombre de mots - Étiquettes - Langue - Apprendre les noms de l'encyclopédie + Tags (non défini) - Activer - Désactiver jour semaine - Les mots du dictionnaire des deux parties sont conservés. Résoudre Nom : Type : @@ -116,20 +98,15 @@ Échec du renommage du projet depuis le serveur : %1$s Projet créé sur le serveur : %1$s Échec de la création du projet sur le serveur : %1$s - Projet a été créé sur le serveur, mais n'a pas pu sauvegarder son ID localement : %1$s Projet local créé : %1$s Définition de l'ID serveur du projet local : %1$s - Impossible de créer un projet local depuis le serveur : %1$s - Projet du serveur %1$s ignoré : un projet local possédant ce nom est déjà synchronisé depuis un autre serveur + Échec de la création du projet serveur : %1$s Synchronisation du compte… Synchronisation des projets… Synchronisation des projets terminée Synchronisation du projet : %1$s - Pas de modification, ignorée - Échec de la synchronisation : %1$s Il y a un conflit dans le projet : %1$s. Ouvrez ce projet et synchronisez pour le résoudre. Données d'entité client calculées - Le serveur n'a plus ce projet. Il sera recréé lors de la prochaine synchronisation. Données du serveur reçues Données client chargées Sauvegarde locale effectuée : %1$s @@ -193,7 +170,7 @@ Patreon Hammer.Ink Inscription - Les serveurs ont fermé leur inscription, ce qui signifie que l'administrateur du serveur doit vous ajouter à la liste des utilisateurs autorisés avant que vous ne puissiez créer un compte. + Par défaut, l'inscription aux serveurs est fermée : vous devez être ajouté à la liste blanche du serveur pour pouvoir créer un compte. Configuration Saisissez l'URL du serveur, par exemple « hammer.ink » pour le serveur officiel. Saisissez votre e-mail et votre mot de passe, puis appuyez sur « Créer » pour créer votre compte. diff --git a/common/src/commonMain/composeResources/values-fr/strings_timeline.xml b/common/src/commonMain/composeResources/values-fr/strings_timeline.xml index 287487903..d73cc4242 100644 --- a/common/src/commonMain/composeResources/values-fr/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-fr/strings_timeline.xml @@ -4,7 +4,7 @@ Créer un événement Événement créé Le tag était trop long (max %1$d) - Étiquettes + Tags ↵ pour ajouter arc, préfiguration, conflit… Événement @@ -22,7 +22,7 @@ %1$d M · %2$d C ESC POUR ANNULER %1$d M - %1$d ÉTIQUETTES + %1$d TAGS Enregistré Échec de l'enregistrement Créer un événement @@ -39,7 +39,7 @@ Supprimer Supprimer l'événement de chronologie ? Cette action est irréversible ! - Chronologie + Timeline %1$d ENTRÉES · %2$d TAGS Rechercher dans la chronologie Rechercher dans la chronologie diff --git a/common/src/commonMain/composeResources/values-it/strings.xml b/common/src/commonMain/composeResources/values-it/strings.xml index ae4b4e979..41774cb33 100644 --- a/common/src/commonMain/composeResources/values-it/strings.xml +++ b/common/src/commonMain/composeResources/values-it/strings.xml @@ -22,7 +22,6 @@ No Espandi Comprimi - Text size Riduci la dimensione del testo Aumenta la dimensione del testo Reimposta la dimensione del testo diff --git a/common/src/commonMain/composeResources/values-it/strings_about_app.xml b/common/src/commonMain/composeResources/values-it/strings_about_app.xml index b817f8f75..0d8dbc7cd 100644 --- a/common/src/commonMain/composeResources/values-it/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-it/strings_about_app.xml @@ -1,40 +1,26 @@ Uno strumento semplice per costruire storie. - Studio - Hammer è realizzato da Dark Rock Studios, insieme a una famiglia di altre app open source che rispettano la privacy. + Un progetto gratuito e open source. Community Discord Reddit Github Attribuzione Librerie - Dark Rock Studios - Modifiche - Rilascio su GitHub - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - Novità + La versione %s è ora disponibile + Aggiornato! + Visualizza aggiornamento + Note di rilascio + È disponibile una nuova versione di Hammer + Note di rilascio per %s Note di rilascio Nessuna nota di rilascio fornita. Apri la versione + Ignora Log dell’applicazione Cartella dei log: Esporta i log Nessun file di log trovato Apri la cartella dei log - Log esportati. - Impossibile esportare i log. Controlla la cartella dei log. - Copia diagnostica - Diagnostica copiata negli appunti. - Impossibile copiare la diagnostica. diff --git a/common/src/commonMain/composeResources/values-it/strings_account_settings.xml b/common/src/commonMain/composeResources/values-it/strings_account_settings.xml index 857898b61..eca45ef27 100644 --- a/common/src/commonMain/composeResources/values-it/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-it/strings_account_settings.xml @@ -9,7 +9,6 @@ Tema dell’interfaccia CHIARO SCURO - OLED SISTEMA Schermata iniziale del progetto Home @@ -37,27 +36,15 @@ Vuoi davvero rimuovere il server? Configura il server URL del server: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. E-mail: user@example.com Password - %1$d-%2$d characters Mostra la password Nascondi la password Accedi Crea Annulla - Merge existing projects with the server? - PROJECT DATA - Merge - Sostituisci - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + Rimuovere il contenuto locale? + Vuoi rimuovere il tuo contenuto locale attuale prima di sincronizzare? In caso contrario, proveremo a unire il tuo contenuto locale con quello del server. Se il contenuto non è correlato, potrebbe causare problemi. Impostazioni della piattaforma Nessuna impostazione specifica della piattaforma. Tieni lo schermo acceso @@ -74,8 +61,6 @@ Se causa problemi, disattivalo. Attiva il controllo ortografico Attiva in modalità concentrazione - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Dizionario Lingua del controllo ortografico Su Android, la lingua del controllo ortografico viene scelta dal tuo dispositivo, non dall’app. Per cambiarla, aggiorna le lingue del sistema e della tastiera nelle impostazioni di Android. @@ -86,7 +71,6 @@ Impossibile caricare i backup: %1$s Impossibile caricare i backup del progetto: %1$s Impossibile eliminare il backup: %1$s - Failed to restore backup: %1$s Ripristina backup Attenzione: ripristinare questo backup sostituirà completamente il contenuto attuale del progetto. Tutti i file esistenti verranno eliminati e sostituiti con i dati del backup. Questa azione non può essere annullata. Ripristina @@ -126,6 +110,4 @@ Il server non risponde. Controlla la tua connessione a internet e riprova. Server non trovato. Controlla l’indirizzo del server e la tua connessione a internet. Errore di rete durante la connessione a %1$s. Controlla la tua connessione e riprova. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values-it/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-it/strings_encyclopedia.xml index 4d6dfd091..1c7d93bcd 100644 --- a/common/src/commonMain/composeResources/values-it/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-it/strings_encyclopedia.xml @@ -30,12 +30,10 @@ Annulla Voce creata Il nome della voce era troppo lungo. Max %1$d - The entry name contains invalid characters + Il nome della voce deve essere alfanumerico Il tag è troppo lungo. Max %1$d L’alias è troppo lungo. Max %1$d Alias - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled Aggiungi alias Aggiungi Soprannome o altro nome diff --git a/common/src/commonMain/composeResources/values-it/strings_project_home.xml b/common/src/commonMain/composeResources/values-it/strings_project_home.xml index 0185926d0..35548e43e 100644 --- a/common/src/commonMain/composeResources/values-it/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-it/strings_project_home.xml @@ -78,16 +78,6 @@ RTF (.rtf) Annulla Esporta - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Scene - %1$d of %2$d selected - Seleziona tutto - Cancella tutto Scopri i formati di esportazione Scegliere un formato di esportazione Ogni formato è adatto a uno scopo diverso. Scegli quello che corrisponde a come intendi usare la storia esportata. @@ -114,12 +104,7 @@ Crea gruppi di capitoli Anteprima Niente da importare - Reading your manuscript Creerà %1$d scene - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s P Annulla Importa Impostazioni diff --git a/common/src/commonMain/composeResources/values-it/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-it/strings_project_navigation.xml index e48407eaf..eb513f3f1 100644 --- a/common/src/commonMain/composeResources/values-it/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-it/strings_project_navigation.xml @@ -4,10 +4,10 @@ Storia Note Enciclopedia - Cronologia + Timeline HOME STOR - NOTA + NOTE ENCI CRON Espandi la navigazione diff --git a/common/src/commonMain/composeResources/values-it/strings_projects_list.xml b/common/src/commonMain/composeResources/values-it/strings_projects_list.xml index a3428d82c..38e4961c4 100644 --- a/common/src/commonMain/composeResources/values-it/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-it/strings_projects_list.xml @@ -7,7 +7,6 @@ Crea progetto Progetti sincronizzati Impossibile sincronizzare i progetti - Could not delete the project. Check that its folder is accessible and try again. Altro %1$s parole di %1$s diff --git a/common/src/commonMain/composeResources/values-it/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-it/strings_reader_mode.xml deleted file mode 100644 index eab2e51c4..000000000 --- a/common/src/commonMain/composeResources/values-it/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Riduci la dimensione del testo - Aumenta la dimensione del testo - Reimposta la dimensione del testo - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-it/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-it/strings_scene_editor.xml index 4869b3f68..f8ce3f26e 100644 --- a/common/src/commonMain/composeResources/values-it/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-it/strings_scene_editor.xml @@ -24,8 +24,6 @@ Archivia Salva Chiudi - Read - Add to dictionary Archivia scena Vuoi davvero archiviare «%1$s»? La scena verrà nascosta dall’elenco delle scene ma potrà essere ripristinata in seguito. Archivia diff --git a/common/src/commonMain/composeResources/values-it/strings_scene_list.xml b/common/src/commonMain/composeResources/values-it/strings_scene_list.xml index 372b60de3..2aa1a7a22 100644 --- a/common/src/commonMain/composeResources/values-it/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-it/strings_scene_list.xml @@ -16,8 +16,7 @@ Crea Annulla Scaletta della storia - Scaletta - Read + Panoramica della scaletta <nessuna scaletta> Ignora Manoscritto @@ -53,7 +52,6 @@ Sposta Annulla %1$d · %2$d GR - %1$d SCN Nuova scena Nuovo gruppo Aggiungi diff --git a/common/src/commonMain/composeResources/values-it/strings_sync.xml b/common/src/commonMain/composeResources/values-it/strings_sync.xml index 302cbe363..8a56721ae 100644 --- a/common/src/commonMain/composeResources/values-it/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-it/strings_sync.xml @@ -34,13 +34,6 @@ Tag ↵ per aggiungere fantasy, bozza, nanowrimo… - Language - Not set - Choose a language - Chiudi - Search languages - Clear (not set) - No languages match Modifica Annulla OK @@ -51,12 +44,6 @@ di %1$s di (nessun autore impostato) Controllo ortografico - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ per aggiungere - Words the spell checker should accept in this project Impostazioni del progetto · %1$s §§ %1$d Conflitto di impostazioni del progetto @@ -65,14 +52,9 @@ Tema del progetto Obiettivo di conteggio parole Tag - Language - Learn Encyclopedia Names (non impostato) - On - Off giorno settimana - Project dictionary words from both sides are kept. Risolvi Nome: Tipo: @@ -116,20 +98,15 @@ Impossibile rinominare il progetto dal server: %1$s Progetto creato sul server: %1$s Impossibile creare il progetto sul server: %1$s - Project created on server, but failed to save its ID locally: %1$s Progetto locale creato: %1$s Impostazione dell’ID server del progetto locale: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + Impossibile creare il progetto sul server: %1$s Sincronizzazione dell’account… Sincronizzazione dei progetti… Sincronizzazione dei progetti completata Sincronizzazione del progetto: %1$s - No changes, skipped - Sincronizzazione non riuscita: %1$s C’è un conflitto nel progetto: %1$s. Apri quel progetto e sincronizza per risolverlo. Dati delle entità client calcolati - The server no longer has this project. It will be recreated the next time you sync. Dati del server ricevuti Dati del client caricati Backup locale eseguito: %1$s @@ -193,8 +170,7 @@ Patreon Hammer.Ink Registrazione - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - + Per impostazione predefinita, i server hanno la registrazione chiusa, il che significa che devi essere aggiunto alla lista bianca del server per poter creare un account. Configurazione Inserisci l’URL del server, come «hammer.ink» per il server ufficiale. Inserisci la tua e-mail e password, poi premi «Crea» per creare il tuo account. diff --git a/common/src/commonMain/composeResources/values-it/strings_timeline.xml b/common/src/commonMain/composeResources/values-it/strings_timeline.xml index de95c8700..85bcd239c 100644 --- a/common/src/commonMain/composeResources/values-it/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-it/strings_timeline.xml @@ -39,7 +39,7 @@ Elimina Eliminare l’evento di cronologia? Questa azione non può essere annullata! - Cronologia + Timeline %1$d VOCI · %2$d TAG Cerca nella cronologia Cerca nella cronologia diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings.xml index ac321ad32..88bf41b76 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings.xml @@ -22,7 +22,6 @@ Não Expandir Encolher - Text size Diminuir o tamanho do texto Aumentar o tamanho do texto Redefinir o tamanho do texto diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_about_app.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_about_app.xml index 94e5cd11b..1ab028206 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_about_app.xml @@ -1,40 +1,26 @@ Uma ferramenta simples para construir histórias. - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. + Um projeto livre e de código aberto. Comunidades Discord Reddit Github Atribuição Bibliotecas - Dark Rock Studios - Changes - GitHub Release - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - What's New + A versão %s está disponível agora + Atualizado! + Ver Atualização + Notas de Versão + Uma nova versão do Hammer está disponível + Notas de versão para %s Notas de versão Nenhuma nota de versão fornecida. Abrir Versão + Dispensar Logs do Aplicativo Diretório de Logs: Exportar Logs Nenhum arquivo de log encontrado Abrir diretório de logs - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_account_settings.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_account_settings.xml index 79b9e03a2..f4104e4da 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_account_settings.xml @@ -9,7 +9,6 @@ Tema de 'interface' do usuário CLARO ESCURO - OLED SISTEMA Tela Inicial do Projeto Início @@ -37,27 +36,15 @@ Tem certeza que deseja remover este servidor? Preparar Servidor URL do servidor: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. E-mail: usuário@exemplo.com Senha - %1$d-%2$d characters Mostrar senha Ocultar Senha Entrar Criar Cancelar - Merge existing projects with the server? - PROJECT DATA - Merge - Substituir - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + Remover Conteúdo Local? + Devemos remover seu conteúdo local atual antes de sincronizar? Caso contrário, tentaremos mesclar seu conteúdo local com o conteúdo do servidor. Se o conteúdo não estiver relacionado, isso pode causar problemas Configurações da Plataforma Nenhuma configuração específica da plataforma. Manter a tela ligada @@ -74,8 +61,6 @@ Se estiver causando problemas, basta desativá-lo. Ativar o corretor ortográfico Ativar no Modo de Foco - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Dicionário Idioma do corretor ortográfico No Android, o idioma do corretor ortográfico é escolhido pelo seu dispositivo, não pelo app. Para alterá-lo, atualize os idiomas do sistema e do teclado nas configurações do Android. @@ -86,7 +71,6 @@ Falha ao carregar 'backups': %1$s Falha ao carregar 'backups' para o projeto: %1$s Falha ao excluir 'backup': %1$s - Failed to restore backup: %1$s Restaurar 'Backup' Aviso: Restaurar este 'backup' substituirá completamente o conteúdo atual do projeto. Todos os arquivos existentes serão apagados e substituídos pelos dados de 'backup'. Esta ação não pode ser desfeita. Restaurar @@ -126,6 +110,4 @@ O servidor não está respondendo. Verifique sua conexão com a 'internet' e tente novamente. Servidor não encontrado. Verifique o endereço do servidor e sua conexão de 'internet'. Erro de rede ao conectar-se a %1$s. Verifique sua conexão e tente novamente. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_encyclopedia.xml index c4249dc83..4dd848101 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_encyclopedia.xml @@ -30,18 +30,16 @@ Cancelar Verbete Criado O Nome do Verbete é grande demais. Máx. %1$d - The entry name contains invalid characters + O nome do verbete deve ser alfanumérico A etiqueta é muito longa. Máx. %1$d O apelido é muito longo. Máx. %1$d Apelidos - Adicionar à correção ortográfica - O nome e apelidos deste verbete não serão marcados como incorretos Adicionar Apelido Adicionar Apelido ou outro nome Aparece nas cenas Ainda não referenciado em nenhuma cena - Nome do verbete não pode estar vazio + Entry name cannot be empty Descartar Novo Verbete? Erro: Falha ao carregar o verbete! Clique para inserir a descrição diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_project_home.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_project_home.xml index 313882252..53ee366f6 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_project_home.xml @@ -78,16 +78,6 @@ RTF (.rtf) Cancelar Exportar - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Cenas - %1$d of %2$d selected - Selecionar tudo - Limpar tudo Saiba mais sobre os formatos de exportação Escolhendo um Formato de Exportação Cada formato serve a um propósito diferente. Escolha o que corresponde à forma como você planeja usar a história exportada. @@ -114,12 +104,7 @@ Criar grupos de capítulos Prévia Nada para importar - Reading your manuscript Criará %1$d cena(s) - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W Cancelar Importar Configurações diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_project_navigation.xml index de1fd8dd2..723b634da 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_project_navigation.xml @@ -4,7 +4,7 @@ História Anotações Enciclopédia - Linha do Tempo + Timeline INÍC HIST ANOT diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_projects_list.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_projects_list.xml index 30a1ec38d..c1677bd6f 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_projects_list.xml @@ -7,7 +7,6 @@ Criar Projeto Projetos sincronizados Falha ao sincronizar projetos - Could not delete the project. Check that its folder is accessible and try again. Mais %1$s palavras por %1$s diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_reader_mode.xml deleted file mode 100644 index 1e3ab7bc4..000000000 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Diminuir o tamanho do texto - Aumentar o tamanho do texto - Redefinir o tamanho do texto - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_editor.xml index 4d91325f9..7b283cd74 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_editor.xml @@ -24,8 +24,6 @@ Arquivar Salvar Fechar - Read - Add to dictionary Arquivar Cena Tem certeza que deseja arquivar '%1$s'? A cena será ocultada da lista de cenas, mas pode ser restaurada mais tarde. Arquivar diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_list.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_list.xml index f1b10ea03..c2c1cc72a 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_scene_list.xml @@ -16,8 +16,7 @@ Criar Cancelar Esboço da história - Esboço - Read + Visão geral <sem esboço> Descartar Manuscrito @@ -53,7 +52,6 @@ Mover Cancelar %1$d · %2$d GR - %1$d CEN Nova Cena Novo Grupo Adicionar diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_sync.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_sync.xml index 39e1bab95..11d5d580b 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_sync.xml @@ -34,13 +34,6 @@ Etiquetas ↵ para adicionar fantasia, rascunho, nanowrimo… - Idioma - Not set - Escolha um idioma - Fechar - Procurar idiomas - Clear (not set) - No languages match Editar Cancelar OK @@ -51,12 +44,6 @@ por %1$s por (nenhum autor definido) Corretor ortográfico - A verificação ortográfica está desativada: o idioma do projeto (%1$s) não coincide com o seu dicionário (%2$s). Altere algum deles para reativá-la. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ para adicionar - Words the spell checker should accept in this project Configurações do Projeto · %1$s §§ %1$d Conflito de Configurações do Projeto @@ -65,14 +52,9 @@ Tema do Projeto Meta de Contagem de Palavras Etiquetas - Idioma - Learn Encyclopedia Names (não definido) - On - Off dia semana - Project dictionary words from both sides are kept. Resolver Nome: Tipo: @@ -116,20 +98,15 @@ Falha ao renomear projeto no do servidor: %1$s Projeto criado no servidor: %1$s Falha ao criar projeto no servidor: %1$s - Project created on server, but failed to save its ID locally: %1$s Projeto local criado: %1$s Configurando ID do servidor do projeto local: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + Falha ao criar projeto de servidor:%1$s Sincronizando Conta... Sincronizando Projetos... Sincronização de projetos concluída Sincronizando Projeto: %1$s - No changes, skipped - Sincronização falhou: %1$s Há um conflito no projeto: %1$s, abra o projeto e sincronize para resolvê-lo Dados da Entidade de Cliente calculados - O servidor não possui mais este projeto. Ele será recriado na próxima vez que você sincronizar. Dados do servidor recebidos Dados do cliente carregados Backup Local realizado: %1$s @@ -193,8 +170,7 @@ Patreon Hammer.Ink Registro - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - + Por padrão, os servidores têm registro fechado, o que significa que você precisa ser adicionado à lista de permissões desse servidor para poder criar uma conta Configurar Digite a URL do servidor, como "hammer.ink" para o servidor oficial Digite seu e-mail e senha e, em seguida, clique em "Criar" para criar sua conta diff --git a/common/src/commonMain/composeResources/values-pt-rBR/strings_timeline.xml b/common/src/commonMain/composeResources/values-pt-rBR/strings_timeline.xml index 5b3fd64cb..a09cac551 100644 --- a/common/src/commonMain/composeResources/values-pt-rBR/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-pt-rBR/strings_timeline.xml @@ -39,7 +39,7 @@ Excluir Excluir Evento da Linha do Tempo? Isso não pode ser desfeito! - Linha do Tempo + Timeline %1$d ENTRADAS · %2$d ETIQUETAS Pesquisar na linha do tempo Pesquisar na linha do tempo diff --git a/common/src/commonMain/composeResources/values-tr/strings.xml b/common/src/commonMain/composeResources/values-tr/strings.xml deleted file mode 100644 index c43d6cc10..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - Hammer - Saved all Scenes - Unsaved Scenes - What should be done with unsaved scenes? - Unsaved Encyclopedia Entry - Discard entry? - Unsaved Note - Discard note? - Unsaved Timeline Event - Discard event? - Cancel - Discard and close - Discard - Cancel - Save - Close - More - Failed to parse response body: %1$s - Yes - No - Expand - Collapse - Text size - Decrease text size - Increase text size - Reset text size - Find and replace - Bold - Italic - Strikethrough - Heading - Quote - Bulleted list - Numbered list - Horizontal rule - Undo - Redo - ESC cancel - diff --git a/common/src/commonMain/composeResources/values-tr/strings_about_app.xml b/common/src/commonMain/composeResources/values-tr/strings_about_app.xml deleted file mode 100644 index 878ddefc1..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_about_app.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - A simple tool for building stories. - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. - Community - Discord - Reddit - Github - Attribution - Libraries - Dark Rock Studios - Changes - GitHub Release - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - What's New - Release notes - No release notes provided. - Open Release - Application Logs - Log Directory: - Export Logs - No log files found - Open log directory - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. - diff --git a/common/src/commonMain/composeResources/values-tr/strings_account_settings.xml b/common/src/commonMain/composeResources/values-tr/strings_account_settings.xml deleted file mode 100644 index 1d5f09070..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_account_settings.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - ACCOUNT - LOCAL INSTALL - ACCOUNT SETTINGS - Backups - This backup system is meant to protect against data loss and corruption. It is NOT intended as a way to keep older revisions of your stories. Please use the Drafts system for that. - - Manage Backups - UI Theme - LIGHT - DARK - OLED - SYSTEM - Initial Project Screen - Home - Scene Editor - Projects Directory - Set the directory Hammer will use to store project data in. - - Select Dir - Example Project - Install an example project to see how different features are used. - - Reinstall - Example project created. - CONNECTED - NOT CONNECTED - URL - HELP ↗ - Configure data syncing - Set Up - Auto-Sync - Backup on sync - Close Sync Dialogs on Success - Max Backups per Project - Must be between 1 and %1$d - Remove Server - Remove Server - Are you sure you want to remove the server? - Set Up Server - Server URL: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. - E-Mail: user@example.com - Password - %1$d-%2$d characters - Show password - Hide password - Log In - Create - Cancel - Merge existing projects with the server? - PROJECT DATA - Merge - Replace - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. - Platform Settings - No platform-specific settings. - Keep screen on - Enable Do Not Disturb when in Focus Mode - Grant DND Permission - Hammer needs permission to enable Do Not Disturb mode when you are in Focus Mode. - - Store projects in public storage - Keep your projects in the shared Documents folder so other apps and your file manager can reach them. - - Projects Location - Hammer needs file access permission to store projects in public storage. - - Grant File Access - Experimental - Spell Checking - If it is causing problems just turn it off. - Enable spell checking - Enable in focus mode - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open - Dictionary - Spell check language - On Android, the spell check language is chosen by your device, not the app. To change it, update your system and keyboard languages in Android Settings. - Set up a server to sync your projects across devices and create secure backups. - - Sync & Backup Preferences - Danger Zone - - Failed to load backups: %1$s - Failed to load backups for project: %1$s - Failed to delete backup: %1$s - Failed to restore backup: %1$s - Restore Backup - Warning: Restoring this backup will completely replace the current contents of the project. All existing files will be deleted and replaced with the backup data. This action cannot be undone. - - Restore - Cancel - Manage Backups - No backups found - Select a project - No backups for this project - Restore - Delete backup - Show in Folder - Export - Cancel Sync? - Are you sure you want to cancel the sync? - Sync canceled - - An unexpected error occurred. Please try again. - Invalid server address. Enter a URL like "hammer.ink" or an IP address. - - Please enter a valid email address. - Password must be at least 8 characters. - Password must be 64 characters or less. - Password must contain at least one uppercase letter. - - Password must contain at least one lowercase letter. - - Password must contain at least one number. - Password must contain at least one special character. - - Server setup successful! - Server setup failed: %1$s - Server setup failed. Please check your connection and try again. - - - Terms of Service - Accept - Decline - You must accept the Terms of Service to create an account. - - Could not connect to server. Make sure the server is running and the address is correct. - - The server is not responding. Check your internet connection and try again. - - Server not found. Check the server address and your internet connection. - Network error connecting to %1$s. Check your connection and try again. - - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. - diff --git a/common/src/commonMain/composeResources/values-tr/strings_desktop.xml b/common/src/commonMain/composeResources/values-tr/strings_desktop.xml deleted file mode 100644 index 269a79bd7..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_desktop.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - Hammer - Project Selection - Hammer - %1$s - File - Close Project - Exit - Recent Projects - - Welcome to Hammer - Hammer stores your projects in a folder you choose, so your writing stays in - your hands.\n\nOn the next screen, pick an existing hammer projects folder or create a new one. You can change - this later in Settings. - - Choose where to store your Hammer projects - Choose Folder - Quit - Hammer needs a folder to store your projects.\nChoose a folder now, or quit. - - diff --git a/common/src/commonMain/composeResources/values-tr/strings_drafts.xml b/common/src/commonMain/composeResources/values-tr/strings_drafts.xml deleted file mode 100644 index e9a75bb9b..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_drafts.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - Merge with Current - Copy parts of the draft into here - Take Merged - Draft: %1$s - Copy desired parts into current, or accept all of this. - Take this whole draft - Draft - Current - %1$s Drafts: - No Drafts Found - Invalid name - diff --git a/common/src/commonMain/composeResources/values-tr/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-tr/strings_encyclopedia.xml deleted file mode 100644 index 48730b1a3..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_encyclopedia.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - Encyclopedia - Search - Clear - Person - Place - Thing - Event - Idea - No Entries Found - Create Entry - Create entry - New - Draft - Name - e.g. Cheshire Cat - Tags - ↵ to add - ritual, magical, recurring… - Description - Cover Art - Drop image · or - Browse files - 1 attached - Replace - Image is too large. Maximum size is %1$d MB. - Could not read the selected image. - Create entry - Cancel - Entry Created - Entry Name was too long. Max %1$d - The entry name contains invalid characters - Tag is too long. Max %1$d - Alias is too long. Max %1$d - Aliases - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled - Add Alias - Add - Nickname or other name - Appears in scenes - Not yet referenced in any scene - Entry name cannot be empty - Discard New Entry? - Error: Failed to load entry! - Click to enter description - Cancel - Save - Entry Saved - Discard Changes? - You will lose any changes you have made. - - Delete Entry? - This cannot be undone! - Entry Deleted - Delete Image? - This cannot be undone! - Name - Close Entry - Entry - Delete Entry - Remove Image - Add Image - Add Tags - Add Tags - Encyclopedia - Edit - Particulars - Type - Tags - Aliases - Scenes - Tags - tag - alias - Fig. I · Entry - Fig. I - + Add - Fol. %1$s · Ent-%2$s - Sc.%1$s - Entry · Catalogue card - Edited - End of entry ✦ - diff --git a/common/src/commonMain/composeResources/values-tr/strings_globalsearch.xml b/common/src/commonMain/composeResources/values-tr/strings_globalsearch.xml deleted file mode 100644 index bc78f6853..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_globalsearch.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - Search project - Search project - Type to search, use #tag to filter… - Clear search - No results - Type at least 2 characters to search - %1$d results - Scene - Note - Encyclopedia - Timeline - All - Scenes - Notes - Encyclopedia - Timeline - diff --git a/common/src/commonMain/composeResources/values-tr/strings_ideas.xml b/common/src/commonMain/composeResources/values-tr/strings_ideas.xml deleted file mode 100644 index 9255d1790..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_ideas.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - Story Ideas - IDEA - Story Ideas - %1$d IDEAS · %2$d TAGS - No story ideas yet. Capture your first spark. - No archived ideas. - %1$d W - %1$d TAGS - Search ideas - Search ideas - Clear search - Close search - All - Archived - FILTERED %1$d / %2$d - Clear All - SORT - Newest - Oldest - Title A–Z - ↓ DATE - ↑ DATE - ↓ A–Z - PROMOTED · %1$s - ARCHIVED · %1$s - Capture a new idea - New Idea - Story Idea - Editing - UNSAVED - STORY IDEAS - Close idea - Edit - Title - Optional title - Tags - Enter or comma adds a tag - Add tag… - %1$d / %2$d CH - Create - Save - Cancel - Delete - Archive - Unarchive - Idea captured - Idea saved - Idea deleted - Idea archived - Idea unarchived - Idea cannot be empty - Idea is too long: %1$d characters max - Tags can be at most %1$d characters - Create Project - Create Project from Idea - A new project will be created and this idea will be added to it as its first note. - Project created: %1$s - Failed to create project - Delete Idea - This idea will be permanently deleted. This cannot be undone. - Discard Changes - You have unsaved changes. Discard them? - Syncing story ideas - Story ideas unchanged — skipped - Story ideas sync complete - Failed to fetch story ideas state: %1$s - Removed deleted idea: %1$s - Propagated idea deletion to server: %1$s - Failed to delete idea on server: %1$s - Uploaded idea: %1$s - Failed to upload idea "%1$s": %2$s - Downloaded idea: %1$s - Failed to download idea %1$s: %2$s - Conflict detected for idea: %1$s - Resolved conflict for idea: %1$s - Conflict left unresolved for idea: %1$s - Story Idea Conflict - Title - Tags - Content - diff --git a/common/src/commonMain/composeResources/values-tr/strings_notes.xml b/common/src/commonMain/composeResources/values-tr/strings_notes.xml deleted file mode 100644 index 262a4159d..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_notes.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - Notes - No Notes Found - Create Note - Cancel - Discard Changes? - You will lose any changes you have made. - Create Note - III · NEW - DRAFT - Create - Cancel - Note Created - Note was too long - Note was empty - Tag was too long (max %1$d) - Tags - ↵ to add - idea, todo, follow-up… - Delete Note? - This action cannot be undone! - Note Deleted - Note - Delete - Note - Editing - Close Note - Notes - Edit - Save - UNSAVED - %1$d W · %2$d CH - ESC TO CANCEL - Search notes - Search notes - Close search - Clear search - %1$d NOTES · %2$d TAGS - %1$d W - ALL - FILTERED · %1$d OF %2$d - CLEAR ALL - SORT - Newest - Oldest - Longest - Shortest - Title A–Z - ↓ DATE - ↑ DATE - ↓ WORDS - ↑ WORDS - ↓ A–Z - diff --git a/common/src/commonMain/composeResources/values-tr/strings_project_home.xml b/common/src/commonMain/composeResources/values-tr/strings_project_home.xml deleted file mode 100644 index 380b14572..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_project_home.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - Created: %1$s - Calculating statistics... - Refresh statistics - Statistics may be out of date - Scenes - Total Words - Encyclopedia Entries - Words in Chapters - Chapter - %1$s: %2$s words - Avg Words / Scene - Notes - Timeline Events - Longest Scene - %1$s words - No scenes yet - Last Edited - Median - ≈ %1$d min reading - %1$d pages - Daily goal - Weekly goal - This week - no change vs last week - no data last week - Today - Daily avg - Streak - %1$d days - Longest: %1$d - Days written - Best day - %1$s · %2$s - Characters by Appearances - %1$d connections - Words by Device - Activity · %1$d weeks - %1$s · %2$s words - %1$s · no writing - Avg weekday - Avg weekend - σ %1$d · min %2$d · max %3$d - entries - %1$s · %2$s entries - Themes - %1$d tags · %2$d uses - %1$d/4 - Most connective - Appears in all four types · %1$d uses - Appears in %1$d of 4 types · %2$d uses - All 4 types - %1$d of 4 types - Distribution - Showing %1$d of %2$d - Rank · Tag · Breadth · Uses - Scenes - Notes - Encyclopedia - Events - Export Story - Sync Story - Backup - Backup Created: %1$s - Backup Failed - Story Exported - Export failed - Export Story - EXPORT - × CLOSE - Treat top-level scenes as chapters - Format - Markdown (.md) - EPub (.epub) - PDF (.pdf) - Word (.docx) - RTF (.rtf) - Cancel - Export - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Scenes - %1$d of %2$d selected - Select all - Clear all - Learn about export formats - Choosing an Export Format - Each format suits a different purpose. Pick the one that matches how you plan to use the exported story. - Plain text with light formatting; ideal for version control, re-importing, or other writing tools. - The standard e-book format; best for beta readers reading on e-readers and phones with reflowable text. - A fixed page layout that looks the same everywhere; best for printing or sharing a final, read-only copy. - Opens in Word and Google Docs; best for editors and beta readers who leave comments or track changes. - A broadly compatible rich-text format; a safe choice when you are unsure which word processor the recipient uses. - Got it - Contents - by %1$s - Story Imported - Import failed - Import Story - Chapter detection - Auto - H1 (#) - H2 (##) - Split into scenes - Formatting - Pattern - Single scene - Chapter pattern (regex) - Create chapter groups - Preview - Nothing to import - Reading your manuscript - Will create %1$d scene(s) - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W - Cancel - Import - Settings - Project menu - diff --git a/common/src/commonMain/composeResources/values-tr/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-tr/strings_project_navigation.xml deleted file mode 100644 index ce837ac4a..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_project_navigation.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - Home - Story - Notes - Encyclopedia - Timeline - HOME - STRY - NOTE - ENCY - TIME - Expand navigation - Collapse navigation - diff --git a/common/src/commonMain/composeResources/values-tr/strings_project_select_navigation.xml b/common/src/commonMain/composeResources/values-tr/strings_project_select_navigation.xml deleted file mode 100644 index 82972b264..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_project_select_navigation.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - Projects - Settings - About - PROJ - SETT - INFO - Libraries - diff --git a/common/src/commonMain/composeResources/values-tr/strings_projects_list.xml b/common/src/commonMain/composeResources/values-tr/strings_projects_list.xml deleted file mode 100644 index c435282e5..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_projects_list.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - No Projects Found - Delete - Rename - Sync Projects - Create Project - Projects synced - Failed to sync projects - Could not delete the project. Check that its folder is accessible and try again. - More - %1$s words - by %1$s - Created %1$s - Project %1$s - Search projects - Close search - filter by name or #tag - Clear filter - No projects match your filter - Hammer · Library - Title - Last Open - — Empty Index — - Library - Sync · On - Local - 0 entries - 1 entry - %1$d entries - SORT - Recently Opened - Least Recent - Newest - Oldest - Longest - Shortest - ↓ OPENED - ↑ OPENED - ↓ CREATED - ↑ CREATED - ↓ WORDS - ↑ WORDS - Account Sync - Sync Log - Project - All - Pending - Error - Conflict - Sync Complete - Canceled - Delete Project - This action cannot be undone. All project data will be permanently deleted. - Type "%1$s" to confirm - Delete - Cancel - Rename Project - New Project Name - Rename Project - Cancel - Create Project - New - Project - New Project Name - Create Project - Cancel - Import - Learn about importing a story - Create from an Existing Story - Already have a manuscript? Import it to create a new project. Hammer names the project after your file and automatically splits the text into scenes. - Supported Formats - Markdown (.md) - Rich Text (.rtf) - Got it - Project already exists - Missing Project Name - Project name too long - The project name contains invalid characters - The project name was left blank - diff --git a/common/src/commonMain/composeResources/values-tr/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-tr/strings_reader_mode.xml deleted file mode 100644 index f3edd2c29..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Decrease text size - Increase text size - Reset text size - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-tr/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-tr/strings_scene_editor.xml deleted file mode 100644 index 2511fc20d..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_scene_editor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - Start New Draft: - Draft name - Save - Cancel - Draft Saved - Saving current draft as: - Current draft name is invalid! - Rename Scene - Scene Name - Rename - Cancel - Unsaved - Save - Scene Info - Saved - Scene - New Draft - View Drafts - Rename - Discard - Delete - Archive - Save - Close - Read - Add to dictionary - Archive Scene - Are you sure you want to archive '%1$s'? The scene will be hidden from the scene list but can be restored later. - Archive - Cancel - Discard Changes - Are you sure you want to discard all unsaved changes to '%1$s'? This will reload the last saved version from disk. - Discard - Cancel - Archived Scenes - No archived scenes - Restore - "%1$s" has been restored - "%1$s" has been archived - View Archived - Enter Focus Mode - Metadata - Hide Info - Words: - Advanced - Entity ID: - Filename: - Path: - Created - Edited - — - Outline - A short description of what happens in the scene. - Notes - Notes to yourself. - Draft Name - References - Dismissed - No references yet - Dismiss - Restore - (dismissed) - Characters - Locations - Other - + Add reference - Add reference - Done - Search characters… - Search locations… - Search entries… - No matching entries. - Close dialog - Tags - No tags yet - + Add tag - Add tags - tag1 tag2 … - Done - Select a Scene to edit - New Draft - diff --git a/common/src/commonMain/composeResources/values-tr/strings_scene_list.xml b/common/src/commonMain/composeResources/values-tr/strings_scene_list.xml deleted file mode 100644 index c8b3c4b18..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_scene_list.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - Scenes - Create Group - Group Name - Create Scene - Scene Name - Group Collapsed - Group Expanded - Delete Scene - Are you sure you want to delete this scene: "%1$s" - Delete - Dismiss - Cannot Delete Group - You cannot delete a group while it still has children: "%1$s" - - Create - Cancel - Story Outline - Outline - Read - <no outline> - Dismiss - Manuscript - An outline of - Jump to - Chapters - Scenes - Chapter %1$s · %2$d Scenes - %1$d SCN - End of outline - %1$d/%2$d - Untitled chapter - Options - Delete - Rename - Archive - Archive Scene - Are you sure you want to archive this scene: "%1$s" - Archive - Cancel - Rename Scene - Scene Name - Rename - Create Scene - Create Group - Move To - Destination - Search groups - Top Level - No matching groups - Position (1–%1$d) - Enter a position between 1 and %1$d - Move - Cancel - %1$d · %2$d GR - %1$d SCN - New Scene - New Group - Add - Move - Scene - Group - Root - diff --git a/common/src/commonMain/composeResources/values-tr/strings_sync.xml b/common/src/commonMain/composeResources/values-tr/strings_sync.xml deleted file mode 100644 index a41f985cd..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_sync.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - Project Synchronization - Scene Conflict - Scene Draft Conflict - Note Conflict - Timeline Event Conflict - No Date - Local - Remote - %1$s Conflict - Scene - Note - Timeline Event - Encyclopedia Entry - Scene Draft - Project Settings - You can take either the local or remote copy as is, or you can manually merge the two by copying parts of the remote into your local copy, and then taking that. - - Encyclopedia Entry Conflict - Author - Custom theme - Use a custom theme for this project - Primary - Secondary - Word-count goal - Track a writing goal - Words - Per - Day - Week - Effective - W / day - Tags - Tags - ↵ to add - fantasy, draft, nanowrimo… - Language - Not set - Choose a language - Close - Search languages - Clear (not set) - No languages match - Edit - Cancel - OK - Home - Project Settings - Autosaved - § 0 · Project - by %1$s - by (no author set) - Spell checking - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ to add - Words the spell checker should accept in this project - Project Settings · %1$s - §§ %1$d - Project Settings Conflict - Pick a side for each field. Local is what you have on this device; Server is what was synced from another device. - Author Name - Project Theme - Word Count Goal - Tags - Language - Learn Encyclopedia Names - (not set) - On - Off - day - week - Project dictionary words from both sides are kept. - Resolve - Name: - Type: - Image: - Content: - Tags: - Has Image - Name - Scene Content - Outline - Notes - Content - Metadata - References - Confirmed - Dismissed - None - Aliases: - Name - Scene Content - Note Content - Date - Event Content - Sync - Start Sync - Synchronizing... - Sync Failed - Sync Complete - Project Sync Complete - Project Sync Failed - Begin Sync - Server data loaded - Account Sync complete - Failed to sync projects: %1$s - Deleting server project: - ID(%1$s) - - Failed to delete project on server: %1$s - Deleting local project: %1$s - Renaming server project: - ID(%1$s) - - Failed to rename project on - server: %1$s - - Rename project from - server: %1$s - - Failed to rename - project from server: %1$s - - Created project on server: %1$s - Failed to create project on server: %1$s - Project created on server, but failed to save its ID locally: %1$s - Created local project: %1$s - Setting local project Server ID: - %1$s - - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project - Syncing Account... - Syncing Projects... - Projects Sync Complete - Syncing Project: %1$s - No changes, skipped - Sync failed: %1$s - There is a conflict in project: %1$s, open that project and sync in order to resolve it - - Client Entity data calculated - The server no longer has this project. It will be recreated the next time you sync. - Server data received - Client data loaded - Local Backup made: %1$s - Entity %1$d downloaded - Failed to download entity %1$d - Entity %1$d not found on server - Entity %1$d not modified - Rejected download for entity %1$d: server returned a mismatched id or type - Failed to upload entity %1$d: type not owned by anything, probably deleted - Failed to delete ID %1$d on server: %2$s - Deleted ID %1$d on server - Encountered conflict for new Entity, this should not be possible! ID: %1$d TYPE: %2$s - - Sync failed: %1$s - Server cached hash is stale for entity %1$d. Healing by force uploading. - Successfully healed server cache for entity %1$d by force uploading - Failed to heal server cache for entity %1$d - force upload failed - Entities transferred - Sync finalized - Sync data saved - Sync data not saved due to errors - Failed to end sync - Rejected draft %1$d from server: unsafe draft name - Skipped image for encyclopedia entry %1$d from server: unsafe file extension - Deleted Encyclopedia ID %1$d from client - Deleted note ID %1$d from client - Deleted draft %1$d from client - Deleted scene %1$d from client - Failed to delete scene %1$d from client - Failed find scene to delete: %1$d - Deleted event %1$d from client - Failed to delete event %1$d from client - Failed find event to delete: %1$d - Creating new scene %1$d - Downloaded scene content for: %1$d - Moved scene %1$d to new parent %2$d - Failed to save downloaded scene content for: %1$d - Creating new group %1$d - Downloaded scene content for: %1$d - Moved scene %1$d to new parent %2$d - Unauthorized - Unhandled server error - UPDATE REQUIRED - Your app is out of date - The sync server is out of date - This version of Hammer can no longer sync with the server. Update to the latest version to keep syncing your work. - The sync server is running an older protocol than this app. The server needs to be updated before syncing will work again. - Latest version: %s - You have: %s - Get the Update - Dismiss - Reauthorize - Your token has expired, please reauthorize with your sync server. - Token Expired - Address - E-Mail - About Sync Servers - Sync Servers for Hammer allow you to work on your projects from multiple devices. They will sync your work across whatever devices you configure with the same server. - - Official Server - You can run your own Sync server, but if that is too technical, or you just want to support the project, we run an official server at hammer.ink. - - If you subscribe to our Patreon, you get access to the official server. This is the best way to support this project. - - Patreon - Hammer.Ink - Registration - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - - SetUp - Enter the server's URL, such as "hammer.ink" for the official server. - - Enter your email and password, then hit "Create" to create your account. - - In the future, and on other devices, you will simply hit "Log In". - - Important Note - Syncing in Hammer is different from online-first applications like Google Docs. The syncing is not real-time. It usually happens when you open or close the app. Make sure you're synced with the latest versions of your projects before going offline. Hammer does automatic syncing, but it's always good to check if you're going to be offline for a while. - - Got It - diff --git a/common/src/commonMain/composeResources/values-tr/strings_timeline.xml b/common/src/commonMain/composeResources/values-tr/strings_timeline.xml deleted file mode 100644 index c6900839d..000000000 --- a/common/src/commonMain/composeResources/values-tr/strings_timeline.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - No Events - Create Event - Event Created - Tag was too long (max %1$d) - Tags - ↵ to add - arc, foreshadow, conflict… - Event - Editing - Timeline - Save - Cancel - Edit - Close Entry - Date - optional - e.g. Spring of Y3 - UNDATED - UNSAVED - %1$d W · %2$d CH - ESC TO CANCEL - %1$d W - %1$d TAGS - Saved - Failed to save - Create Event - III · NEW - DRAFT - %1$d W · %2$d CH - Cancel - Create - optional - e.g. Spring of Y3 - Discard Changes? - You will lose any changes you have made. - Event - Delete - Delete Timeline Event? - This cannot be undone! - Timeline - %1$d ENTRIES · %2$d TAGS - Search timeline - Search timeline - Close search - Clear search - ALL - FILTERED · %1$d OF %2$d - CLEAR ALL - diff --git a/common/src/commonMain/composeResources/values-uk/strings.xml b/common/src/commonMain/composeResources/values-uk/strings.xml index b3896244f..239eede8e 100644 --- a/common/src/commonMain/composeResources/values-uk/strings.xml +++ b/common/src/commonMain/composeResources/values-uk/strings.xml @@ -22,7 +22,6 @@ Ні Розгорнути Згорнути - Text size Зменшити розмір тексту Збільшити розмір тексту Скинути розмір тексту diff --git a/common/src/commonMain/composeResources/values-uk/strings_about_app.xml b/common/src/commonMain/composeResources/values-uk/strings_about_app.xml index 4b0d11587..b286946d0 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_about_app.xml @@ -1,40 +1,26 @@ Простий інструмент для створення історій. - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. + Безкоштовний проєкт із відкритим кодом. Спільнота Discord Reddit Github Атрибуція Бібліотеки - Dark Rock Studios - Changes - GitHub Release - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - What's New + Тепер доступна версія %s + Актуальна версія! + Переглянути оновлення + Примітки до випуску + Доступна нова версія Hammer + Примітки до випуску %s Примітки до випуску Приміток до випуску не надано. Відкрити випуск + Закрити Журнали застосунку Тека журналів: Експортувати журнали Файлів журналів не знайдено Відкрити теку журналів - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. diff --git a/common/src/commonMain/composeResources/values-uk/strings_account_settings.xml b/common/src/commonMain/composeResources/values-uk/strings_account_settings.xml index 026a78cb6..999f1d972 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_account_settings.xml @@ -9,7 +9,6 @@ Тема інтерфейсу СВІТЛА ТЕМНА - OLED СИСТЕМНА Початковий екран проєкту Головна @@ -37,27 +36,15 @@ Ви впевнені, що хочете вилучити сервер? Налаштувати сервер URL сервера: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. Ел. пошта: user@example.com Пароль - %1$d-%2$d characters Показати пароль Сховати пароль Увійти Створити Скасувати - Merge existing projects with the server? - PROJECT DATA - Merge - Замінити - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + Вилучити локальний вміст? + Чи вилучити ваш поточний локальний вміст перед синхронізацією? Якщо ні, ми спробуємо об'єднати ваш локальний вміст із вмістом сервера. Якщо вміст не пов'язаний, це може спричинити проблеми. Налаштування платформи Немає налаштувань, специфічних для платформи. Не вимикати екран @@ -74,8 +61,6 @@ Якщо це спричиняє проблеми, просто вимкніть її. Увімкнути перевірку правопису Увімкнути в режимі зосередження - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Словник Мова перевірки правопису В Android мову перевірки правопису вибирає ваш пристрій, а не застосунок. Щоб змінити її, оновіть мови системи та клавіатури в налаштуваннях Android. @@ -86,7 +71,6 @@ Не вдалося завантажити резервні копії: %1$s Не вдалося завантажити резервні копії проєкту: %1$s Не вдалося видалити резервну копію: %1$s - Failed to restore backup: %1$s Відновити з резервної копії Увага: відновлення з цієї резервної копії повністю замінить поточний вміст проєкту. Усі наявні файли буде видалено та замінено даними резервної копії. Цю дію неможливо скасувати. Відновити @@ -126,6 +110,4 @@ Сервер не відповідає. Перевірте підключення до Інтернету та спробуйте ще раз. Сервер не знайдено. Перевірте адресу сервера та підключення до Інтернету. Помилка мережі під час під'єднання до %1$s. Перевірте з'єднання та спробуйте ще раз. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values-uk/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values-uk/strings_encyclopedia.xml index 10ca9b7e1..ef1e684bd 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_encyclopedia.xml @@ -30,12 +30,10 @@ Скасувати Запис створено Назва запису задовга. Макс. %1$d - The entry name contains invalid characters + Назва запису має бути буквено-цифровою Тег задовгий. Макс. %1$d Псевдонім задовгий. Макс. %1$d Псевдоніми - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled Додати псевдонім Додати Прізвисько або інша назва diff --git a/common/src/commonMain/composeResources/values-uk/strings_project_home.xml b/common/src/commonMain/composeResources/values-uk/strings_project_home.xml index dea76063a..8fa48da49 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_project_home.xml @@ -78,16 +78,6 @@ RTF (.rtf) Скасувати Експортувати - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Сцени - %1$d of %2$d selected - Вибрати все - Очистити все Дізнатися про формати експорту Вибір формату експорту Кожен формат підходить для різних цілей. Виберіть той, що відповідає тому, як ви плануєте використовувати експортовану історію. @@ -114,12 +104,7 @@ Створювати групи розділів Попередній перегляд Немає що імпортувати - Reading your manuscript Буде створено %1$d сцен - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W Скасувати Імпортувати Налаштування diff --git a/common/src/commonMain/composeResources/values-uk/strings_project_navigation.xml b/common/src/commonMain/composeResources/values-uk/strings_project_navigation.xml index 95ab1db03..426e0c780 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_project_navigation.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_project_navigation.xml @@ -4,7 +4,7 @@ Історія Нотатки Енциклопедія - Хронологія + Timeline ГОЛ ІСТ НОТ diff --git a/common/src/commonMain/composeResources/values-uk/strings_projects_list.xml b/common/src/commonMain/composeResources/values-uk/strings_projects_list.xml index 35a29fc75..6a707346e 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_projects_list.xml @@ -7,7 +7,6 @@ Створити проєкт Проєкти синхронізовано Не вдалося синхронізувати проєкти - Could not delete the project. Check that its folder is accessible and try again. Більше %1$s слів автор: %1$s diff --git a/common/src/commonMain/composeResources/values-uk/strings_reader_mode.xml b/common/src/commonMain/composeResources/values-uk/strings_reader_mode.xml deleted file mode 100644 index b240ac13e..000000000 --- a/common/src/commonMain/composeResources/values-uk/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Зменшити розмір тексту - Збільшити розмір тексту - Скинути розмір тексту - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values-uk/strings_scene_editor.xml b/common/src/commonMain/composeResources/values-uk/strings_scene_editor.xml index bf7932b3f..ddaa90c2c 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_scene_editor.xml @@ -24,8 +24,6 @@ Архівувати Зберегти Закрити - Read - Add to dictionary Архівувати сцену Ви впевнені, що хочете архівувати «%1$s»? Сцену буде приховано зі списку сцен, але її можна відновити пізніше. Архівувати diff --git a/common/src/commonMain/composeResources/values-uk/strings_scene_list.xml b/common/src/commonMain/composeResources/values-uk/strings_scene_list.xml index 710df424d..9d8f823bb 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_scene_list.xml @@ -16,8 +16,7 @@ Створити Скасувати План історії - План - Read + Огляд плану <немає плану> Закрити Рукопис @@ -53,7 +52,6 @@ Перемістити Скасувати %1$d · %2$d ГР - %1$d СЦ Нова сцена Нова група Додати diff --git a/common/src/commonMain/composeResources/values-uk/strings_sync.xml b/common/src/commonMain/composeResources/values-uk/strings_sync.xml index b2502247d..bc8b92fe2 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_sync.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_sync.xml @@ -34,13 +34,6 @@ Теги ↵ щоб додати фентезі, чернетка, nanowrimo… - Language - Not set - Choose a language - Закрити - Search languages - Clear (not set) - No languages match Редагувати Скасувати OK @@ -51,12 +44,6 @@ автор: %1$s автор: (не вказано) Перевірка правопису - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ щоб додати - Words the spell checker should accept in this project Налаштування проєкту · %1$s §§ %1$d Конфлікт налаштувань проєкту @@ -65,14 +52,9 @@ Тема проєкту Ціль за кількістю слів Теги - Language - Learn Encyclopedia Names (не встановлено) - On - Off день тиждень - Project dictionary words from both sides are kept. Вирішити Назва: Тип: @@ -116,20 +98,15 @@ Не вдалося перейменувати проєкт із сервера: %1$s Проєкт створено на сервері: %1$s Не вдалося створити проєкт на сервері: %1$s - Project created on server, but failed to save its ID locally: %1$s Локальний проєкт створено: %1$s Встановлення ID сервера для локального проєкту: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + Не вдалося створити проєкт на сервері: %1$s Синхронізація облікового запису… Синхронізація проєктів… Синхронізацію проєктів завершено Синхронізація проєкту: %1$s - No changes, skipped - Синхронізацію не вдалося: %1$s У проєкті є конфлікт: %1$s. Відкрийте цей проєкт і синхронізуйте, щоб вирішити його. Дані сутностей клієнта обчислено - The server no longer has this project. It will be recreated the next time you sync. Дані сервера отримано Дані клієнта завантажено Локальну резервну копію створено: %1$s @@ -193,8 +170,7 @@ Patreon Hammer.Ink Реєстрація - Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. - + За замовчуванням сервери мають закриту реєстрацію, тобто вас потрібно додати до білого списку сервера, щоб ви могли створити обліковий запис. Налаштування Введіть URL сервера, наприклад «hammer.ink» для офіційного сервера. Введіть вашу електронну пошту та пароль, потім натисніть «Створити», щоб створити обліковий запис. diff --git a/common/src/commonMain/composeResources/values-uk/strings_timeline.xml b/common/src/commonMain/composeResources/values-uk/strings_timeline.xml index 06930d5d6..e9f0e945d 100644 --- a/common/src/commonMain/composeResources/values-uk/strings_timeline.xml +++ b/common/src/commonMain/composeResources/values-uk/strings_timeline.xml @@ -39,7 +39,7 @@ Видалити Видалити подію хронології? Цю дію неможливо скасувати! - Хронологія + Timeline %1$d ЗАПИСІВ · %2$d ТЕГІВ Пошук у хронології Пошук у хронології diff --git a/common/src/commonMain/composeResources/values/strings.xml b/common/src/commonMain/composeResources/values/strings.xml index 6d1c98fe9..f76a6b2a6 100644 --- a/common/src/commonMain/composeResources/values/strings.xml +++ b/common/src/commonMain/composeResources/values/strings.xml @@ -35,7 +35,6 @@ Expand Collapse - Text size Decrease text size Increase text size Reset text size diff --git a/common/src/commonMain/composeResources/values/strings_about_app.xml b/common/src/commonMain/composeResources/values/strings_about_app.xml index 3539ae4c1..8985c3be2 100644 --- a/common/src/commonMain/composeResources/values/strings_about_app.xml +++ b/common/src/commonMain/composeResources/values/strings_about_app.xml @@ -1,9 +1,7 @@ A simple tool for building stories. - - Studio - Hammer is made by Dark Rock Studios, alongside a family of other privacy-respecting, open source apps. + A free and open source project. Community Discord @@ -12,36 +10,22 @@ Attribution Libraries - Dark Rock Studios - Changes - GitHub Release + Version %s is now available + Up to date! + View Update + Release Notes - Check for Updates - Checking for updates… - Hammer is up to date. - Hammer %1$s is available. - Update to %1$s - Downloading Hammer %1$s (%2$s) - Installing Hammer %1$s. Hammer will restart. - Could not update to %1$s: %2$s - Retry - Later - Hammer will quit to install the update, then reopen. - - What's New + A new version of Hammer is available + Release notes for %s Release notes No release notes provided. Open Release + Dismiss Application Logs Log Directory: Export Logs No log files found Open log directory - Logs exported. - Could not export the logs. See the log directory. - Copy Diagnostics - Diagnostics copied to the clipboard. - Could not copy the diagnostics. diff --git a/common/src/commonMain/composeResources/values/strings_account_settings.xml b/common/src/commonMain/composeResources/values/strings_account_settings.xml index fb854f5c1..7c0fcb000 100644 --- a/common/src/commonMain/composeResources/values/strings_account_settings.xml +++ b/common/src/commonMain/composeResources/values/strings_account_settings.xml @@ -11,7 +11,6 @@ UI Theme LIGHT DARK - OLED SYSTEM Initial Project Screen Home @@ -42,27 +41,17 @@ Are you sure you want to remove the server? Set Up Server Server URL: hammer.ink - Plain HTTP: your email, password and writing travel unencrypted. Only use this on a network you trust. E-Mail: user@example.com Password - %1$d-%2$d characters Show password Hide password Log In Create Cancel - Merge existing projects with the server? - PROJECT DATA - Merge - Replace - Hammer will match your local projects to projects already on the server by name. Projects that only exist on the server will be downloaded, and projects that only exist on this device will be uploaded. - All of your local projects will be deleted and replaced with whatever is on the server. - Continue - Delete all local projects? - This permanently deletes every project on this device and replaces them with the projects from the server. This cannot be undone. - Delete and Replace - Check for updates automatically - Looks for a new release on GitHub shortly after launch and every few hours. Nothing is downloaded or installed until you choose to update. + Remove Local Content? + Should we remove your current local content before syncing? If not, we will attempt to merge your local content with the server content. If the content is unrelated, it could cause problems. + Platform Settings No platform-specific settings. Keep screen on @@ -86,8 +75,6 @@ If it is causing problems just turn it off. Enable spell checking Enable in focus mode - Learn encyclopedia names - Entry names and aliases won’t be marked as misspelled while their project is open Dictionary Spell check language On Android, the spell check language is chosen by your device, not the app. To change it, update your system and keyboard languages in Android Settings. @@ -101,7 +88,6 @@ Failed to load backups: %1$s Failed to load backups for project: %1$s Failed to delete backup: %1$s - Failed to restore backup: %1$s Restore Backup Warning: Restoring this backup will completely replace the current contents of the project. All existing files will be deleted and replaced with the backup data. This action cannot be undone. @@ -158,7 +144,5 @@ Network error connecting to %1$s. Check your connection and try again. - Could not make a secure connection to %1$s. Hammer only connects over HTTPS, so the server needs a valid TLS certificate of its own or a reverse proxy that provides one. - Hammer could not open a network connection on this device, so the request never reached the server. Security software, a VPN, or a firewall may be blocking it. diff --git a/common/src/commonMain/composeResources/values/strings_encyclopedia.xml b/common/src/commonMain/composeResources/values/strings_encyclopedia.xml index 6f3f88a5f..d41a73dfd 100644 --- a/common/src/commonMain/composeResources/values/strings_encyclopedia.xml +++ b/common/src/commonMain/composeResources/values/strings_encyclopedia.xml @@ -33,12 +33,10 @@ Cancel Entry Created Entry Name was too long. Max %1$d - The entry name contains invalid characters + The entry name must be alphanumeric Tag is too long. Max %1$d Alias is too long. Max %1$d Aliases - Learn in spell check - This entry’s name and aliases won’t be marked as misspelled Add Alias Add Nickname or other name diff --git a/common/src/commonMain/composeResources/values/strings_project_home.xml b/common/src/commonMain/composeResources/values/strings_project_home.xml index 2576942fa..42b3ea49e 100644 --- a/common/src/commonMain/composeResources/values/strings_project_home.xml +++ b/common/src/commonMain/composeResources/values/strings_project_home.xml @@ -92,16 +92,6 @@ RTF (.rtf) Cancel Export - Number chapter titles - Font - Keep blank lines between paragraphs - Turn off if you separate paragraphs with a blank line and do not want empty paragraphs in the export. Scene breaks and runs of two or more blank lines are kept. - Limit to specific scenes - Only the selected scenes will be included in the export - Scenes - %1$d of %2$d selected - Select all - Clear all Learn about export formats Choosing an Export Format @@ -131,12 +121,7 @@ Create chapter groups Preview Nothing to import - Reading your manuscript Will create %1$d scene(s) - Large scene - One scene holds %1$s words, so chapter detection probably missed your chapter titles. Try another detection setting. - %1$d scenes hold %2$s words or more, so chapter detection probably missed some chapter titles. Try another detection setting. - %1$s W Cancel Import diff --git a/common/src/commonMain/composeResources/values/strings_projects_list.xml b/common/src/commonMain/composeResources/values/strings_projects_list.xml index c435282e5..a26dc0f55 100644 --- a/common/src/commonMain/composeResources/values/strings_projects_list.xml +++ b/common/src/commonMain/composeResources/values/strings_projects_list.xml @@ -7,7 +7,6 @@ Create Project Projects synced Failed to sync projects - Could not delete the project. Check that its folder is accessible and try again. More %1$s words by %1$s diff --git a/common/src/commonMain/composeResources/values/strings_reader_mode.xml b/common/src/commonMain/composeResources/values/strings_reader_mode.xml deleted file mode 100644 index f3edd2c29..000000000 --- a/common/src/commonMain/composeResources/values/strings_reader_mode.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - Reader - Chapter %1$d of %2$d - Edit ↗ - × Close - Decrease text size - Increase text size - Reset text size - Show scene headings - ← Previous chapter - Next chapter → - This chapter has no scenes yet - There is nothing to read yet - End of story - diff --git a/common/src/commonMain/composeResources/values/strings_scene_editor.xml b/common/src/commonMain/composeResources/values/strings_scene_editor.xml index 05792be0c..d4ecabcfd 100644 --- a/common/src/commonMain/composeResources/values/strings_scene_editor.xml +++ b/common/src/commonMain/composeResources/values/strings_scene_editor.xml @@ -24,8 +24,6 @@ Archive Save Close - Read - Add to dictionary Archive Scene Are you sure you want to archive '%1$s'? The scene will be hidden from the scene list but can be restored later. diff --git a/common/src/commonMain/composeResources/values/strings_scene_list.xml b/common/src/commonMain/composeResources/values/strings_scene_list.xml index 41ae93a81..b61709de8 100644 --- a/common/src/commonMain/composeResources/values/strings_scene_list.xml +++ b/common/src/commonMain/composeResources/values/strings_scene_list.xml @@ -18,8 +18,7 @@ Cancel Story Outline - Outline - Read + Outline Overview <no outline> Dismiss Manuscript @@ -59,7 +58,6 @@ Cancel %1$d · %2$d GR - %1$d SCN New Scene New Group Add diff --git a/common/src/commonMain/composeResources/values/strings_sync.xml b/common/src/commonMain/composeResources/values/strings_sync.xml index ad4947378..4fa3410fb 100644 --- a/common/src/commonMain/composeResources/values/strings_sync.xml +++ b/common/src/commonMain/composeResources/values/strings_sync.xml @@ -45,13 +45,6 @@ Tags ↵ to add fantasy, draft, nanowrimo… - Language - Not set - Choose a language - Close - Search languages - Clear (not set) - No languages match Edit Cancel OK @@ -62,12 +55,6 @@ by %1$s by (no author set) Spell checking - Spell check is off: the project language (%1$s) doesn’t match your dictionary (%2$s). Change either to re-enable it. - Learn encyclopedia names in this project - Turn off to keep this project’s entry names out of the spell check dictionary - Project dictionary - ↵ to add - Words the spell checker should accept in this project Project Settings · %1$s §§ %1$d @@ -77,14 +64,9 @@ Project Theme Word Count Goal Tags - Language - Learn Encyclopedia Names (not set) - On - Off day week - Project dictionary words from both sides are kept. Resolve @@ -153,27 +135,24 @@ Created project on server: %1$s Failed to create project on server: %1$s - Project created on server, but failed to save its ID locally: %1$s Created local project: %1$s Setting local project Server ID: %1$s - Failed to create local project from server: %1$s - Skipped server project %1$s: a local project of that name already syncs with a different server project + Failed to create server project: + %1$s + Syncing Account... Syncing Projects... Projects Sync Complete Syncing Project: %1$s - No changes, skipped - Sync failed: %1$s There is a conflict in project: %1$s, open that project and sync in order to resolve it Client Entity data calculated - The server no longer has this project. It will be recreated the next time you sync. Server data received Client data loaded Local Backup made: %1$s @@ -254,7 +233,7 @@ Hammer.Ink Registration Servers have closed registration, meaning the server admin needs to add you to the server's allowed users list before you can create an account. + name="server_setup_help_registration_body">By default, servers have closed registration, meaning you need to get added to that server's whitelist to be able to create an account. SetUp Enter the server's URL, such as "hammer.ink" for the official server. diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/Diagnostics.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/Diagnostics.kt deleted file mode 100644 index 69c38d9e5..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/Diagnostics.kt +++ /dev/null @@ -1,93 +0,0 @@ -package com.darkrockstudios.apps.hammer.common - -import com.darkrockstudios.apps.hammer.common.util.crashDumpMillis -import com.darkrockstudios.apps.hammer.common.util.isCrashDump -import com.darkrockstudios.apps.hammer.common.util.readLatestCrash -import io.github.aakira.napier.Napier -import kotlinx.coroutines.withContext -import okio.Buffer -import okio.FileSystem -import okio.Path -import okio.Path.Companion.toPath -import okio.buffer -import okio.use -import kotlin.time.Instant - -/** Enough of the tail to hold a stack trace and what led up to it, without becoming an attachment. */ -private const val DIAGNOSTICS_LOG_LINES = 200 - -/** Ceiling on the tail read, so a runaway log can't be pulled into memory whole. */ -private const val DIAGNOSTICS_TAIL_BYTES = 64L * 1024 - -/** A crash's cause sits at the top; a StackOverflowError can repeat one frame for thousands of lines below it. */ -private const val DIAGNOSTICS_CRASH_LINES = 300 - -private const val NO_LOG_MARKER = "(no log file found)" - -internal const val DIAGNOSTICS_LOG_HEADER = "--- Current log ---" - -/** - * What a support request needs pasted into it: the startup banner (version, channel, OS), the most - * recent crash dump when there is one, then the tail of the session's log. Always produces something, - * so a missing log costs the reporter the log rather than the whole report. - */ -suspend fun buildDiagnosticsReport( - logDirectoryPath: String, - fileSystem: FileSystem = getPlatformFilesystem(), -): String = withContext(platformIoDispatcher) { - val logDir = logDirectoryPath.toPath() - val crash = readLatestCrashSection(fileSystem, logDir) - val tail = readCurrentLogTail(fileSystem, logDir) - buildString { - append(startupBanner()) - if (crash != null) append("\n\n").append(crash) - append("\n\n").append(DIAGNOSTICS_LOG_HEADER).append('\n').append(tail ?: NO_LOG_MARKER) - } -} - -private fun readLatestCrashSection(fileSystem: FileSystem, logDir: Path): String? { - return try { - val crash = readLatestCrash(fileSystem, logDir) ?: return null - val crashedAt = crashDumpMillis(crash.fileName)?.let { " (${Instant.fromEpochMilliseconds(it)})" }.orEmpty() - val lines = crash.content.trim().lines() - val omitted = lines.size - DIAGNOSTICS_CRASH_LINES - buildString { - append("--- Latest crash: ${crash.fileName}$crashedAt ---\n") - append(lines.take(DIAGNOSTICS_CRASH_LINES).joinToString("\n")) - if (omitted > 0) append("\n($omitted more lines)") - } - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to read the latest crash dump", e) - null - } -} - -private fun readCurrentLogTail(fileSystem: FileSystem, logDir: Path): String? { - return try { - val logFile = currentLogFile(fileSystem, logDir) ?: return null - fileSystem.openReadOnly(logFile).use { handle -> - val from = (handle.size() - DIAGNOSTICS_TAIL_BYTES).coerceAtLeast(0L) - val buffer = Buffer() - handle.source(from).buffer().use { it.readAll(buffer) } - - val lines = buffer.readUtf8().lineSequence() - // Seeking by byte offset lands mid-line; drop the fragment rather than ship a torn line. - .let { if (from > 0L) it.drop(1) else it } - .toList() - lines.takeLast(DIAGNOSTICS_LOG_LINES).joinToString("\n").trim().ifEmpty { null } - } - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to read the current log file", e) - null - } -} - -private fun currentLogFile(fileSystem: FileSystem, logDir: Path): Path? { - if (!fileSystem.exists(logDir)) return null - return fileSystem.list(logDir) - .filter { it.name.endsWith(".txt") && !it.isCrashDump() } - .mapNotNull { path -> fileSystem.metadataOrNull(path)?.let { path to it } } - .filter { it.second.isRegularFile } - .maxByOrNull { it.second.lastModifiedAtMillis ?: 0L } - ?.first -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.kt index 98eb13aee..842d6fec0 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.kt @@ -1,25 +1,16 @@ package com.darkrockstudios.apps.hammer.common import com.darkrockstudios.apps.hammer.base.BuildMetadata -import com.darkrockstudios.apps.hammer.base.DistributionChannel -import com.darkrockstudios.apps.hammer.base.PackageFormat import io.github.aakira.napier.Napier /** * Logs a single identifying line as early as possible in startup: the build version plus * platform/environment details. First line in every log, so user-submitted logs are - * self-describing (version, channel, OS, display server, …) without a round-trip to ask. + * self-describing (version, OS, display server, …) without a round-trip to ask. */ fun logStartupBanner() { - Napier.i(startupBanner()) + Napier.i("Hammer v${BuildMetadata.APP_VERSION} | ${platformStartupInfo()}") } -/** The identifying line itself, shared by the startup banner and the crash dumps. */ -fun startupBanner(): String = - "Hammer v${BuildMetadata.APP_VERSION}" + - " | channel: ${DistributionChannel.current.token}" + - " | format: ${PackageFormat.current.token}" + - " | ${platformStartupInfo()}" - /** Platform + environment details for the startup banner. */ expect fun platformStartupInfo(): String diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/ProjectComponentBase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/ProjectComponentBase.kt index 96c99f423..8f0ca3d65 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/ProjectComponentBase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/ProjectComponentBase.kt @@ -7,9 +7,6 @@ import com.darkrockstudios.apps.hammer.common.data.projectInject import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndexService import com.darkrockstudios.apps.hammer.common.data.tagindex.TagSuggesting import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext abstract class ProjectComponentBase( val projectDef: ProjectDef, @@ -18,32 +15,9 @@ abstract class ProjectComponentBase( override val projectScope = ProjectDefScope(projectDef) private val tagIndexService: TagIndexService by projectInject() - private val projectSpellCheck: ProjectSpellCheckRepository by projectInject() override fun suggestTags(prefix: String, limit: Int): List = tagIndexService.suggest(prefix, limit).map { it.tag } - - /** Collects whether the project's language allows spell check; call from onCreate. [onChange] runs on the main dispatcher. */ - protected fun watchSpellCheckAllowed(onChange: (Boolean) -> Unit) { - scope.launch { - projectSpellCheck.spellCheckAllowed.collect { allowed -> - withContext(dispatcherMain) { - onChange(allowed) - } - } - } - } - - /** Collects whether encyclopedia names feed the spell-check dictionary (global AND project toggles); call from onCreate. [onChange] runs on the main dispatcher. */ - protected fun watchEncyclopediaDictionaryEnabled(onChange: (Boolean) -> Unit) { - scope.launch { - projectSpellCheck.encyclopediaDictionaryEnabled.collect { enabled -> - withContext(dispatcherMain) { - onChange(enabled) - } - } - } - } } abstract class SavableProjectComponentBase( diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntry.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntry.kt index 22668a92d..cebf3228c 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntry.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntry.kt @@ -12,9 +12,7 @@ interface CreateEntry : TagSuggesting { data class State( val projectDef: ProjectDef, - val showConfirmClose: Boolean = false, - val spellCheckAllowed: Boolean = true, - val dictionaryFeatureEnabled: Boolean = true, + val showConfirmClose: Boolean = false ) suspend fun createEntry( @@ -22,8 +20,7 @@ interface CreateEntry : TagSuggesting { type: EntryType, text: String, tags: Set, - imagePath: String?, - excludeFromDictionary: Boolean = false, + imagePath: String? ): EntryResult fun confirmClose() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntryComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntryComponent.kt index 19614dfe5..12b34f9ae 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntryComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/CreateEntryComponent.kt @@ -28,18 +28,6 @@ class CreateEntryComponent( // Note: Back handler is disabled to allow predictive back animation. // The UI handles close confirmation via confirmClose()/dismissConfirmClose(). - override fun onCreate() { - super.onCreate() - - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } - - watchEncyclopediaDictionaryEnabled { enabled -> - _state.getAndUpdate { it.copy(dictionaryFeatureEnabled = enabled) } - } - } - override fun confirmClose() { _state.getAndUpdate { it.copy(showConfirmClose = true) @@ -57,17 +45,9 @@ class CreateEntryComponent( type: EntryType, text: String, tags: Set, - imagePath: String?, - excludeFromDictionary: Boolean, + imagePath: String? ): EntryResult = withContext(dispatcherDefault) { - val result = encyclopediaService.createEntry( - name = name, - type = type, - text = text, - tags = tags, - imagePath = imagePath, - excludeFromDictionary = excludeFromDictionary, - ) + val result = encyclopediaService.createEntry(name, type, text, tags, imagePath) if (result.error == EntryError.NONE) { encyclopediaService.loadEntries() result.instance?.entry?.let { newEntry -> diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/EncyclopediaComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/EncyclopediaComponent.kt index a906a921b..da7056e51 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/EncyclopediaComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/EncyclopediaComponent.kt @@ -65,26 +65,19 @@ class EncyclopediaComponent( } override fun shouldConfirmClose(): Set { - val unsaved = stack.value.items.any { isUnsaved(it.instance) } - return if (unsaved) setOf(CloseConfirm.Encyclopedia) else emptySet() - } + val unsaved = when (val destination = stack.value.active.instance) { + is Encyclopedia.Destination.CreateEntryDestination -> true + is Encyclopedia.Destination.ViewEntryDestination -> { + destination.component.state.value.editName || destination.component.state.value.editText + } - private fun isUnsaved(destination: Encyclopedia.Destination) = when (destination) { - is Encyclopedia.Destination.CreateEntryDestination -> true - is Encyclopedia.Destination.ViewEntryDestination -> isEditing(destination.component) - else -> false - } - - private fun isEditing(entry: ViewEntry) = entry.state.value.let { it.editName || it.editText } - - override fun discardUnsaved(item: CloseConfirm) { - if (item != CloseConfirm.Encyclopedia) return - stack.value.items.forEach { child -> - val view = child.instance as? Encyclopedia.Destination.ViewEntryDestination ?: return@forEach - if (isEditing(view.component)) view.component.discardEdit() + else -> false } - if (stack.value.active.instance is Encyclopedia.Destination.CreateEntryDestination) { - navigation.pop() + + return if (unsaved) { + setOf(CloseConfirm.Encyclopedia) + } else { + emptySet() } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntry.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntry.kt index 486f6dbf5..d62cded49 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntry.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntry.kt @@ -27,8 +27,6 @@ interface ViewEntry : TagSuggesting { val showAliasAdd: Boolean = false, val menuItems: Set = emptySet(), val appearsIn: List = emptyList(), - val spellCheckAllowed: Boolean = true, - val dictionaryFeatureEnabled: Boolean = true, ) data class Appearance( @@ -59,9 +57,6 @@ interface ViewEntry : TagSuggesting { fun startTextEdit() fun finishNameEdit() fun finishTextEdit() - - /** Leaves name and text edit mode without saving; the UI reseeds its fields from [State.content]. */ - fun discardEdit() fun confirmClose() fun dismissConfirmClose() fun removeTag(tag: String) @@ -73,6 +68,5 @@ interface ViewEntry : TagSuggesting { fun endAliasAdd() suspend fun addAlias(alias: String): EntryResult fun removeAlias(alias: String) - suspend fun setExcludeFromDictionary(exclude: Boolean): EntryResult fun navigateToAppearance(appearance: Appearance) } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntryComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntryComponent.kt index a1d06667c..39116eb72 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntryComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/encyclopedia/ViewEntryComponent.kt @@ -13,7 +13,6 @@ import com.darkrockstudios.apps.hammer.common.data.MenuItemDescriptor import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaService import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryError -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryLoadError import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryResult import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContent import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef @@ -23,13 +22,8 @@ import com.darkrockstudios.apps.hammer.common.data.references.CleanupReferencesO import com.darkrockstudios.apps.hammer.common.data.references.ReferenceIndexService import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.data.tagindex.parseTagInput -import io.github.aakira.napier.Napier -import kotlinx.coroutines.flow.filter import kotlinx.coroutines.launch -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.withContext -import okio.IOException class ViewEntryComponent( componentContext: ComponentContext, @@ -54,8 +48,6 @@ class ViewEntryComponent( private val backfillEntryReferences: BackfillEntryReferencesUseCase by projectInject() private val cleanupReferencesOnDelete: CleanupReferencesOnEntryDeleteUseCase by projectInject() - private val reloadMutex = Mutex() - private val backButtonHandler = BackCallback(isEnabled = false) { // Only called when editing - show confirmation before discarding confirmClose() @@ -70,14 +62,6 @@ class ViewEntryComponent( backButtonHandler.isEnabled = it.editName || it.editText } - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } - - watchEncyclopediaDictionaryEnabled { enabled -> - _state.getAndUpdate { it.copy(dictionaryFeatureEnabled = enabled) } - } - // Trigger an initial recompute so the index reflects current data scope.launch { referenceIndexService.loadIndex() } @@ -102,50 +86,24 @@ class ViewEntryComponent( } reload() - watchEntry() - } - - // Follows writes made elsewhere (sync), including a rename that moves the entry's file. - private fun watchEntry() { - scope.launch { - val entryId = state.value.entryDef.id - encyclopediaService.entryChangedFlow.filter { it == entryId }.collect { - // The entry's files can be mid-move while a sync is writing them. - try { - val currentDef = encyclopediaService.findEntryDef(entryId) - ?: return@collect - withContext(dispatcherMain) { - _state.getAndUpdate { it.copy(entryDef = currentDef) } - } - loadEntryState() - } catch (e: EntryLoadError) { - Napier.w("Failed to refresh entry $entryId", e) - } catch (e: IOException) { - Napier.w("Failed to refresh entry $entryId", e) - } - } - } } private fun reload() { - scope.launch { loadEntryState() } - } + scope.launch { + val entryDef = state.value.entryDef + val entryImagePath = getImagePath(entryDef) + val imageHash = encyclopediaService.findEntryImageExtension(entryDef) + ?.let { ext -> encyclopediaService.calculateEntryImageHash(entryDef, ext) } - // Serialized so overlapping reloads can't land out of order. - private suspend fun loadEntryState() = reloadMutex.withLock { - val entryDef = state.value.entryDef - val entryImagePath = getImagePath(entryDef) - val imageHash = encyclopediaService.findEntryImageExtension(entryDef) - ?.let { ext -> encyclopediaService.calculateEntryImageHash(entryDef, ext) } - - val content = loadEntryContent(entryDef) - withContext(dispatcherMain) { - _state.getAndUpdate { - it.copy( - entryImagePath = entryImagePath, - entryImageHash = imageHash, - content = content - ) + val content = loadEntryContent(state.value.entryDef) + withContext(dispatcherMain) { + _state.getAndUpdate { + it.copy( + entryImagePath = entryImagePath, + entryImageHash = imageHash, + content = content + ) + } } } } @@ -237,37 +195,20 @@ class ViewEntryComponent( } } - override fun discardEdit() { - _state.getAndUpdate { - it.copy(editName = false, editText = false, confirmClose = false) - } - } - - /** - * Saves the entry as [transform] of its current content, sourcing unchanged fields from - * the loaded state or, if the async load hasn't landed yet, straight from disk - so a - * save can never revert a field to its default. - */ - private suspend fun saveEntry(transform: (EntryContent) -> EntryContent): EntryResult { - val current = state.value.content ?: loadEntryContent(state.value.entryDef) - val updated = transform(current) - return encyclopediaService.updateEntry( - oldEntryDef = state.value.entryDef, - name = updated.name, - text = updated.text, - tags = updated.tags, - aliases = updated.aliases, - excludeFromDictionary = updated.excludeFromDictionary, - ) - } - override suspend fun updateEntry( name: String, text: String, tags: Set ): EntryResult = withContext(dispatcherDefault) { + val currentAliases = state.value.content?.aliases.orEmpty() val previousName = state.value.entryDef.name - val result = saveEntry { it.copy(name = name, text = text, tags = tags) } + val result = encyclopediaService.updateEntry( + oldEntryDef = state.value.entryDef, + name = name, + text = text, + tags = tags, + aliases = currentAliases, + ) if (result.instance != null && result.error == EntryError.NONE) { _state.getAndUpdate { it.copy( @@ -303,8 +244,20 @@ class ViewEntryComponent( override fun removeTag(tag: String) { scope.launch { - saveEntry { it.copy(tags = it.tags - tag) } - reload() + state.value.content?.apply { + val newTags = tags.toMutableSet() + newTags.remove(tag) + + encyclopediaService.updateEntry( + oldEntryDef = state.value.entryDef, + name = name, + text = text, + tags = newTags, + aliases = aliases, + ) + + reload() + } } } @@ -331,7 +284,15 @@ class ViewEntryComponent( override suspend fun addTags(tagInput: String) = withContext(dispatcherDefault) { val newTags = parseTagInput(tagInput) - saveEntry { it.copy(tags = it.tags + newTags) } + state.value.content?.apply { + encyclopediaService.updateEntry( + oldEntryDef = state.value.entryDef, + name = name, + text = text, + tags = tags + newTags, + aliases = aliases, + ) + } endTagAdd() reload() @@ -346,12 +307,20 @@ class ViewEntryComponent( } override suspend fun addAlias(alias: String): EntryResult = withContext(dispatcherDefault) { + val current = state.value.content + ?: return@withContext EntryResult(EntryError.NONE) val trimmed = alias.trim() if (trimmed.isEmpty()) { endAliasAdd() return@withContext EntryResult(EntryError.NONE) } - val result = saveEntry { it.copy(aliases = it.aliases + trimmed) } + val result = encyclopediaService.updateEntry( + oldEntryDef = state.value.entryDef, + name = current.name, + text = current.text, + tags = current.tags, + aliases = current.aliases + trimmed, + ) if (result.error == EntryError.NONE) { endAliasAdd() reload() @@ -362,19 +331,19 @@ class ViewEntryComponent( override fun removeAlias(alias: String) { scope.launch { - saveEntry { it.copy(aliases = it.aliases.filterNot { a -> a == alias }) } - reload() - } - } + state.value.content?.apply { + encyclopediaService.updateEntry( + oldEntryDef = state.value.entryDef, + name = name, + text = text, + tags = tags, + aliases = aliases.filterNot { it == alias }, + ) - override suspend fun setExcludeFromDictionary(exclude: Boolean): EntryResult = - withContext(dispatcherDefault) { - val result = saveEntry { it.copy(excludeFromDictionary = exclude) } - if (result.error == EntryError.NONE) { reload() } - result } + } override fun navigateToAppearance(appearance: ViewEntry.Appearance) { showScene(appearance.sceneItem) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNote.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNote.kt index d528a58fd..1ccfd3627 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNote.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNote.kt @@ -12,7 +12,6 @@ interface CreateNote : TagSuggesting { @Serializable data class State( val confirmDiscard: Boolean = false, - val spellCheckAllowed: Boolean = true, ) suspend fun createNote(noteText: String, tags: Set): NoteError diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNoteComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNoteComponent.kt index 46e53ebb6..fa64d7642 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNoteComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/CreateNoteComponent.kt @@ -52,10 +52,6 @@ class CreateNoteComponent( noteText.subscribe(lifecycle) { backButtonHandler.isEnabled = it.isNotBlank() } - - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } } override fun onTextChanged(newText: String) { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/NotesComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/NotesComponent.kt index 811983d81..352c874fb 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/NotesComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/NotesComponent.kt @@ -59,24 +59,19 @@ class NotesComponent( } override fun shouldConfirmClose(): Set { - val unsaved = stack.value.items.any { isUnsaved(it.instance) } - return if (unsaved) setOf(CloseConfirm.Notes) else emptySet() - } + val unsaved = when (val destination = stack.value.active.instance) { + is Notes.Destination.CreateNoteDestination -> true + is Notes.Destination.ViewNoteDestination -> { + destination.component.isEditingAndDirty() + } - private fun isUnsaved(destination: Notes.Destination) = when (destination) { - is Notes.Destination.CreateNoteDestination -> true - is Notes.Destination.ViewNoteDestination -> destination.component.isEditingAndDirty() - else -> false - } - - override fun discardUnsaved(item: CloseConfirm) { - if (item != CloseConfirm.Notes) return - stack.value.items.forEach { child -> - val view = child.instance as? Notes.Destination.ViewNoteDestination ?: return@forEach - if (view.component.state.value.isEditing) view.component.discardEdit() + else -> false } - if (stack.value.active.instance is Notes.Destination.CreateNoteDestination) { - navigation.pop() + + return if (unsaved) { + setOf(CloseConfirm.Notes) + } else { + emptySet() } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNote.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNote.kt index 923fed1e3..841cfe8f9 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNote.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNote.kt @@ -19,7 +19,6 @@ interface ViewNote : TagSuggesting { val confirmDelete: Boolean = false, val isEditing: Boolean = false, val menuItems: Set = emptySet(), - val spellCheckAllowed: Boolean = true, ) fun discardEdit() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNoteComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNoteComponent.kt index 952abcbdf..caa185145 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNoteComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/notes/ViewNoteComponent.kt @@ -18,7 +18,6 @@ import com.darkrockstudios.apps.hammer.common.data.projectInject import com.darkrockstudios.apps.hammer.notes_menu_delete import com.darkrockstudios.apps.hammer.notes_menu_group import io.github.aakira.napier.Napier -import kotlinx.coroutines.launch import kotlinx.coroutines.withContext import kotlinx.serialization.Serializable @@ -51,8 +50,6 @@ class ViewNoteComponent( private val _noteText = MutableValue(restoredDraft?.noteText ?: "") override val noteText: Value = _noteText - private var dismissed = false - private val backButtonHandler = BackCallback(isEnabled = false) { if (isEditingAndDirty()) { confirmDiscard() @@ -79,34 +76,7 @@ class ViewNoteComponent( backButtonHandler.isEnabled = it.isEditing } - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } - loadInitialContent() - watchNotes() - } - - // Follows writes made elsewhere (sync). A dirty edit keeps its draft, only the baseline moves. - private fun watchNotes() { - scope.launch { - notesRepository.notesListFlow.collect { notes -> - val updated = notes.find { it.note.id == noteId }?.note - withContext(dispatcherMain) { - if (updated == null) { - // Deleted elsewhere. A dirty edit stays open so its draft isn't lost. - if (state.value.note != null && !isEditingAndDirty()) dismiss() - return@withContext - } - if (updated == state.value.note) return@withContext - val keepDraft = isEditingAndDirty() - _state.getAndUpdate { - it.copy(note = updated, tags = if (keepDraft) it.tags else updated.tags) - } - if (!keepDraft) _noteText.update { updated.content } - } - } - } } override fun onContentChanged(newContent: String) { @@ -162,7 +132,7 @@ class ViewNoteComponent( override suspend fun deleteNote(id: Int) = withContext(dispatcherDefault) { notesRepository.deleteNote(id) notesRepository.loadNotes() - withContext(dispatcherMain) { dismiss() } + withContext(dispatcherMain) { dismissView() } } override fun confirmDelete() { @@ -175,12 +145,6 @@ class ViewNoteComponent( override fun closeNote() { if (state.value.isEditing) discardEdit() - dismiss() - } - - private fun dismiss() { - if (dismissed) return - dismissed = true dismissView() } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/DocxStoryRenderer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/DocxStoryRenderer.kt index c329ae1f0..7bf645eab 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/DocxStoryRenderer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/DocxStoryRenderer.kt @@ -3,7 +3,6 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome import com.darkrockstudios.apps.hammer.base.BuildMetadata import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectTheme -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import nl.adaptivity.xmlutil.XMLConstants import nl.adaptivity.xmlutil.XmlDeclMode import nl.adaptivity.xmlutil.XmlWriter @@ -58,7 +57,6 @@ fun writeStoryAsDocx( projectData: ProjectData, chapters: List, strings: ExportStrings, - options: ExportOptions = ExportOptions(), ) { val authorName = projectData.authorName?.takeIf { it.isNotBlank() } val effective = chapters.ifEmpty { listOf(StoryChapter(projectName, "")) } @@ -66,14 +64,14 @@ fun writeStoryAsDocx( // The body walk collects hyperlink targets and ordered-list instances that // document.xml.rels and numbering.xml must declare, so it runs first. val ctx = DocxRenderContext() - val documentXml = buildXmlPart { writeDocument(it, ctx, projectName, strings, effective, options) } + val documentXml = buildXmlPart { writeDocument(it, ctx, projectName, strings, effective) } val zip = OkioZipOutputStream(sink) zip.putEntry("[Content_Types].xml", buildXmlPart(::writeContentTypes)) zip.putEntry("_rels/.rels", buildXmlPart(::writePackageRels)) zip.putEntry("docProps/core.xml", buildXmlPart { writeCoreProps(it, projectName, authorName) }) zip.putEntry("docProps/app.xml", buildXmlPart(::writeAppProps)) - zip.putEntry("word/styles.xml", buildXmlPart { writeStyles(it, projectData.theme, options.font.faceName) }) + zip.putEntry("word/styles.xml", buildXmlPart { writeStyles(it, projectData.theme) }) zip.putEntry("word/numbering.xml", buildXmlPart { writeNumbering(it, ctx.orderedListLevels) }) zip.putEntry( "word/_rels/document.xml.rels", @@ -221,7 +219,7 @@ private fun writeAppProps(writer: XmlWriter) { } } -private fun writeStyles(writer: XmlWriter, theme: ProjectTheme?, bodyFont: String) { +private fun writeStyles(writer: XmlWriter, theme: ProjectTheme?) { val primary = theme?.primary?.let(::argbHexToCssHex)?.removePrefix("#") val secondary = theme?.secondary?.let(::argbHexToCssHex)?.removePrefix("#") @@ -255,7 +253,7 @@ private fun writeStyles(writer: XmlWriter, theme: ProjectTheme?, bodyFont: Strin w("docDefaults") { w("rPrDefault") { w("rPr") { - rFonts(bodyFont) + rFonts(EXPORT_BODY_FONT) size(24) } } @@ -396,15 +394,14 @@ private fun writeDocument( projectName: String, strings: ExportStrings, chapters: List, - options: ExportOptions, ) { writer.smartStartTag(W_NS, "document", "w") { namespaceAttr("r", R_NS) w("body") { writeTitlePage(projectName, strings.authorByline) - writeContentsPage(chapters, strings.contentsTitle, options.numberChapters) + writeContentsPage(chapters, strings.contentsTitle) chapters.forEachIndexed { index, chapter -> - writeChapter(ctx, index, chapter, options) + writeChapter(ctx, index, chapter) } w("sectPr") { w("pgSz") { @@ -452,11 +449,7 @@ private fun XmlWriter.writeTitlePage(projectName: String, authorByline: String?) } } -private fun XmlWriter.writeContentsPage( - chapters: List, - contentsTitle: String, - numberChapters: Boolean, -) { +private fun XmlWriter.writeContentsPage(chapters: List, contentsTitle: String) { w("p") { w("pPr") { wVal("pStyle", "TocTitle") @@ -477,7 +470,7 @@ private fun XmlWriter.writeContentsPage( w("rPr") { wVal("rStyle", "Hyperlink") } w("t") { preserveSpace() - text(chapterTitle(index, chapter, numberChapters)) + text("${index + 1}. ${chapter.name}") } } } @@ -485,12 +478,7 @@ private fun XmlWriter.writeContentsPage( } } -private fun XmlWriter.writeChapter( - ctx: DocxRenderContext, - index: Int, - chapter: StoryChapter, - options: ExportOptions, -) { +private fun XmlWriter.writeChapter(ctx: DocxRenderContext, index: Int, chapter: StoryChapter) { w("p") { w("pPr") { wVal("pStyle", "Heading1") @@ -503,13 +491,13 @@ private fun XmlWriter.writeChapter( w("r") { w("t") { preserveSpace() - text(chapterTitle(index, chapter, options.numberChapters)) + text("${index + 1}. ${chapter.name}") } } w("bookmarkEnd") { wAttr("id", index.toString()) } } if (chapter.markdown.isNotBlank()) { - MarkdownDocxWriter(this, ctx, options.keepBlankLines).render(chapter.markdown) + MarkdownDocxWriter(this, ctx).render(chapter.markdown) } } @@ -522,19 +510,11 @@ private fun XmlWriter.writeChapter( private class MarkdownDocxWriter( private val writer: XmlWriter, private val ctx: DocxRenderContext, - private val keepBlankLines: Boolean, ) { fun render(markdown: String) { - val blocks = parseProseMarkdown(markdown, keepBlankLines) - blocks.forEachIndexed { index, block -> - // Prose runs tight: the indent parts one line from the next, and the space a passage - // break wants is a blank line the author typed. Space after is for leaving prose behind. - val runsOn = blocks.getOrNull(index + 1)?.isProseLine == true + for (block in parseProseMarkdown(markdown)) { when (block) { - is ProseBlock.Paragraph -> - paragraph(style = null, numId = null, tight = runsOn) { runs(block.spans) } - - ProseBlock.Blank -> paragraph(style = null, numId = null, tight = runsOn) {} + is ProseBlock.Paragraph -> paragraph(style = null, numId = null) { runs(block.spans) } is ProseBlock.Heading -> paragraph(style = "Heading${block.level}", numId = null) { runs(block.spans) } is ProseBlock.Listing -> { val numbering = DocxListNumbering(ctx) @@ -639,17 +619,11 @@ private class MarkdownDocxWriter( } } - private fun paragraph( - style: String?, - numId: Int?, - ilvl: Int = 0, - tight: Boolean = false, - body: () -> Unit, - ) { + private fun paragraph(style: String?, numId: Int?, ilvl: Int = 0, body: () -> Unit) { // Plain prose gets the first-line-indented body style; numbered paragraphs control their own indent. val effectiveStyle = style ?: if (numId == null) "BodyText" else null writer.w("p") { - if (effectiveStyle != null || numId != null || tight) { + if (effectiveStyle != null || numId != null) { w("pPr") { effectiveStyle?.let { wVal("pStyle", it) } if (numId != null) { @@ -658,8 +632,6 @@ private class MarkdownDocxWriter( wVal("numId", numId.toString()) } } - // Overrides the document default, which would otherwise gap every line of prose. - if (tight) w("spacing") { wAttr("after", "0") } } } body() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/EpubStoryRenderer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/EpubStoryRenderer.kt index ba04ece5b..7df17cda7 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/EpubStoryRenderer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/EpubStoryRenderer.kt @@ -2,17 +2,13 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectTheme -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import io.documentnode.epub4kmp.domain.* import io.documentnode.epub4kmp.epub.EpubWriter import kotlinx.html.* import kotlinx.html.stream.appendHTML import okio.BufferedSink -import com.darkrockstudios.apps.hammer.base.markdown.ProseHtml import org.intellij.markdown.flavours.gfm.GFMFlavourDescriptor import org.intellij.markdown.html.HtmlGenerator -import org.intellij.markdown.parser.LinkMap import org.intellij.markdown.parser.MarkdownParser private data class TocEntry(val title: String, val href: String) @@ -24,7 +20,6 @@ fun writeStoryAsEpub( chapters: List, language: String, strings: ExportStrings, - options: ExportOptions = ExportOptions(), ) { val authorName = projectData.authorName?.takeIf { it.isNotBlank() } @@ -33,11 +28,11 @@ fun writeStoryAsEpub( authorName?.let { metadata.addAuthor(parseAuthor(it)) } metadata.language = language - addStylesheet(buildStylesheet(projectData.theme, options.font)) + addStylesheet(buildStylesheet(projectData.theme)) val effective = chapters.ifEmpty { listOf(StoryChapter(projectName, "")) } val tocEntries = effective.mapIndexed { index, chapter -> - TocEntry(title = chapterTitle(index, chapter, options.numberChapters), href = "ch${index + 1}.xhtml") + TocEntry(title = chapter.name, href = "ch${index + 1}.xhtml") } // Title page, contents page, then the chapters. @@ -69,7 +64,7 @@ fun writeStoryAsEpub( id = "ch${index + 1}", href = entry.href, title = chapter.name, - bodyBuilder = { chapterBody(entry.title, chapter.markdown, options.keepBlankLines) }, + bodyBuilder = { chapterBody(chapter.name, chapter.markdown) }, ), ) } @@ -83,15 +78,12 @@ fun writeStoryAsEpub( * plus theme overlays — primary on h1 and links, secondary on h2, and a primary-colored title-page rule — * so the exported book inherits the project's chosen accent colors. */ -private fun buildStylesheet(theme: ProjectTheme?, font: ExportFont): Stylesheet = stylesheet { +private fun buildStylesheet(theme: ProjectTheme?): Stylesheet = stylesheet { raw(Stylesheets.defaultReader().css) - raw("body { font-family: ${font.cssFamily}; }") // Title page presentation — applies even without a theme. raw( """ - /* Each authored line is its own paragraph, so the indent has to be the only separator */ - p { margin: 0; } body.title-page { text-align: center; margin: 0; } .title-page-inner { margin-top: 30%; padding: 0 2em; } h1.book-title { font-size: 2.5em; margin: 0 0 0.4em 0; page-break-before: auto; } @@ -177,13 +169,11 @@ private fun BODY.titlePageBody(projectName: String, authorName: String?) { } } -private fun BODY.chapterBody(chapterTitle: String, markdown: String, keepBlankLines: Boolean) { +private fun BODY.chapterBody(chapterTitle: String, markdown: String) { h1(classes = "chapter-title") { +chapterTitle } val flavour = GFMFlavourDescriptor() - val source = ProseHtml.normalizeLineEndings(markdown) - val parsed = MarkdownParser(flavour).buildMarkdownTreeFromString(source) - val providers = ProseHtml.providers(flavour, LinkMap.buildLinkMap(parsed, source), keepBlankLines) - val htmlBody = HtmlGenerator(source, parsed, providers).generateHtml() + val parsed = MarkdownParser(flavour).buildMarkdownTreeFromString(markdown) + val htmlBody = HtmlGenerator(markdown, parsed, flavour).generateHtml() val xhtmlBody = htmlBody.selfCloseHtmlVoidTags() unsafe { +xhtmlBody } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ExportStoryUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ExportStoryUseCase.kt index 68ac42b31..18414f013 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ExportStoryUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ExportStoryUseCase.kt @@ -6,8 +6,7 @@ import com.darkrockstudios.apps.hammer.common.data.ExportOptions import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.tree.ChapterScenes -import com.darkrockstudios.apps.hammer.common.data.tree.collectChapters +import com.darkrockstudios.apps.hammer.common.data.tree.TreeValue import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectDefaultDispatcher import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectIoDispatcher import com.darkrockstudios.apps.hammer.common.fileio.HPath @@ -94,15 +93,13 @@ class ExportStoryUseCase( /** Reads source data off [ioDispatcher], then renders the document into an in-memory buffer on [defaultDispatcher]. */ private suspend fun render(projectName: String, options: ExportOptions): Buffer { val source = withContext(ioDispatcher) { - val perNodeChapters = sceneEditorRepository.getSceneTree().collectChapters().mapNotNull { chapter -> - chapterFor(chapter, options) + val perNodeChapters = sceneEditorRepository.getSceneTree().root.children.map { node -> + StoryChapter(name = node.value.name, markdown = collectMarkdown(node)) } val projectData = if (options.format == ExportFormat.Markdown) null else projectDataDatasource.load().data - // The project's declared language wins; the device locale is only a fallback. - val language = projectData?.language?.takeIf { it.isNotBlank() } - ?: localeResolver.getCurrentLocale().language?.takeIf { it.isNotBlank() } - ?: "en" + val language = + localeResolver.getCurrentLocale().language?.takeIf { it.isNotBlank() } ?: "en" ExportSource(perNodeChapters, projectData, language) } @@ -116,7 +113,6 @@ class ExportStoryUseCase( projectName = projectName, chapters = source.perNodeChapters, treatTopLevelAsChapters = options.treatTopLevelAsChapters, - numberChapters = options.numberChapters, ) ExportFormat.Epub -> writeStoryAsEpub( @@ -126,7 +122,6 @@ class ExportStoryUseCase( chapters = chaptersFor(options, projectName, source.perNodeChapters), language = source.language, strings = exportStrings, - options = options, ) ExportFormat.Pdf -> writeStoryAsPdf( @@ -135,7 +130,6 @@ class ExportStoryUseCase( projectData = source.requireProjectData(), chapters = chaptersFor(options, projectName, source.perNodeChapters), strings = exportStrings, - options = options, ) ExportFormat.Docx -> writeStoryAsDocx( @@ -144,7 +138,6 @@ class ExportStoryUseCase( projectData = source.requireProjectData(), chapters = chaptersFor(options, projectName, source.perNodeChapters), strings = exportStrings, - options = options, ) ExportFormat.Rtf -> writeStoryAsRtf( @@ -153,7 +146,6 @@ class ExportStoryUseCase( projectData = source.requireProjectData(), chapters = chaptersFor(options, projectName, source.perNodeChapters), strings = exportStrings, - options = options, ) } buffer @@ -177,39 +169,16 @@ class ExportStoryUseCase( ): List = if (options.treatTopLevelAsChapters) { perNodeChapters } else { - listOf(StoryChapter(projectName, perNodeChapters.joinToString(sceneSeparator(options)) { it.markdown })) + listOf(StoryChapter(projectName, perNodeChapters.joinToString("\n\n") { it.markdown })) } - /** - * Builds the chapter for one top-level node under an optional scene filter. - * Returns null when a filter is active and the node contributes no selected scenes, - * dropping it from the chapter list so later chapters renumber automatically. - * A filter never widens: an empty or fully stale set yields zero chapters. - */ - private fun chapterFor(chapter: ChapterScenes, options: ExportOptions): StoryChapter? { - val sceneFilter = options.sceneIds - val included = if (sceneFilter == null) { - chapter.scenes + private fun collectMarkdown(node: TreeValue): String { + return if (node.value.type == SceneItem.Type.Scene) { + sceneEditorRepository.loadSceneMarkdownRaw(node.value) } else { - chapter.scenes.filter { it.id in sceneFilter } + node.filter { it.value.type == SceneItem.Type.Scene } + .joinToString("\n\n") { sceneEditorRepository.loadSceneMarkdownRaw(it.value) } } - if (sceneFilter != null && included.isEmpty()) return null - return StoryChapter( - name = chapter.chapter.name, - markdown = included.joinToString(sceneSeparator(options)) { currentMarkdown(it) }, - ) } - /** The scene as the editor shows it: an unsaved buffer wins over the file on disk. */ - private fun currentMarkdown(scene: SceneItem): String = - sceneEditorRepository.getSceneBuffer(scene)?.content?.coerceMarkdown() - ?: sceneEditorRepository.loadSceneMarkdownRaw(scene) - - /** - * What goes between two scenes. A renderer that drops lone blank lines still keeps a run of two, - * so the wider gap is what carries the scene break through. - */ - private fun sceneSeparator(options: ExportOptions): String = - if (options.keepBlankLines || options.format == ExportFormat.Markdown) "\n\n" else "\n\n\n" - } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/MarkdownStoryRenderer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/MarkdownStoryRenderer.kt index ec86b9db1..3553f3ff9 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/MarkdownStoryRenderer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/MarkdownStoryRenderer.kt @@ -7,13 +7,12 @@ fun writeStoryAsMarkdown( projectName: String, chapters: List, treatTopLevelAsChapters: Boolean, - numberChapters: Boolean = false, ) { sink.writeUtf8("# $projectName\n\n") chapters.forEachIndexed { index, chapter -> if (treatTopLevelAsChapters) { - sink.writeUtf8("\n## ${chapterTitle(index, chapter, numberChapters)}\n\n") + sink.writeUtf8("\n## ${index + 1}. ${chapter.name}\n\n") } else if (index > 0) { sink.writeUtf8("\n\n") } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfProseMarkdown.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfProseMarkdown.kt index a5d854398..e5642f05d 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfProseMarkdown.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfProseMarkdown.kt @@ -1,20 +1,12 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome import com.conamobile.pdfkmp.dsl.ContainerScope -import com.darkrockstudios.apps.hammer.base.markdown.ProseHtml -import com.darkrockstudios.apps.hammer.common.data.search.unescapeMarkdown import com.conamobile.pdfkmp.dsl.TextScope import com.conamobile.pdfkmp.geometry.Padding import com.conamobile.pdfkmp.layout.BoxAlignment -import com.conamobile.pdfkmp.layout.RichLine import com.conamobile.pdfkmp.layout.VerticalAlignment -import com.conamobile.pdfkmp.layout.layoutRichText -import com.conamobile.pdfkmp.node.Span -import com.conamobile.pdfkmp.render.FontMetrics import com.conamobile.pdfkmp.style.BorderSides import com.conamobile.pdfkmp.style.BorderStroke -import com.conamobile.pdfkmp.style.CornerRadius -import com.conamobile.pdfkmp.style.FontStyle import com.conamobile.pdfkmp.style.FontWeight import com.conamobile.pdfkmp.style.PdfColor import com.conamobile.pdfkmp.style.TableBorder @@ -41,122 +33,6 @@ internal data class ProseColors( val link: PdfColor get() = primary ?: PdfColor.Blue } -/** - * Parsed prose with its text already wrapped into lines. pdfkmp cannot split a rich-text - * paragraph, a row or a decorated container across pages, so each wrapped line is laid out as - * its own node and page breaks fall between lines. - * - * @property layouts parallel to [blocks]; null for a block that needs no measuring. - */ -internal class PreparedProse( - val blocks: List, - val layouts: List, -) - -/** The measured part of one [ProseBlock]. */ -internal sealed interface ProseLayout { - data class Paragraph(val lines: List) : ProseLayout - - /** One list of lines per list item. */ - data class Listing(val items: List>) : ProseLayout - - /** One list of lines per quoted paragraph. */ - data class Quote(val paragraphs: List>) : ProseLayout - - /** @property width the widest code line, so every line's background spans the same width. */ - data class Code(val width: Float) : ProseLayout - - /** Body rows of wrapped cells. A source row too tall for a page arrives as several rows. */ - data class Table(val rows: List>>) : ProseLayout -} - -/** - * Parses [markdown] and wraps its text to [width], the width of the container - * [proseMarkdown] will render into. - */ -internal fun prepareProse( - markdown: String, - colors: ProseColors, - metrics: FontMetrics, - width: Float, - keepBlankLines: Boolean = true, -): PreparedProse { - fun wrap( - spans: List, - style: TextStyle, - lineWidth: Float, - lineHeight: Sp = style.lineHeight, - indent: Boolean = false, - ): List { - val styled = spans.map { Span(it.text, style.withFlags(it, colors)) }.toMutableList() - if (indent) { - // Each line is laid out again on its own, where an indent in the first word's style - // is one token with that word; measure it as one here too. - val first = styled.firstOrNull() - if (first != null && first.style == style) { - styled[0] = first.copy(text = FIRST_LINE_INDENT + first.text) - } else { - styled.add(0, Span(FIRST_LINE_INDENT, style)) - } - } - val measured = layoutRichText(styled, lineWidth, style.align, lineHeight, metrics) - // A line laid out alone would resolve its direction from its own first strong character. - return measured.lines.map { line -> - line.copy( - segments = line.segments.map { - it.copy(style = it.style.copy(direction = measured.resolvedDirection)) - }, - ) - } - } - - val blocks = parseProseMarkdown(markdown, keepBlankLines) - val layouts = blocks.map { block -> - when (block) { - is ProseBlock.Paragraph -> - if (block.isStandaloneLink) null - else ProseLayout.Paragraph(wrap(block.spans, BODY_STYLE, width, indent = true)) - - is ProseBlock.Listing -> { - val textWidth = width - block.markerWidth.value - ProseLayout.Listing(block.items.map { wrap(it.spans, BODY_STYLE, textWidth) }) - } - - is ProseBlock.Quote -> { - val textWidth = width - QUOTE_INSET_LEFT.value - QUOTE_INSET_RIGHT.value - QUOTE_BAR_WIDTH.value - ProseLayout.Quote(block.paragraphs.map { wrap(it, QUOTE_STYLE, textWidth) }) - } - - is ProseBlock.CodeBlock -> { - val widest = block.lines.maxOf { metrics.measure(it, CODE_STYLE).width } - ProseLayout.Code(widest.coerceAtMost(width - CODE_PADDING.value * 2)) - } - - is ProseBlock.Table -> { - val cellWidth = width / block.columnCount - TABLE_CELL_PADDING.value * 2 - TABLE_CELL_SLACK - ProseLayout.Table( - block.rows.flatMap { row -> - val cells = List(block.columnCount) { column -> - wrap(row.getOrElse(column) { emptyList() }, BODY_STYLE, cellWidth, lineHeight = Sp.Zero) - } - val tallest = cells.maxOf { it.size } - if (tallest <= MAX_TABLE_ROW_LINES) { - listOf(cells) - } else { - List((tallest + SPLIT_TABLE_ROW_LINES - 1) / SPLIT_TABLE_ROW_LINES) { part -> - cells.map { it.drop(part * SPLIT_TABLE_ROW_LINES).take(SPLIT_TABLE_ROW_LINES) } - } - } - }, - ) - } - - else -> null - } - } - return PreparedProse(blocks, layouts) -} - /** * Renders markdown prose into a PDF container with book typography: every paragraph gets * a first-line indent, and consecutive paragraphs run without a blank line between them — @@ -166,31 +42,29 @@ internal fun prepareProse( * `~~strikethrough~~` and pipe tables work) instead of pdfkmp's markdown module, whose * layout offers no paragraph indent control. */ -internal fun ContainerScope.proseMarkdown(prose: PreparedProse, colors: ProseColors = ProseColors()) { - val blocks = prose.blocks +internal fun ContainerScope.proseMarkdown(markdown: String, colors: ProseColors = ProseColors()) { + val blocks = parseProseMarkdown(markdown) if (blocks.isEmpty()) return - val base = BODY_STYLE + val base = TextStyle(lineHeight = Sp(TextStyle().fontSize.value * BODY_LEADING)) column { blocks.forEachIndexed { index, block -> if (index > 0) { val previous = blocks[index - 1] when { - // Prose carries its own separation: the indent, and the author's blank lines. - previous.isProseLine && block.isProseLine -> Unit + // Consecutive paragraphs carry their own separation via the indent. + previous is ProseBlock.Paragraph && block is ProseBlock.Paragraph -> Unit previous is ProseBlock.Heading -> spacer(height = HEADING_SPACING) else -> spacer(height = BLOCK_SPACING) } } - val layout = prose.layouts[index] when (block) { - is ProseBlock.Paragraph -> renderParagraph(block, layout as ProseLayout.Paragraph?, colors) - ProseBlock.Blank -> spacer(height = Dp(TextStyle().fontSize.value * BODY_LEADING)) + is ProseBlock.Paragraph -> renderParagraph(block.spans, base, colors) is ProseBlock.Heading -> renderHeading(block, base, colors) - is ProseBlock.Listing -> renderListing(block, layout as ProseLayout.Listing) - is ProseBlock.Quote -> renderQuote(layout as ProseLayout.Quote) - is ProseBlock.CodeBlock -> renderCode(block, layout as ProseLayout.Code) + is ProseBlock.Listing -> renderListing(block, base, colors) + is ProseBlock.Quote -> renderQuote(block, base, colors) + is ProseBlock.CodeBlock -> renderCode(block, base) ProseBlock.Rule -> divider() - is ProseBlock.Table -> renderTable(block, layout as ProseLayout.Table, base, colors) + is ProseBlock.Table -> renderTable(block, base, colors) } } } @@ -219,12 +93,7 @@ internal data class ProseListItem( /** A block-level markdown element, reduced to what the prose layout renders. */ internal sealed interface ProseBlock { - /** One line of prose as the author typed it. */ data class Paragraph(val spans: List) : ProseBlock - - /** A blank line the author left between two passages. */ - data object Blank : ProseBlock - data class Heading(val level: Int, val spans: List) : ProseBlock data class Listing(val ordered: Boolean, val items: List) : ProseBlock data class Quote(val paragraphs: List>) : ProseBlock @@ -236,40 +105,12 @@ internal sealed interface ProseBlock { /** * Parses [markdown] into renderable blocks using the GFM flavour, so `~~strike~~`, pipe tables, and * autolinks are recognized. Unknown syntax degrades to paragraph text. - * - * Prose keeps the shape the author gave it, which is what the editor shows them: every newline - * starts a new [ProseBlock.Paragraph] and every blank line becomes a [ProseBlock.Blank]. CommonMark - * would reflow both away, turning a page of dialogue into one packed block. - * - * With [keepBlankLines] off a lone blank line is dropped, leaving paragraphs to run together, and a - * run of two or more is reduced to one: the break between passages or scenes. */ -internal fun parseProseMarkdown(markdown: String, keepBlankLines: Boolean = true): List { - val source = ProseHtml.normalizeLineEndings(markdown) - val root = MarkdownParser(GFMFlavourDescriptor()).buildMarkdownTreeFromString(source) - val blocks = ProseWalker(source).blocks(root) - return if (keepBlankLines) blocks else blocks.withoutParagraphGaps() +internal fun parseProseMarkdown(markdown: String): List { + val root = MarkdownParser(GFMFlavourDescriptor()).buildMarkdownTreeFromString(markdown) + return ProseWalker(markdown).blocks(root) } -private fun List.withoutParagraphGaps(): List { - val out = mutableListOf() - var blanks = 0 - for (block in this) { - if (block == ProseBlock.Blank) { - blanks++ - continue - } - if (blanks >= 2) out += ProseBlock.Blank - blanks = 0 - out += block - } - return out -} - -/** True for the block kinds that make up running prose, as opposed to a structural block. */ -internal val ProseBlock.isProseLine: Boolean - get() = this is ProseBlock.Paragraph || this is ProseBlock.Blank - // --------------------------------------------------------------------------- // AST walking // --------------------------------------------------------------------------- @@ -287,99 +128,37 @@ private val HEADING_LEVELS: Map = mapOf( private class ProseWalker(private val source: String) { - /** - * Walks the top level, keeping the blank lines between prose passages. A run of newlines - * separating two paragraphs is one more than the blank lines it contains; only prose gets them, - * because a heading, list or rule carries its own spacing already. - */ - fun blocks(root: ASTNode): List { - val out = mutableListOf() - var newlines = 0 - var afterProse = false + fun blocks(root: ASTNode): List = root.children.mapNotNull { block(it) } - for (child in root.children) { - if (child.type == MarkdownTokenTypes.EOL) { - newlines++ - continue - } - if (child.type == MarkdownTokenTypes.WHITE_SPACE) continue + private fun block(node: ASTNode): ProseBlock? = when (node.type) { + MarkdownElementTypes.PARAGRAPH -> + inline(node).ifEmpty { null }?.let { ProseBlock.Paragraph(it) } - val produced = block(child) - if (produced.isEmpty()) continue - - if (afterProse && produced.first().isProseLine) { - val blanks = (newlines - 1).coerceIn(0, ProseHtml.MAX_CONSECUTIVE_BREAKS) - repeat(blanks) { out += ProseBlock.Blank } - } - out += produced - afterProse = produced.last().isProseLine - newlines = 0 - } - - return out - } - - private fun block(node: ASTNode): List = when (node.type) { - MarkdownElementTypes.PARAGRAPH -> paragraphs(node) - - in HEADING_LEVELS -> listOfNotNull(heading(node)) + in HEADING_LEVELS -> heading(node) MarkdownElementTypes.UNORDERED_LIST -> - listOf(ProseBlock.Listing(ordered = false, items = listItems(node, level = 0, ordered = false))) + ProseBlock.Listing(ordered = false, items = listItems(node, level = 0, ordered = false)) MarkdownElementTypes.ORDERED_LIST -> - listOf(ProseBlock.Listing(ordered = true, items = listItems(node, level = 0, ordered = true))) + ProseBlock.Listing(ordered = true, items = listItems(node, level = 0, ordered = true)) MarkdownElementTypes.BLOCK_QUOTE -> - listOfNotNull(quoteParagraphs(node).ifEmpty { null }?.let { ProseBlock.Quote(it) }) + quoteParagraphs(node).ifEmpty { null }?.let { ProseBlock.Quote(it) } - MarkdownElementTypes.CODE_FENCE -> listOf(ProseBlock.CodeBlock(fenceContent(node))) - MarkdownElementTypes.CODE_BLOCK -> listOf(ProseBlock.CodeBlock(indentedCode(node))) + MarkdownElementTypes.CODE_FENCE -> ProseBlock.CodeBlock(fenceContent(node)) + MarkdownElementTypes.CODE_BLOCK -> ProseBlock.CodeBlock(indentedCode(node)) - MarkdownTokenTypes.HORIZONTAL_RULE -> listOf(ProseBlock.Rule) + MarkdownTokenTypes.HORIZONTAL_RULE -> ProseBlock.Rule - GFMElementTypes.TABLE -> listOfNotNull(table(node)) + GFMElementTypes.TABLE -> table(node) - // Reference-link definitions produce no output. - MarkdownElementTypes.LINK_DEFINITION -> emptyList() + // Reference-link definitions and inter-block whitespace produce no output. + MarkdownElementTypes.LINK_DEFINITION, + MarkdownTokenTypes.EOL, + MarkdownTokenTypes.WHITE_SPACE, + -> null - else -> paragraphs(node) - } - - /** A paragraph node, split into one block per line the author typed. */ - private fun paragraphs(node: ASTNode): List = - if (node.children.isEmpty()) { - listOfNotNull(inline(node).ifEmpty { null }?.let { ProseBlock.Paragraph(it) }) - } else { - lines(node).map { ProseBlock.Paragraph(it) } - } - - /** The inline content of [holder], cut at every newline the author typed. */ - private fun lines(holder: ASTNode): List> { - val lines = mutableListOf>() - var current = mutableListOf() - - fun endLine() { - normalise(current).ifEmpty { null }?.let { lines += it } - current = mutableListOf() - } - - for (child in holder.children) { - when (child.type) { - MarkdownTokenTypes.EOL -> endLine() - - // The trailing spaces of a hard break are redundant: the newline itself breaks here. - MarkdownTokenTypes.HARD_LINE_BREAK -> Unit - - // A quote's own '>' markers sit inside the paragraph, on every line but the first. - MarkdownTokenTypes.BLOCK_QUOTE -> Unit - - else -> collect(child, Flags(), current) - } - } - endLine() - - return lines + else -> inline(node).ifEmpty { null }?.let { ProseBlock.Paragraph(it) } } private fun heading(node: ASTNode): ProseBlock? { @@ -434,8 +213,7 @@ private class ProseWalker(private val source: String) { MarkdownTokenTypes.WHITE_SPACE, -> Unit - // A quoted passage keeps its lines, the same as prose outside the quote. - else -> paragraphs += lines(child) + else -> inline(child).ifEmpty { null }?.let { paragraphs += it } } } return paragraphs @@ -648,86 +426,12 @@ private val CODE_BACKGROUND = PdfColor(0.95f, 0.95f, 0.95f) private const val BODY_LEADING = 1.5f private const val HEADING_LEADING = 1.25f -private val BODY_STYLE = TextStyle(lineHeight = Sp(TextStyle().fontSize.value * BODY_LEADING)) -private val QUOTE_STYLE = BODY_STYLE.copy(color = PdfColor.Gray) - -/** No bundled monospace face; code is approximated with a smaller size on a grey card. */ -private val CODE_STYLE = TextStyle(fontSize = Sp(TextStyle().fontSize.value * 0.9f)) - -/** Lines of a paragraph kept on one page at either side of a page break. */ -private const val MIN_LINES_AT_BREAK = 2 - -private val ITEM_SPACING = Dp(4f) -private val QUOTE_INSET_LEFT = Dp(12f) -private val QUOTE_INSET_RIGHT = Dp(4f) -private val QUOTE_INSET_VERTICAL = Dp(4f) -private val QUOTE_BAR_WIDTH = Dp(3f) -private val CODE_PADDING = Dp(12f) -private val CODE_CORNER = Dp(4f) -private val TABLE_CELL_PADDING = Dp(8f) - -/** Shaved off the wrap width of a cell so table rules never push a wrapped line onto two. */ -private const val TABLE_CELL_SLACK = 2f - -/** Tallest a table row may grow before it is split into rows of [SPLIT_TABLE_ROW_LINES]. */ -private const val MAX_TABLE_ROW_LINES = 30 - -/** Short enough that the split rows pack a page without leaving much of it empty. */ -private const val SPLIT_TABLE_ROW_LINES = 8 - -/** - * A paragraph that is exactly one link renders through the clickable link DSL (flush: it reads - * as a block element, not prose); links inside running text are styled but not clickable. - */ -private val ProseBlock.Paragraph.isStandaloneLink: Boolean - get() = spans.singleOrNull()?.link != null - -private val ProseBlock.Listing.markerWidth: Dp - get() = if (ordered) Dp(20f) else Dp(16f) - -private val ProseBlock.CodeBlock.lines: List - get() = code.split("\n").map { it.ifEmpty { " " } } - -private val ProseBlock.Table.columnCount: Int - get() = header.size.coerceAtLeast(1) - -/** - * Lays out [count] lines one node each, holding the first and last [MIN_LINES_AT_BREAK] - * together so a page break strands neither. - */ -private fun ContainerScope.breakableLines(count: Int, line: ContainerScope.(Int) -> Unit) { - if (count == 0) return - if (count < MIN_LINES_AT_BREAK * 2) { - keepTogether { repeat(count) { line(it) } } - return - } - keepTogether { for (i in 0 until MIN_LINES_AT_BREAK) line(i) } - for (i in MIN_LINES_AT_BREAK until count - MIN_LINES_AT_BREAK) line(i) - keepTogether { for (i in count - MIN_LINES_AT_BREAK until count) line(i) } -} - -/** One already-wrapped line. */ -private fun ContainerScope.proseLine(line: RichLine, lineHeight: Sp = BODY_STYLE.lineHeight) { - if (line.segments.isEmpty()) { - spacer(height = Dp(line.height)) - return - } - richText { - this.lineHeight = lineHeight - for (segment in line.segments) { - defaultSpanStyle = segment.style - span(segment.text) - } - } -} - -private fun ContainerScope.renderParagraph( - block: ProseBlock.Paragraph, - layout: ProseLayout.Paragraph?, - colors: ProseColors, -) { - if (layout == null) { - val onlyLink = block.spans.single() +private fun ContainerScope.renderParagraph(spans: List, base: TextStyle, colors: ProseColors) { + // A paragraph that is exactly one link renders through the clickable link DSL + // (flush — it reads as a block element, not prose); links inside running text + // are styled but not clickable (no per-span link areas). + val onlyLink = spans.singleOrNull()?.takeIf { it.link != null } + if (onlyLink != null) { link(onlyLink.link!!) { text(onlyLink.text) { color = colors.link @@ -739,7 +443,12 @@ private fun ContainerScope.renderParagraph( } return } - breakableLines(layout.lines.size) { proseLine(layout.lines[it]) } + richText { + defaultSpanStyle = base + lineHeight = base.lineHeight + span(FIRST_LINE_INDENT) + for (s in spans) span(s.text) { applyFlags(s, colors) } + } } private fun ContainerScope.renderHeading(block: ProseBlock.Heading, base: TextStyle, colors: ProseColors) { @@ -761,85 +470,64 @@ private fun ContainerScope.renderHeading(block: ProseBlock.Heading, base: TextSt } } -private fun ContainerScope.renderListing(block: ProseBlock.Listing, layout: ProseLayout.Listing) { - layout.items.forEachIndexed { index, lines -> - if (index > 0) spacer(height = ITEM_SPACING) - val marker = if (block.ordered) "${index + 1}." else "•" - breakableLines(lines.size) { lineIndex -> +private fun ContainerScope.renderListing(block: ProseBlock.Listing, base: TextStyle, colors: ProseColors) { + column(spacing = Dp(4f)) { + block.items.forEachIndexed { index, item -> + val marker = if (block.ordered) "${index + 1}." else "•" row(verticalAlignment = VerticalAlignment.Top) { - box(width = block.markerWidth) { - if (lineIndex == 0) { - aligned(BoxAlignment.TopStart) { - text(marker) { color = BODY_STYLE.color } - } + box(width = if (block.ordered) Dp(20f) else Dp(16f)) { + aligned(BoxAlignment.TopStart) { + text(marker) { color = base.color } + } + } + weighted(1f) { + richText { + defaultSpanStyle = base + lineHeight = base.lineHeight + for (s in item.spans) span(s.text) { applyFlags(s, colors) } } } - weighted(1f) { proseLine(lines[lineIndex]) } } } } } -private fun ContainerScope.renderQuote(layout: ProseLayout.Quote) { - val startsParagraph = layout.paragraphs.flatMap { lines -> lines.indices.map { it == 0 } } - val lines = layout.paragraphs.flatten() - breakableLines(lines.size) { index -> - // The bar is drawn per line; the gaps between paragraphs are padding so it runs unbroken. - column( - padding = Padding( - left = QUOTE_INSET_LEFT, - top = if (startsParagraph[index]) QUOTE_INSET_VERTICAL else Dp.Zero, - right = QUOTE_INSET_RIGHT, - bottom = if (index == lines.lastIndex) QUOTE_INSET_VERTICAL else Dp.Zero, - ), - borderEach = BorderSides( - left = BorderStroke(width = QUOTE_BAR_WIDTH, color = PdfColor.LightGray), - ), - ) { - proseLine(lines[index]) - } - } -} - -private fun ContainerScope.renderCode(block: ProseBlock.CodeBlock, layout: ProseLayout.Code) { - val lines = block.lines - lines.forEachIndexed { index, line -> - val first = index == 0 - val last = index == lines.lastIndex - column( - background = CODE_BACKGROUND, - cornerRadiusEach = CornerRadius( - topLeft = if (first) CODE_CORNER else Dp.Zero, - topRight = if (first) CODE_CORNER else Dp.Zero, - bottomLeft = if (last) CODE_CORNER else Dp.Zero, - bottomRight = if (last) CODE_CORNER else Dp.Zero, - ), - padding = Padding( - left = CODE_PADDING, - top = if (first) CODE_PADDING else Dp.Zero, - right = CODE_PADDING, - bottom = if (last) CODE_PADDING else Dp.Zero, - ), - ) { - spacer(width = Dp(layout.width)) - text(line) { - fontSize = CODE_STYLE.fontSize - color = CODE_STYLE.color +private fun ContainerScope.renderQuote(block: ProseBlock.Quote, base: TextStyle, colors: ProseColors) { + column( + padding = Padding(left = Dp(12f), top = Dp(4f), right = Dp(4f), bottom = Dp(4f)), + borderEach = BorderSides( + left = BorderStroke(width = Dp(3f), color = PdfColor.LightGray), + ), + spacing = Dp(4f), + ) { + val quoteStyle = base.copy(color = PdfColor.Gray) + for (paragraph in block.paragraphs) { + richText { + defaultSpanStyle = quoteStyle + lineHeight = base.lineHeight + for (s in paragraph) span(s.text) { applyFlags(s, colors) } } } } } -private fun ContainerScope.renderTable( - block: ProseBlock.Table, - layout: ProseLayout.Table, - base: TextStyle, - colors: ProseColors, -) { +private fun ContainerScope.renderCode(block: ProseBlock.CodeBlock, base: TextStyle) { + // No bundled monospace face; approximate with a smaller size on a grey card. + card(background = CODE_BACKGROUND, cornerRadius = Dp(4f)) { + for (line in block.code.split("\n")) { + text(line.ifEmpty { " " }) { + fontSize = Sp(base.fontSize.value * 0.9f) + color = base.color + } + } + } +} + +private fun ContainerScope.renderTable(block: ProseBlock.Table, base: TextStyle, colors: ProseColors) { + val columnCount = block.header.size.coerceAtLeast(1) table( - columns = List(block.columnCount) { TableColumn.Weight(1f) }, + columns = List(columnCount) { TableColumn.Weight(1f) }, border = TableBorder(), - cellPadding = Padding.all(TABLE_CELL_PADDING), ) { header { for (cellSpans in block.header) { @@ -851,11 +539,14 @@ private fun ContainerScope.renderTable( } } } - for (bodyRow in layout.rows) { + for (bodyRow in block.rows) { row { - for (lines in bodyRow) { + for (cellSpans in bodyRow.take(columnCount) + List((columnCount - bodyRow.size).coerceAtLeast(0)) { emptyList() }) { cell { - lines.forEach { proseLine(it, lineHeight = Sp.Zero) } + richText { + defaultSpanStyle = base + for (s in cellSpans) span(s.text) { applyFlags(s, colors) } + } } } } @@ -863,15 +554,6 @@ private fun ContainerScope.renderTable( } } -private fun TextStyle.withFlags(s: ProseSpan, colors: ProseColors): TextStyle = copy( - fontWeight = if (s.bold) FontWeight.Bold else fontWeight, - fontStyle = if (s.italic) FontStyle.Italic else fontStyle, - strikethrough = strikethrough || s.strikethrough, - fontSize = if (s.code) Sp(fontSize.value * 0.9f) else fontSize, - color = if (s.link != null) colors.link else color, - underline = underline || s.link != null, -) - private fun TextScope.applyFlags(s: ProseSpan, colors: ProseColors) { if (s.bold) bold = true if (s.italic) italic = true diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfStoryRenderer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfStoryRenderer.kt index b765d82f0..7b9ae9ad4 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfStoryRenderer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/PdfStoryRenderer.kt @@ -1,24 +1,16 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome -import com.conamobile.pdfkmp.PdfDocument -import com.conamobile.pdfkmp.defaultPdfDriverFactory import com.conamobile.pdfkmp.geometry.Padding -import com.conamobile.pdfkmp.geometry.PageSize import com.conamobile.pdfkmp.layout.PageBreakStrategy -import com.conamobile.pdfkmp.metadata.PdfMetadata import com.conamobile.pdfkmp.pdf import com.conamobile.pdfkmp.style.PdfColor import com.conamobile.pdfkmp.unit.dp import com.conamobile.pdfkmp.unit.sp import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import okio.BufferedSink private fun chapterAnchorId(index: Int): String = "chapter-$index" -internal val STORY_PAGE_SIZE = PageSize.A4 -internal val STORY_PAGE_PADDING = Padding.symmetric(horizontal = 56.dp, vertical = 64.dp) - /** * Renders the story as a PDF mirroring the EPUB layout: a title page, a clickable table of contents, * then one auto-paginating section per chapter. Chapter bodies are rendered from markdown with book @@ -32,38 +24,17 @@ fun writeStoryAsPdf( projectData: ProjectData, chapters: List, strings: ExportStrings, - options: ExportOptions = ExportOptions(), ) { - sink.write(buildStoryPdf(projectName, projectData, chapters, strings, options).toByteArray()) -} - -internal fun buildStoryPdf( - projectName: String, - projectData: ProjectData, - chapters: List, - strings: ExportStrings, - options: ExportOptions = ExportOptions(), -): PdfDocument { val authorName = projectData.authorName?.takeIf { it.isNotBlank() } val effective = chapters.ifEmpty { listOf(StoryChapter(projectName, "")) } val primary = projectData.theme?.primary?.let(::argbHexToPdfColor) val secondary = projectData.theme?.secondary?.let(::argbHexToPdfColor) val proseColors = ProseColors(primary = primary, secondary = secondary) - val contentWidth = STORY_PAGE_SIZE.width.value - STORY_PAGE_PADDING.left.value - STORY_PAGE_PADDING.right.value - val measuringDriver = defaultPdfDriverFactory().create(PdfMetadata(), emptyList()) - val prose = try { - effective.map { - prepareProse(it.markdown, proseColors, measuringDriver.fontMetrics, contentWidth, options.keepBlankLines) - } - } finally { - measuringDriver.close() - } - - return pdf { + val document = pdf { // Bottom/side margins so text doesn't run to the page edge; Slice lets long bodies flow // onto new pages at line boundaries instead of being clipped at the bottom. - defaultPagePadding = STORY_PAGE_PADDING + defaultPagePadding = Padding.symmetric(horizontal = 56.dp, vertical = 64.dp) defaultPageBreakStrategy = PageBreakStrategy.Slice metadata { @@ -72,7 +43,7 @@ internal fun buildStoryPdf( } // Title page — accent rule under the title mirrors the EPUB's title-page hr. - page(STORY_PAGE_SIZE) { + page { text(projectName) { fontSize = 36.sp bold = true @@ -89,7 +60,7 @@ internal fun buildStoryPdf( } // Contents page — each row links to the matching chapter's anchor below. - page(STORY_PAGE_SIZE) { + page { text(strings.contentsTitle) { fontSize = 26.sp bold = true @@ -99,7 +70,7 @@ internal fun buildStoryPdf( column(spacing = 6.dp) { effective.forEachIndexed { index, chapter -> linkToAnchor(chapterAnchorId(index)) { - text(chapterTitle(index, chapter, options.numberChapters)) { + text("${index + 1}. ${chapter.name}") { primary?.let { color = it } } } @@ -111,21 +82,23 @@ internal fun buildStoryPdf( // in a chapter name render verbatim; Slice keeps it on the same page as the body that follows. // bookmark drives the reader's outline panel; anchor is the jump target for the contents page. effective.forEachIndexed { index, chapter -> - page(STORY_PAGE_SIZE) { + page { bookmark(chapter.name) anchor(chapterAnchorId(index)) - text(chapterTitle(index, chapter, options.numberChapters)) { + text("${index + 1}. ${chapter.name}") { fontSize = 22.sp bold = true primary?.let { color = it } } if (chapter.markdown.isNotBlank()) { spacer(height = 14.dp) - proseMarkdown(prose[index], proseColors) + proseMarkdown(chapter.markdown, proseColors) } } } } + + sink.write(document.toByteArray()) } /** Project themes store colors as ARGB hex (`#FFRRGGBB`, sometimes `#RRGGBB`); null for anything else. */ diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHome.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHome.kt index 0807ab2c1..ac6cf79c7 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHome.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHome.kt @@ -8,7 +8,6 @@ import com.darkrockstudios.apps.hammer.common.components.ComponentToaster import com.darkrockstudios.apps.hammer.common.components.projectroot.Router import com.darkrockstudios.apps.hammer.common.data.ExportFormat import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.projectbackup.ProjectBackupDef @@ -28,13 +27,9 @@ interface ProjectHome : Router, HammerComponent, BackHandlerOwner, ComponentToas suspend fun exportProjectToFile(filePath: String, options: ExportOptions): HPath fun beginProjectExport() fun cancelExportDialog() - fun updateExportOptions(options: ExportOptions) fun confirmExportDialog(options: ExportOptions) fun endProjectExport() - /** Called after the export dialog's close animation finishes; discards unconfirmed edits. */ - fun exportDialogDismissed() - fun startProjectSync() fun showGlobalSearch() fun showGlobalSearchForTag(tag: String) @@ -83,7 +78,6 @@ interface ProjectHome : Router, HammerComponent, BackHandlerOwner, ComponentToas val showExportFilePicker: Boolean = false, val isExporting: Boolean = false, val exportOptions: ExportOptions = ExportOptions(), - val exportableScenes: List = emptyList(), val hasServer: Boolean = false, val isLoadingStats: Boolean = false, val isStatsDirty: Boolean = false, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHomeComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHomeComponent.kt index 5ba344800..e259f41bc 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHomeComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectHomeComponent.kt @@ -39,7 +39,7 @@ import kotlin.time.Clock class ProjectHomeComponent( componentContext: ComponentContext, projectDef: ProjectDef, - private val requestProjectSync: () -> Unit, + private val showProjectSync: () -> Unit, private val onShowGlobalSearch: () -> Unit, private val onShowGlobalSearchForTag: (String) -> Unit, private val onShowScene: (SceneItem) -> Unit, @@ -74,60 +74,23 @@ class ProjectHomeComponent( ) override val state: Value = _state - // The options to restore when the dialog is dismissed without confirming, so - // cancelled edits don't become the next export's defaults. Lives outside State: - // it is dialog-session bookkeeping, not something the UI renders. - private var exportOptionsBeforeDialog: ExportOptions? = null - override fun beginProjectExport() { _state.getAndUpdate { - // A scene limit from a previous export would silently narrow this one. - val options = it.exportOptions.copy(sceneIds = null) - exportOptionsBeforeDialog = options it.copy( - showExportDialog = true, - exportOptions = options, + showExportDialog = true ) } - // The tree walk reads from the repository and can be large; keep it off the click handler. - scope.launch { - val scenes = exportableScenes(sceneEditorRepository.getSceneTree()) - withContext(mainDispatcher) { - _state.getAndUpdate { it.copy(exportableScenes = scenes) } - } - } } override fun cancelExportDialog() { _state.getAndUpdate { it.copy( - showExportDialog = false, - ) - } - } - - override fun updateExportOptions(options: ExportOptions) { - _state.getAndUpdate { - it.copy(exportOptions = options) - } - } - - override fun exportDialogDismissed() { - // Runs after the close animation, so restoring options and dropping the scene - // snapshot can't visibly change the still-composed dialog content. - val restore = exportOptionsBeforeDialog - exportOptionsBeforeDialog = null - _state.getAndUpdate { - it.copy( - exportOptions = restore ?: it.exportOptions, - exportableScenes = emptyList(), + showExportDialog = false ) } } override fun confirmExportDialog(options: ExportOptions) { - // Confirmed edits are the new defaults; nothing to restore on dismissal. - exportOptionsBeforeDialog = null // Keep the dialog open through the file picker and export so it can show the working state. _state.getAndUpdate { it.copy( @@ -179,7 +142,7 @@ class ProjectHomeComponent( _state.getAndUpdate { it.copy(isExporting = true) } } - override fun startProjectSync() = requestProjectSync() + override fun startProjectSync() = showProjectSync() override fun showGlobalSearch() = onShowGlobalSearch() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettings.kt index f1cd8f2fd..99b8bb33d 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettings.kt @@ -13,28 +13,11 @@ interface ProjectSettings : HammerComponent { val spellCheckSettings: SpellCheckSettings val projectInfoState: Value - /** Every language the platform offers, sorted by display name, for the language picker. */ - val availableLanguages: List - fun setAuthorName(name: String?) fun setTheme(theme: ProjectTheme?) fun setWordCountGoal(goal: WordCountGoal?) fun setTags(tags: Set) - /** [tag] is a BCP-47 tag; null or blank clears the project language. */ - fun setProjectLanguage(tag: String?) - - fun setEncyclopediaDictionaryEnabled(enabled: Boolean) - - /** Input that normalizes to nothing storable is ignored. */ - fun addDictionaryWord(word: String) - fun removeDictionaryWord(word: String) - - data class LanguageOption( - val tag: String, - val displayName: String, - ) - /** Suggests from the account-level tag vocabulary (project + story-idea tags, via [com.darkrockstudios.apps.hammer.common.data.tagindex.AccountTagService]) — distinct from [com.darkrockstudios.apps.hammer.common.data.tagindex.TagSuggesting.suggestTags], which suggests in-project entity tags. */ fun suggestProjectTags(prefix: String): List diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettingsComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettingsComponent.kt index 15b8a7ac9..69c56647f 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettingsComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/ProjectSettingsComponent.kt @@ -14,10 +14,6 @@ import com.darkrockstudios.apps.hammer.common.data.projectInject import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository import com.darkrockstudios.apps.hammer.common.data.tagindex.AccountTagService import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectMainDispatcher -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.displayName -import com.darkrockstudios.apps.hammer.common.util.AvailableLocalesProvider -import com.darkrockstudios.apps.hammer.common.util.Locale import kotlinx.coroutines.launch import kotlinx.coroutines.withContext import org.koin.core.component.inject @@ -29,9 +25,7 @@ class ProjectSettingsComponent( private val mainDispatcher by injectMainDispatcher() private val projectDataRepository: ProjectDataRepository by projectInject() - private val projectDictionary: ProjectDictionaryUseCase by projectInject() private val accountTagService: AccountTagService by inject() - private val availableLocalesProvider: AvailableLocalesProvider by inject() override val projectName: String = projectDef.name @@ -82,35 +76,6 @@ class ProjectSettingsComponent( } } - override val availableLanguages: List by lazy { - availableLocalesProvider.allLocales() - .map { ProjectSettings.LanguageOption(tag = it.toLanguageTag(), displayName = it.displayName()) } - .sortedBy { it.displayName.lowercase() } - } - - override fun setProjectLanguage(tag: String?) { - val cleaned = tag?.takeIf { it.isNotBlank() } - ?.let { Locale.forLanguageTag(it).toLanguageTag() } - ?.takeIf { it.isNotBlank() } - scope.launch { - projectDataRepository.updateData { it.copy(language = cleaned) } - } - } - - override fun setEncyclopediaDictionaryEnabled(enabled: Boolean) { - scope.launch { - projectDataRepository.updateData { it.copy(encyclopediaDictionary = enabled) } - } - } - - override fun addDictionaryWord(word: String) { - scope.launch { projectDictionary.addWord(word) } - } - - override fun removeDictionaryWord(word: String) { - scope.launch { projectDictionary.removeWord(word) } - } - override fun suggestProjectTags(prefix: String): List { // Exclude this project's own tags so it suggests from the *other* projects' / ideas' // vocabulary, rather than offering back tags already applied here. diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRenderer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRenderer.kt index 408c5ceb0..319bd6c9b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRenderer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRenderer.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome import com.darkrockstudios.apps.hammer.base.BuildMetadata import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import com.darkrockstudios.libs.rtfparserkmp.writer.RtfAlignment import com.darkrockstudios.libs.rtfparserkmp.writer.RtfBlock import com.darkrockstudios.libs.rtfparserkmp.writer.RtfBookmark @@ -25,15 +23,7 @@ import com.darkrockstudios.libs.rtfparserkmp.writer.RtfTab import com.darkrockstudios.libs.rtfparserkmp.writer.RtfTextRun import okio.BufferedSink -private fun ExportFont.toRtfFont(): RtfFont = RtfFont( - faceName, - when (this) { - ExportFont.Georgia, ExportFont.TimesNewRoman, ExportFont.Garamond -> RtfFontFamily.Roman - ExportFont.Arial, ExportFont.Verdana -> RtfFontFamily.Swiss - ExportFont.CourierNew -> RtfFontFamily.Modern - }, -) - +private val BODY_FONT = RtfFont(EXPORT_BODY_FONT, RtfFontFamily.Roman) private val MONO_FONT = RtfFont(EXPORT_MONO_FONT, RtfFontFamily.Modern) // Font sizes in half-points; the body is 12pt to match the other exporters. @@ -66,7 +56,6 @@ fun writeStoryAsRtf( projectData: ProjectData, chapters: List, strings: ExportStrings, - options: ExportOptions = ExportOptions(), ) { val authorName = projectData.authorName?.takeIf { it.isNotBlank() } val effective = chapters.ifEmpty { listOf(StoryChapter(projectName, "")) } @@ -75,13 +64,13 @@ fun writeStoryAsRtf( val blocks = buildList { addAll(titlePage(projectName, strings.authorByline, primary)) - addAll(contentsPage(effective, strings.contentsTitle, primary, options.numberChapters)) - effective.forEachIndexed { index, chapter -> addAll(chapterBlocks(index, chapter, primary, secondary, options)) } + addAll(contentsPage(effective, strings.contentsTitle, primary)) + effective.forEachIndexed { index, chapter -> addAll(chapterBlocks(index, chapter, primary, secondary)) } } val document = RtfDocument( blocks = blocks, - defaultFont = options.font.toRtfFont(), + defaultFont = BODY_FONT, defaultFontSizeHalfPoints = BODY_HALF_POINTS, info = RtfInfo(title = projectName, author = authorName), generator = "Hammer ${BuildMetadata.APP_VERSION}", @@ -118,12 +107,7 @@ private fun titlePage(projectName: String, authorByline: String?, primary: RtfCo } } -private fun contentsPage( - chapters: List, - contentsTitle: String, - primary: RtfColor?, - numberChapters: Boolean, -): List = buildList { +private fun contentsPage(chapters: List, contentsTitle: String, primary: RtfColor?): List = buildList { add(RtfPageBreak) add( RtfParagraph( @@ -136,7 +120,7 @@ private fun contentsPage( ), ) chapters.forEachIndexed { index, chapter -> - val label = chapterTitle(index, chapter, numberChapters) + val label = "${index + 1}. ${chapter.name}" add( RtfParagraph( content = listOf( @@ -157,7 +141,6 @@ private fun chapterBlocks( chapter: StoryChapter, primary: RtfColor?, secondary: RtfColor?, - options: ExportOptions, ): List = buildList { add(RtfPageBreak) add( @@ -167,7 +150,7 @@ private fun chapterBlocks( name = chapterBookmark(index), content = listOf( RtfTextRun( - chapterTitle(index, chapter, options.numberChapters), + "${index + 1}. ${chapter.name}", RtfSpanStyle(bold = true, fontSizeHalfPoints = HEADING_HALF_POINTS[0], color = primary), ), ), @@ -181,7 +164,7 @@ private fun chapterBlocks( ), ) if (chapter.markdown.isNotBlank()) { - addAll(renderMarkdownRtf(chapter.markdown, primary, secondary, options.keepBlankLines)) + addAll(renderMarkdownRtf(chapter.markdown, primary, secondary)) } } @@ -198,22 +181,11 @@ private fun themeColor(argb: String?): RtfColor? { * consecutive same-link spans grouped into a single [RtfHyperlink]. Hard line breaks ride along as * `\n` in run text — the rtf-writer escaper turns those into `\line`. */ -private fun renderMarkdownRtf( - markdown: String, - primary: RtfColor?, - secondary: RtfColor?, - keepBlankLines: Boolean, -): List { +private fun renderMarkdownRtf(markdown: String, primary: RtfColor?, secondary: RtfColor?): List { val blocks = mutableListOf() - val parsed = parseProseMarkdown(markdown, keepBlankLines) - parsed.forEachIndexed { index, block -> - // Prose runs tight: the indent parts one line from the next, and the space a passage break - // wants is a blank line the author actually typed. Space after is for leaving prose behind. - val runsOn = parsed.getOrNull(index + 1)?.isProseLine == true - val proseSpaceAfter = if (runsOn) 0 else PARAGRAPH_SPACE_AFTER + for (block in parseProseMarkdown(markdown)) { when (block) { - is ProseBlock.Paragraph -> blocks += bodyParagraph(block.spans, primary, proseSpaceAfter) - ProseBlock.Blank -> blocks += bodyParagraph(emptyList(), primary, proseSpaceAfter) + is ProseBlock.Paragraph -> blocks += bodyParagraph(block.spans, primary) is ProseBlock.Heading -> blocks += headingParagraph(block, primary, secondary) is ProseBlock.Listing -> { val numbering = RtfListNumbering() @@ -229,16 +201,9 @@ private fun renderMarkdownRtf( return blocks } -private fun bodyParagraph( - spans: List, - primary: RtfColor?, - spaceAfterTwips: Int = PARAGRAPH_SPACE_AFTER, -): RtfParagraph = RtfParagraph( +private fun bodyParagraph(spans: List, primary: RtfColor?): RtfParagraph = RtfParagraph( content = coalesceRuns(spansToInlines(spans, RtfSpanStyle.Default, primary)), - style = RtfParagraphStyle( - firstLineIndentTwips = BODY_FIRST_LINE_INDENT, - spaceAfterTwips = spaceAfterTwips, - ), + style = RtfParagraphStyle(firstLineIndentTwips = BODY_FIRST_LINE_INDENT, spaceAfterTwips = PARAGRAPH_SPACE_AFTER), ) private fun headingParagraph(block: ProseBlock.Heading, primary: RtfColor?, secondary: RtfColor?): RtfParagraph { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommon.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommon.kt index ab40bb8ef..df59b5b23 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommon.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommon.kt @@ -16,21 +16,39 @@ data class ExportStrings( // Shared layout vocabulary mirrored across the EPUB / DOCX / RTF / PDF exporters. Keeping these in one // place is what lets the "mirrored" exports actually stay in step when the layout is tuned. -/** Monospace font face shared by the DOCX and RTF exporters. */ +/** Prose and monospace font faces shared by the DOCX and RTF exporters. */ +internal const val EXPORT_BODY_FONT = "Georgia" internal const val EXPORT_MONO_FONT = "Consolas" /** Heading 1..6 sizes in half-points, shared by the DOCX and RTF exporters. */ internal val HEADING_HALF_POINTS = listOf(48, 36, 32, 28, 26, 24) -/** The chapter title as it appears in headings and the Contents page. */ -internal fun chapterTitle(index: Int, chapter: StoryChapter, numbered: Boolean): String = - if (numbered) "${index + 1}. ${chapter.name}" else chapter.name - /** Bookmark / anchor name for the chapter at [index], the target of its Contents link. */ internal fun chapterBookmark(index: Int): String = "chapter${index + 1}" // Shared markdown text helpers used when turning the parsed prose model into export output. +private const val ASCII_PUNCTUATION = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~" + +/** Resolves CommonMark backslash escapes (`\*` → `*`) to their bare ASCII punctuation. */ +internal fun unescapeMarkdown(text: CharSequence): String { + if (!text.contains('\\')) return text.toString() + val sb = StringBuilder(text.length) + var i = 0 + while (i < text.length) { + val c = text[i] + val next = if (i + 1 < text.length) text[i + 1] else null + if (c == '\\' && next != null && next in ASCII_PUNCTUATION) { + sb.append(next) + i += 2 + } else { + sb.append(c) + i++ + } + } + return sb.toString() +} + /** Splits a code block's text into lines, trimming leading and trailing blank lines. */ internal fun codeBlockLines(code: String): List = code.split("\n").dropWhile { it.isBlank() }.dropLastWhile { it.isBlank() } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRoot.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRoot.kt index d882f2ba6..8bdf11397 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRoot.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRoot.kt @@ -29,9 +29,6 @@ interface ProjectRoot : AppCloseManager, HammerComponent, BackHandlerOwner { val modalRouterState: Value> val closeRequestHandlers: Value> val backEnabled: Value - - /** Observable form of [hasUnsavedBuffers]. */ - val unsavedBuffers: Value val projectTheme: Value val navRailState: Value @@ -48,12 +45,6 @@ interface ProjectRoot : AppCloseManager, HammerComponent, BackHandlerOwner { fun isAtRoot(): Boolean fun showProjectSync() - - /** - * Gated sync entry point for server-linked projects: unsaved scenes and entity edits are - * confirmed through [closeRequestHandlers] first, then the sync modal opens. - */ - fun startProjectSync() fun dismissProjectSync() fun showGlobalSearch() @@ -74,8 +65,6 @@ interface ProjectRoot : AppCloseManager, HammerComponent, BackHandlerOwner { override fun shouldConfirmClose() = component.shouldConfirmClose() - override fun discardUnsaved(item: CloseConfirm) = component.discardUnsaved(item) - data class EditorDestination(override val component: StoryEditor) : Destination() data class NotesDestination(override val component: Notes) : Destination() @@ -122,7 +111,4 @@ interface ProjectRoot : AppCloseManager, HammerComponent, BackHandlerOwner { fun closeRequestDealtWith(item: CloseConfirm) fun requestClose() fun cancelCloseRequest() - - /** Drops the unsaved work behind [item] so a following sync or close cannot persist it. */ - suspend fun discardUnsaved(item: CloseConfirm) } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootComponent.kt index 8008ed964..1d4ec3a72 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootComponent.kt @@ -41,7 +41,7 @@ class ProjectRootComponent( initialDeepLink: ProjectDeepLink? = null, ) : ProjectComponentBase(projectDef, componentContext), ProjectRoot { - private val syncJournal: SyncJournal = projectGet() + private val syncJournal: SyncJournal by projectInject() private val sceneEditor: SceneEditorService by projectInject() private val projectDataRepository: ProjectDataRepository by projectInject() private val encyclopediaService: EncyclopediaService by projectInject() @@ -80,9 +80,6 @@ class ProjectRootComponent( private val _backEnabled = MutableValue(true) override val backEnabled = _backEnabled - private val _unsavedBuffers = MutableValue(false) - override val unsavedBuffers: Value = _unsavedBuffers - override fun onBack() { router.onBack() } @@ -96,7 +93,7 @@ class ProjectRootComponent( addMenu, removeMenu, ::updateCloseConfirmRequirement, - ::startProjectSync, + ::showProjectSync, ::showGlobalSearch, ::showGlobalSearchForTag, ::showFocusMode, @@ -125,9 +122,7 @@ class ProjectRootComponent( override fun onCreate() { super.onCreate() - _unsavedBuffers.value = sceneEditor.hasDirtyBuffers() sceneEditor.subscribeToBufferUpdates(null, scope) { - _unsavedBuffers.value = sceneEditor.hasDirtyBuffers() updateCloseConfirmRequirement() } @@ -239,14 +234,6 @@ class ProjectRootComponent( override fun showProjectSync() = modalRouter.showProjectSync() - override fun startProjectSync() { - if (!syncJournal.isServerSynchronized()) return - if (_closeRequestHandlers.value.isNotEmpty()) return - val list = unsavedConfirmations() - list.add(CloseConfirm.Sync) - _closeRequestHandlers.update { list } - } - override fun dismissProjectSync() = modalRouter.dismissProjectSync() override fun showGlobalSearch() = modalRouter.showGlobalSearch() @@ -334,7 +321,12 @@ class ProjectRootComponent( override fun requestClose() { scope.launch { - val list = unsavedConfirmations() + val list = mutableSetOf() + if (hasUnsavedBuffers()) { + list.add(CloseConfirm.Scenes) + } + + list.addAll(router.shouldConfirmClose()) if (syncJournal.shouldAutoSync()) { list.add(CloseConfirm.Sync) @@ -347,32 +339,10 @@ class ProjectRootComponent( } } - /** Ordered set of the unsaved-work confirmations currently needed, scenes first. */ - private fun unsavedConfirmations(): MutableSet { - val list = mutableSetOf() - if (hasUnsavedBuffers()) { - list.add(CloseConfirm.Scenes) - } - list.addAll(router.shouldConfirmClose()) - return list - } - override fun cancelCloseRequest() { _closeRequestHandlers.update { emptySet() } } - override suspend fun discardUnsaved(item: CloseConfirm) { - when (item) { - CloseConfirm.Scenes -> withContext(dispatcherDefault) { sceneEditor.discardAllBuffers() } - CloseConfirm.Notes, - CloseConfirm.Encyclopedia, - CloseConfirm.Timeline -> withContext(dispatcherMain) { router.discardUnsaved(item) } - - CloseConfirm.Sync, - CloseConfirm.Complete -> Unit - } - } - override fun onStart() { super.onStart() addMenuItems() @@ -395,7 +365,7 @@ class ProjectRootComponent( label = Res.string.sync_menu_item, icon = "", shortcut = KeyShortcut(keyCode = 0x72), - action = { startProjectSync() } + action = { showProjectSync() } ) ) ) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootRouter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootRouter.kt index 52ae8d830..19b64e9c8 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootRouter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/ProjectRootRouter.kt @@ -31,7 +31,7 @@ internal class ProjectRootRouter( private val addMenu: (menu: MenuDescriptor) -> Unit, private val removeMenu: (id: String) -> Unit, private val updateShouldClose: () -> Unit, - private val requestProjectSync: () -> Unit, + private val showProjectSync: () -> Unit, private val showGlobalSearch: () -> Unit, private val onShowGlobalSearchForTag: (String) -> Unit, private val showFocusMode: (SceneItem) -> Unit, @@ -149,7 +149,7 @@ internal class ProjectRootRouter( return ProjectHomeComponent( componentContext = componentContext, projectDef = config.projectDef, - requestProjectSync = requestProjectSync, + showProjectSync = showProjectSync, onShowGlobalSearch = showGlobalSearch, onShowGlobalSearchForTag = onShowGlobalSearchForTag, onShowScene = showScene, @@ -190,10 +190,6 @@ internal class ProjectRootRouter( }.toSet() } - override fun discardUnsaved(item: CloseConfirm) { - state.value.items.forEach { it.instance.discardUnsaved(item) } - } - fun onBack() { navigation.pop() } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/Router.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/Router.kt index 7d946b8fc..e53b17bd4 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/Router.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectroot/Router.kt @@ -3,7 +3,4 @@ package com.darkrockstudios.apps.hammer.common.components.projectroot interface Router { fun isAtRoot(): Boolean fun shouldConfirmClose(): Set - - /** Throws away the in-progress edit that made [shouldConfirmClose] report [item]. */ - fun discardUnsaved(item: CloseConfirm) {} } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelection.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelection.kt index f1773a990..98f627d19 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelection.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelection.kt @@ -8,7 +8,6 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.abouta import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettings import com.darkrockstudios.apps.hammer.common.components.projectselection.projectslist.ProjectsList import com.darkrockstudios.apps.hammer.common.components.projectselection.storyideas.StoryIdeas -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState import com.darkrockstudios.apps.hammer.common.dependencyinjection.HammerComponent import kotlinx.serialization.Serializable import org.jetbrains.compose.resources.StringResource @@ -16,8 +15,7 @@ import org.jetbrains.compose.resources.StringResource interface ProjectSelection : HammerComponent, BackHandlerOwner { val stack: Value> val navRailState: Value - val changelog: Value - val appUpdate: Value + val updateNotification: Value fun isAtRoot(): Boolean fun onBack() @@ -25,20 +23,20 @@ interface ProjectSelection : HammerComponent, BackHandlerOwner { fun showLocation(location: Locations) fun toggleNavRailExpanded() - fun openLatestRelease() - fun dismissChangelog() - fun showChangelog() - - fun updateApp() - fun dismissUpdate() + fun openReleaseUrl() + fun dismissUpdateNotification(remember: Boolean) + fun showCurrentReleaseDetails() data class NavRailState(val expanded: Boolean) - data class ChangelogState( + data class UpdateNotificationState( val visible: Boolean = false, - val version: String? = null, - val date: String? = null, - val notes: String? = null, + val latestVersionTag: String? = null, + val releaseName: String? = null, + val releaseBody: String? = null, + val releaseUrl: String? = null, + val isNewVersionAvailable: Boolean = false, + val manuallyTriggered: Boolean = false, ) enum class Locations(val text: StringResource, val shortText: StringResource) { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelectionComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelectionComponent.kt index abce8b3b7..0435ef4aa 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelectionComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/ProjectSelectionComponent.kt @@ -16,11 +16,9 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.storyi import com.darkrockstudios.apps.hammer.common.data.ExampleProjectRepository import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.base.RELEASES_LATEST_URL -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.changelog.Changelog -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogRepository +import com.darkrockstudios.apps.hammer.common.data.versioncheck.GithubReleaseInfo +import com.darkrockstudios.apps.hammer.common.data.versioncheck.ShouldNotifyOfUpdateUseCase +import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository import com.darkrockstudios.apps.hammer.common.util.UrlLauncher import kotlinx.coroutines.launch import kotlinx.coroutines.withContext @@ -34,8 +32,8 @@ class ProjectSelectionComponent( private val exampleProjectRepository: ExampleProjectRepository by inject() private val urlLauncher: UrlLauncher by inject() private val settingsRepository: GlobalSettingsStore by inject() - private val changelogRepository: ChangelogRepository by inject() - private val appUpdater: AppUpdater by inject() + private val versionCheckRepository: VersionCheckRepository by inject() + private val shouldNotifyOfUpdate: ShouldNotifyOfUpdateUseCase by inject() private val navigation = StackNavigation() override val stack = childStack( @@ -51,25 +49,14 @@ class ProjectSelectionComponent( ) override val navRailState: Value = _navRailState - private val _changelog = MutableValue(ProjectSelection.ChangelogState()) - override val changelog: Value = _changelog - - private val _appUpdate = MutableValue(appUpdater.state.value) - override val appUpdate: Value = _appUpdate + private val _updateNotification = MutableValue(ProjectSelection.UpdateNotificationState()) + override val updateNotification: Value = _updateNotification init { if (exampleProjectRepository.shouldInstallFirstTime()) { exampleProjectRepository.install() } - scope.launch { - appUpdater.state.collect { update -> - withContext(dispatcherMain) { - _appUpdate.update { update } - } - } - } - scope.launch { settingsRepository.globalSettingsUpdates.collect { settings -> if (_navRailState.value.expanded != settings.navRailExpanded) { @@ -80,31 +67,45 @@ class ProjectSelectionComponent( } } - // Read from the changelog baked in at release time — nothing here touches the network. scope.launch { - if (changelogRepository.hasUnseenChangelog()) { - val changelog = changelogRepository.getChangelog() ?: return@launch + val result = versionCheckRepository.checkForUpdate() + val dismissed = settingsRepository.globalSettings.lastDismissedUpdateVersion + if (shouldNotifyOfUpdate(result, dismissed)) { + val release = result.latestRelease ?: return@launch withContext(dispatcherMain) { - _changelog.update { changelog.toState() } + _updateNotification.update { + release.toNotificationState( + isNewVersionAvailable = result.isNewVersionAvailable, + manuallyTriggered = false, + ) + } } } } } - override fun showChangelog() { - scope.launch { - val changelog = changelogRepository.getChangelog() ?: return@launch - withContext(dispatcherMain) { - _changelog.update { changelog.toState() } - } - } + override fun showCurrentReleaseDetails() { + val result = versionCheckRepository.currentResult() ?: return + val release = result.latestRelease ?: return + val next = release.toNotificationState( + isNewVersionAvailable = result.isNewVersionAvailable, + manuallyTriggered = true, + ) + if (next == _updateNotification.value) return + _updateNotification.update { next } } - private fun Changelog.toState() = ProjectSelection.ChangelogState( + private fun GithubReleaseInfo.toNotificationState( + isNewVersionAvailable: Boolean, + manuallyTriggered: Boolean, + ) = ProjectSelection.UpdateNotificationState( visible = true, - version = version, - date = date, - notes = notes, + latestVersionTag = bareVersion, + releaseName = name, + releaseBody = body, + releaseUrl = htmlUrl, + isNewVersionAvailable = isNewVersionAvailable, + manuallyTriggered = manuallyTriggered, ) override fun toggleNavRailExpanded() { @@ -113,21 +114,18 @@ class ProjectSelectionComponent( } } - override fun openLatestRelease() { - urlLauncher.openInBrowser(RELEASES_LATEST_URL) + override fun openReleaseUrl() { + _updateNotification.value.releaseUrl?.let { urlLauncher.openInBrowser(it) } } - override fun dismissChangelog() { - _changelog.update { it.copy(visible = false) } - scope.launch { changelogRepository.markSeen() } - } - - override fun updateApp() { - appUpdater.update() - } - - override fun dismissUpdate() { - appUpdater.dismiss() + override fun dismissUpdateNotification(remember: Boolean) { + val tag = _updateNotification.value.latestVersionTag + _updateNotification.update { it.copy(visible = false) } + if (remember && tag != null) { + scope.launch { + settingsRepository.updateSettings { it.copy(lastDismissedUpdateVersion = tag) } + } + } } private fun createChild( @@ -166,7 +164,8 @@ class ProjectSelectionComponent( componentContext = componentContext, urlLauncher = urlLauncher, updateShouldClose = { navigation.pop() }, - onShowChangelog = ::showChangelog, + versionCheckRepository = versionCheckRepository, + onShowReleaseDetails = ::showCurrentReleaseDetails, ) ) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutApp.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutApp.kt index 996493c3c..9b15e44cb 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutApp.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutApp.kt @@ -1,10 +1,8 @@ package com.darkrockstudios.apps.hammer.common.components.projectselection.aboutapp import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState import com.darkrockstudios.apps.hammer.common.util.getAppVersionString import kotlinx.serialization.Serializable -import kotlinx.serialization.Transient interface AboutApp { @@ -13,17 +11,14 @@ interface AboutApp { fun openDiscord() fun openReddit() fun openGithub() - fun viewChangelog() - fun openLatestRelease() - - fun checkForUpdate() - fun updateApp() + fun viewReleaseDetails() @Serializable data class State( + val latestVersion: String? = null, val currentVersion: String = getAppVersionString(), + val newVersionAvailable: Boolean = false, val logDirectoryPath: String = "", - @Transient val appUpdate: AppUpdateState = AppUpdateState.Unsupported, ) -} +} \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutAppComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutAppComponent.kt index 42b60c4ba..0844bf6d4 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutAppComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/aboutapp/AboutAppComponent.kt @@ -7,41 +7,43 @@ import com.arkivanov.decompose.value.update import com.darkrockstudios.apps.hammer.base.DISCORD_URL import com.darkrockstudios.apps.hammer.base.GITHUB_URL import com.darkrockstudios.apps.hammer.base.REDDIT_URL -import com.darkrockstudios.apps.hammer.base.RELEASES_LATEST_URL import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater +import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository import com.darkrockstudios.apps.hammer.common.getConfigDirectory import com.darkrockstudios.apps.hammer.common.getLogDirectory import com.darkrockstudios.apps.hammer.common.util.UrlLauncher import kotlinx.coroutines.launch import kotlinx.coroutines.withContext -import org.koin.core.component.inject class AboutAppComponent( componentContext: ComponentContext, private val urlLauncher: UrlLauncher, private val updateShouldClose: () -> Unit, - private val onShowChangelog: () -> Unit, + private val versionCheckRepository: VersionCheckRepository, + private val onShowReleaseDetails: () -> Unit, ) : AboutApp, ComponentBase(componentContext) { - private val appUpdater: AppUpdater by inject() - - private val _state = MutableValue( - AboutApp.State( - logDirectoryPath = getLogDirectoryPath(), - appUpdate = appUpdater.state.value, - ) - ) + private val _state = MutableValue(AboutApp.State(logDirectoryPath = getLogDirectoryPath())) override val state: Value = _state init { scope.launch { - appUpdater.state.collect { update -> + versionCheckRepository.updates.collect { result -> + val tag = result.latestRelease?.bareVersion withContext(dispatcherMain) { - _state.update { it.copy(appUpdate = update) } + _state.update { + it.copy( + latestVersion = tag, + newVersionAvailable = result.isNewVersionAvailable, + ) + } } } } + + if (versionCheckRepository.currentResult() == null) { + scope.launch { versionCheckRepository.checkForUpdate() } + } } override fun openDiscord() { @@ -56,20 +58,8 @@ class AboutAppComponent( urlLauncher.openInBrowser(GITHUB_URL) } - override fun viewChangelog() { - onShowChangelog() - } - - override fun openLatestRelease() { - urlLauncher.openInBrowser(RELEASES_LATEST_URL) - } - - override fun checkForUpdate() { - appUpdater.checkNow() - } - - override fun updateApp() { - appUpdater.update() + override fun viewReleaseDetails() { + onShowReleaseDetails() } private fun getLogDirectoryPath(): String { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettings.kt index 1ce85b50f..32eb56f87 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettings.kt @@ -21,28 +21,19 @@ interface AccountSettings : ComponentToaster { fun reinstallExampleProject(onComplete: (Boolean) -> Unit) fun beginSetupServer() fun cancelServerSetup() - /** - * [replaceLocalContent] is only ever true when the user explicitly chose "Replace" in the merge - * prompt. When it is false and the login would merge real local work into a different server, - * this raises that prompt instead of running the setup; see [chooseMerge] / [chooseReplace]. - */ fun setupServer( url: String, email: String, password: String, create: Boolean, - replaceLocalContent: Boolean + removeLocalContent: Boolean ) - fun chooseMerge() - fun chooseReplace() - fun cancelMergePrompt() - fun acceptTos() fun declineTos() suspend fun authTest(): Boolean - suspend fun removeServer() + fun removeServer() suspend fun setAutomaticBackups(value: Boolean) suspend fun setAutoCloseDialogs(value: Boolean) @@ -68,15 +59,12 @@ interface AccountSettings : ComponentToaster { val serverSetup: Boolean = false, val serverIsLoggedIn: Boolean = false, val serverUrl: String? = null, - /** The typed URL would connect in the clear, so the setup screen warns about it. */ - val serverUrlInsecure: Boolean = false, val serverEmail: String? = null, // Never persist the password to disk; drop stale error/working state on restore. @Transient val serverPassword: String? = null, @Transient val serverError: String? = null, @Transient val serverWorking: Boolean = false, @Transient val tosChallenge: TermsOfServiceChallenge? = null, - @Transient val mergePrompt: Boolean = false, val syncAutomaticSync: Boolean, val syncAutomaticBackups: Boolean, val syncAutoCloseDialog: Boolean, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettingsComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettingsComponent.kt index f64fef617..25cfbdd33 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettingsComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/AccountSettingsComponent.kt @@ -25,8 +25,6 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.globalsettings.InitialProjectScreen import com.darkrockstudios.apps.hammer.common.data.globalsettings.UiTheme -import com.darkrockstudios.apps.hammer.common.data.globalsettings.isInsecureServerUrl -import com.darkrockstudios.apps.hammer.common.data.globalsettings.parseServerUrl import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectMainDispatcher import com.darkrockstudios.apps.hammer.common.util.StrRes @@ -42,9 +40,7 @@ import com.darkrockstudios.apps.hammer.settings_server_setup_toast_failure import com.darkrockstudios.apps.hammer.settings_server_setup_toast_failure_unknown import com.darkrockstudios.apps.hammer.settings_server_setup_toast_success import com.darkrockstudios.apps.hammer.settings_server_tos_declined -import io.github.aakira.napier.Napier import kotlinx.coroutines.Job -import kotlinx.coroutines.NonCancellable import kotlinx.coroutines.launch import kotlinx.coroutines.withContext import kotlinx.serialization.Serializable @@ -79,7 +75,6 @@ class AccountSettingsComponent( private var serverSetupJob: Job? = null private var pendingServerSetup: PendingServerSetup? = null - private var promptedSetup: PendingServerSetup? = null override val platformSettings: PlatformSettings by inject { parametersOf(componentContext) } override val spellCheckSettings: SpellCheckSettings = SpellCheckSettingsComponent(componentContext) @@ -186,14 +181,12 @@ class AccountSettingsComponent( globalSettingsStore.deleteServerSettings() } pendingServerSetup = null - promptedSetup = null _state.getAndUpdate { it.copy( serverSetup = false, serverError = null, serverWorking = false, tosChallenge = null, - mergePrompt = false, ) } } @@ -212,12 +205,12 @@ class AccountSettingsComponent( return accountUseCase.testAuth() } - override suspend fun removeServer() { + override fun removeServer() { globalSettingsStore.deleteServerSettings() clearAllProjectIds() } - private suspend fun clearAllProjectIds() { + private fun clearAllProjectIds() { projectsRepository.getProjects().forEach { projectDef -> projectsRepository.removeProjectId(projectDef = projectDef) } @@ -271,7 +264,7 @@ class AccountSettingsComponent( } override fun updateServerUrl(url: String) { - _state.getAndUpdate { it.copy(serverUrl = url, serverUrlInsecure = isInsecureServerUrl(url)) } + _state.getAndUpdate { it.copy(serverUrl = url) } } override fun updateServerEmail(email: String) { @@ -295,7 +288,7 @@ class AccountSettingsComponent( email: String, password: String, create: Boolean, - replaceLocalContent: Boolean + removeLocalContent: Boolean ) { cancelSetupJob() @@ -310,8 +303,7 @@ class AccountSettingsComponent( } // Client-side URL validation - val parsedUrl = parseServerUrl(url) - val cleanUrl = parsedUrl.host + val cleanUrl = cleanUpUrl(url) if (validateUrl(cleanUrl).not()) { val message = strRes.get(Res.string.server_setup_error_invalid_url) showValidationError(message) @@ -334,90 +326,16 @@ class AccountSettingsComponent( } // All validation passed, proceed with server setup - val cleanEmail = email.trim() - val current = _state.value - val pending = PendingServerSetup( - url = cleanUrl, - ssl = parsedUrl.ssl, - email = cleanEmail, - password = password, - create = create, - replaceLocalContent = replaceLocalContent, - // Captured now: AccountUseCase writes provisional settings, so by the time the - // result comes back the state already names the server being logged in to. - sameServer = current.currentUrl == cleanUrl && current.currentEmail == cleanEmail, - ) - - if (shouldPromptForMerge(pending)) { - promptedSetup = pending - withContext(mainDispatcher) { - _state.getAndUpdate { - it.copy( - mergePrompt = true, - serverSetup = false, - serverWorking = false, - ) - } - } - } else { - pendingServerSetup = pending - performServerSetup(pending, acceptedTosVersion = null) + if (removeLocalContent) { + removeLocalContent() } - } - } - /** - * Only worth asking when logging in to a *different* server while holding real local work: - * everything else has one sensible answer. Re-reads the projects directory rather than trusting - * anything the UI passed in, so a stale caller can only cost a prompt, never local content. - */ - private suspend fun shouldPromptForMerge(pending: PendingServerSetup): Boolean { - if (pending.create || pending.replaceLocalContent || pending.sameServer) return false - - return withContext(dispatcherIo) { - projectsRepository.getProjects().any { exampleProjectRepository.isExampleProject(it).not() } - } - } - - override fun chooseMerge() = resumePromptedSetup(replaceLocalContent = false) - - override fun chooseReplace() = resumePromptedSetup(replaceLocalContent = true) - - private fun resumePromptedSetup(replaceLocalContent: Boolean) { - val prompted = promptedSetup ?: return - promptedSetup = null - - val pending = prompted.copy(replaceLocalContent = replaceLocalContent) - pendingServerSetup = pending - - cancelSetupJob() - serverSetupJob = scope.launch { - withContext(mainDispatcher) { - _state.getAndUpdate { - it.copy( - mergePrompt = false, - serverSetup = true, - serverError = null, - serverWorking = true, - ) - } - } - // Credentials were validated before the prompt was raised. + val pending = PendingServerSetup(cleanUrl, email.trim(), password, create) + pendingServerSetup = pending performServerSetup(pending, acceptedTosVersion = null) } } - override fun cancelMergePrompt() { - promptedSetup = null - _state.getAndUpdate { - it.copy( - mergePrompt = false, - serverSetup = true, - serverWorking = false, - ) - } - } - override fun acceptTos() { val pending = pendingServerSetup ?: return val version = _state.value.tosChallenge?.version ?: return @@ -458,20 +376,11 @@ class AccountSettingsComponent( password = pending.password, create = pending.create, acceptedTosVersion = acceptedTosVersion, - ssl = pending.ssl, ) withContext(mainDispatcher) { when (result) { - is ServerSetupResult.Success -> withContext(NonCancellable) { - // Cleared before the wipe suspends: cancelServerSetup() deletes the server - // settings whenever a setup is pending, and these tokens are now valid. + is ServerSetupResult.Success -> { pendingServerSetup = null - // The local wipe waits until the account is confirmed: a bad password, an - // unreachable server or a declined ToS must never cost the user their work. - // NonCancellable so a close/ESC landing here can't strand valid tokens either. - if (shouldRemoveLocalContent(pending)) { - withContext(dispatcherIo) { removeLocalContent() } - } // A freshly created account holds no projects, so any serverProjectId from a // previous server is stale and would make sync skip re-creating the project. if (pending.create) { @@ -538,61 +447,38 @@ class AccountSettingsComponent( } } - /** - * Logging in to a new server with nothing but the bundled example project is a clean slate: drop - * it rather than uploading it to the account and propagating it to every other device. Re-auth - * against the configured server is not a clean slate, so it keeps whatever is there. - */ - private suspend fun shouldRemoveLocalContent(pending: PendingServerSetup): Boolean { - if (pending.create) return false - if (pending.replaceLocalContent) return true - if (pending.sameServer) return false - - return withContext(dispatcherIo) { - val projects = projectsRepository.getProjects() - projects.size == 1 && exampleProjectRepository.isExampleProject(projects.first()) - } - } - - private fun removeLocalContent() { + private suspend fun removeLocalContent() { projectsRepository.getProjects().forEach { projectDef -> - if (projectsRepository.deleteProject(projectDef).not()) { - Napier.w("Failed to delete local project '${projectDef.name}' during server setup") - } + projectsRepository.deleteProject(projectDef) } } companion object { - /** A host name or IPv4 address: dot-separated labels of letters, digits and inner hyphens. */ - private val hostRegex = - Regex("""^[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?(\.[A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?)*$""") + // regex to validate url with port number + private val urlWithPortRegex = + Regex("""^([a-z0-9]+\.)*([a-z0-9]+)(\.[a-z]+)(:[0-9]{1,5})?$""") + private val ipWithPortRegex = Regex("""^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(?::\d+)?$""") fun validateUrl(url: String): Boolean { - if (url.isBlank()) return false - - val host = url.substringBefore(':') - if (hostRegex.matches(host).not()) return false - - if (url.contains(':')) { - val port = url.substringAfter(':').toIntOrNull() ?: return false - if (port !in 1..65535) return false - } - - return true + return url.isNotBlank() && (urlWithPortRegex.matches(url) || ipWithPortRegex.matches(url)) } - fun cleanUpUrl(url: String): String = parseServerUrl(url).host + fun cleanUpUrl(url: String): String { + var cleanUrl: String = url.trim() + cleanUrl = cleanUrl.removeSuffix("http://") + cleanUrl = cleanUrl.removeSuffix("https://") + cleanUrl = cleanUrl.removeSuffix("/") + + return cleanUrl + } } } private data class PendingServerSetup( val url: String, - val ssl: Boolean, val email: String, val password: String, val create: Boolean, - val replaceLocalContent: Boolean, - val sameServer: Boolean, ) @Serializable diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/BackupManagerComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/BackupManagerComponent.kt index 6af731188..938202cf5 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/BackupManagerComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/BackupManagerComponent.kt @@ -8,13 +8,13 @@ import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.backup_manager_error_delete_backup import com.darkrockstudios.apps.hammer.backup_manager_error_load_backups import com.darkrockstudios.apps.hammer.backup_manager_error_load_project_backups -import com.darkrockstudios.apps.hammer.backup_manager_error_restore_backup import com.darkrockstudios.apps.hammer.common.components.SavableComponent import com.darkrockstudios.apps.hammer.common.data.ClientMessage import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.projectbackup.BackupManagerService import com.darkrockstudios.apps.hammer.common.data.projectbackup.ProjectBackupDef import com.darkrockstudios.apps.hammer.common.data.projectbackup.ProjectBackupRepository +import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.util.StrRes import io.github.aakira.napier.Napier import kotlinx.coroutines.launch @@ -27,6 +27,7 @@ class BackupManagerComponent( ) : BackupManager, KoinComponent, SavableComponent(componentContext) { private val backupRepository by inject() + private val projectsRepository by inject() private val strRes: StrRes by inject() private val backupManagerService by inject() @@ -43,8 +44,15 @@ class BackupManagerComponent( _state.update { it.copy(isLoading = true, error = null) } try { + val projects = withContext(dispatcherIo) { + projectsRepository.getProjects() + } + + // Get projects that have backups val projectsWithBackups = withContext(dispatcherIo) { - backupRepository.getBackedUpProjects() + projects.filter { projectDef -> + backupRepository.getBackups(projectDef).isNotEmpty() + } } val projectNames = projectsWithBackups @@ -113,7 +121,7 @@ class BackupManagerComponent( override fun selectProject(projectName: String) { scope.launch { val projectDef = withContext(dispatcherIo) { - backupRepository.getBackedUpProjects().find { it.name == projectName } + projectsRepository.getProjects().find { it.name == projectName } } withContext(dispatcherMain) { @@ -157,19 +165,7 @@ class BackupManagerComponent( override fun restoreBackup(backup: ProjectBackupDef) { scope.launch { - val restored = withContext(dispatcherIo) { - backupRepository.restoreBackup(backup, backup.projectDef.path) - } - - if (restored.not()) { - val errorMsg = ClientMessage.Resource(Res.string.backup_manager_error_restore_backup, backup.path.name) - val errorText = errorMsg.text(strRes) - withContext(dispatcherMain) { - _state.update { - it.copy(error = errorText) - } - } - } + backupRepository.restoreBackup(backup, backup.projectDef.path) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsList.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsList.kt index 5c5446c15..bc77a453b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsList.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsList.kt @@ -64,8 +64,6 @@ interface ProjectsList : HammerComponent, ComponentToaster { val importProjectName: String = "", val importFileContent: ByteArray = ByteArray(0), val importPreview: ImportPreview = ImportPreview(emptyList()), - // A parse in flight is meaningless after a process death; don't restore it. - @Transient val isParsingImport: Boolean = false, ) @Serializable diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsListComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsListComponent.kt index 959c8162b..75959ab3e 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsListComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/projectslist/ProjectsListComponent.kt @@ -4,6 +4,7 @@ import com.arkivanov.decompose.ComponentContext import com.arkivanov.decompose.value.Value import com.arkivanov.decompose.value.getAndUpdate import com.darkrockstudios.apps.hammer.Res +import com.darkrockstudios.apps.hammer.base.http.readTomlOrNull import com.darkrockstudios.apps.hammer.common.components.ComponentToaster import com.darkrockstudios.apps.hammer.common.components.ComponentToasterImpl import com.darkrockstudios.apps.hammer.common.components.SavableComponent @@ -19,21 +20,24 @@ import com.darkrockstudios.apps.hammer.common.data.importer.ImportPreview import com.darkrockstudios.apps.hammer.common.data.importer.StoryImporterRegistry import com.darkrockstudios.apps.hammer.common.data.isSuccess import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataConflictBroker -import com.darkrockstudios.apps.hammer.common.data.projectdata.readStoredProjectData +import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource +import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.projectstatistics.ProjectStatisticsCacheReader import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.data.protocolmismatch.ProtocolMismatchRepository import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ClientAccountSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountListener -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountUseCase import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeaConflict +import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ClientProjectSynchronizer +import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.OnSyncLog import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncAccLogE import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncAccLogI import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncAccLogW +import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogE +import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogI +import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogW import com.darkrockstudios.apps.hammer.common.data.temporaryProjectTask import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectMainDispatcher import com.darkrockstudios.apps.hammer.common.fileio.HPath @@ -44,11 +48,13 @@ import com.darkrockstudios.apps.hammer.common.util.StrRes import com.darkrockstudios.apps.hammer.common.util.lifecycleCoroutineScope import com.darkrockstudios.apps.hammer.project_home_action_import_toast_failure import com.darkrockstudios.apps.hammer.project_home_action_import_toast_success -import com.darkrockstudios.apps.hammer.projects_list_toast_delete_failed import com.darkrockstudios.apps.hammer.projects_list_toast_sync_complete import com.darkrockstudios.apps.hammer.projects_list_toast_sync_failed -import com.darkrockstudios.apps.hammer.sync_log_account_failed +import com.darkrockstudios.apps.hammer.sync_log_begin_account +import com.darkrockstudios.apps.hammer.sync_log_begin_project +import com.darkrockstudios.apps.hammer.sync_log_begin_projects import com.darkrockstudios.apps.hammer.sync_log_end_projects +import com.darkrockstudios.apps.hammer.sync_log_project_conflict import io.github.aakira.napier.Napier import korlibs.datastructure.iterators.parallelMap import kotlinx.coroutines.CancellationException @@ -57,19 +63,18 @@ import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.Job import kotlinx.coroutines.NonCancellable import kotlinx.coroutines.cancel -import kotlinx.coroutines.delay -import kotlinx.coroutines.ensureActive +import kotlinx.coroutines.coroutineScope import kotlinx.coroutines.flow.first +import kotlinx.coroutines.joinAll import kotlinx.coroutines.launch -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.withContext +import kotlinx.coroutines.yield import net.peanuuutz.tomlkt.Toml import okio.FileSystem import okio.IOException import okio.Path.Companion.toPath import org.koin.core.component.inject -import kotlin.coroutines.coroutineContext +import org.koin.core.parameter.parametersOf import kotlin.time.Clock import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData as StoredData @@ -84,7 +89,6 @@ class ProjectsListComponent( private val globalSettingsStore: GlobalSettingsStore by inject() private val projectsRepository: ProjectsRepository by inject() private val projectsSynchronizer: ClientAccountSynchronizer by inject() - private val syncAccountUseCase: SyncAccountUseCase by inject() private val protocolMismatchRepository: ProtocolMismatchRepository by inject() private val networkConnectivity: NetworkConnectivity by inject() private val projectMetadataDatasource: ProjectMetadataDatasource by inject() @@ -97,8 +101,6 @@ class ProjectsListComponent( private var loadProjectsJob: Job? = null private var syncProjectsJob: Job? = null - private var importPreviewJob: Job? = null - private val importPreviewLock = Mutex() private var syncScope: CoroutineScope? = null private val modalRouter = ProjectListModalRouter( @@ -242,13 +244,16 @@ class ProjectsListComponent( } /** - * Reads `project_data.toml` (author, theme, word-count goal) via the datasource's - * scope-less helper — the projects list previews many projects and a full - * per-project Koin scope per row would be wasteful. Blocking variant because - * [loadProjectList]'s parallelMap workers are not a coroutine context. + * Reads `project_data.toml` (author, theme, word-count goal) without + * opening a per-project Koin scope — the projects list previews many + * projects and a full scope per row would be wasteful. */ - private fun loadStoredProjectData(projectDef: ProjectDef): StoredData = - readStoredProjectData(projectDef, fileSystem, toml).data + private fun loadStoredProjectData(projectDef: ProjectDef): StoredData { + val path = projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME + return fileSystem.readTomlOrNull(path, toml) { e -> + //Napier.d("Failed to read stored project data for ${projectDef.name}, using defaults", e) + }?.data ?: StoredData() + } private fun updateLastAccessed(projectDef: ProjectDef) { projectMetadataDatasource.updateMetadata(projectDef) { metadata -> @@ -277,7 +282,7 @@ class ProjectsListComponent( } override fun createProject(projectName: String) { - val result = projectsRepository.createProject(projectName, seedDefaultLanguage = true) + val result = projectsRepository.createProject(projectName) if (isSuccess(result)) { if (projectsSynchronizer.isServerSynchronized()) { projectsSynchronizer.createProject(projectName) @@ -295,33 +300,20 @@ class ProjectsListComponent( } override fun deleteProject(projectDef: ProjectDef) { - scope.launch(dispatcherIo) { - val projectId = projectsRepository.getProjectId(projectDef) - val syncedProject = if (projectId != null) { - SyncedProjectDefinition(projectDef, projectId) - } else { - null + val projectId = projectsRepository.getProjectId(projectDef) + val syncedProject = if (projectId != null) { + SyncedProjectDefinition(projectDef, projectId) + } else { + null + } + + if (projectsRepository.deleteProject(projectDef)) { + Napier.i("Project deleted: ${projectDef.name}") + if (syncedProject != null) { + projectsSynchronizer.deleteProject(syncedProject) } - val deleted = try { - projectsRepository.deleteProject(projectDef) - } catch (e: IOException) { - Napier.e("Failed to delete project: ${projectDef.name}", e) - false - } - - if (deleted) { - Napier.i("Project deleted: ${projectDef.name}") - if (syncedProject != null) { - projectsSynchronizer.deleteProject(syncedProject) - } else if (projectsSynchronizer.isServerSynchronized()) { - projectsSynchronizer.deleteUnsyncedProject(projectDef.name) - } - - loadProjectList() - } else { - showToast(scope, Res.string.projects_list_toast_delete_failed) - } + loadProjectList() } } @@ -358,41 +350,24 @@ class ProjectsListComponent( _state.getAndUpdate { it.copy(showImportFilePicker = false) } } - // Parsing a full manuscript is not instant, and both entry points are called from the UI - // thread, so the preview is always built off it and applied when it lands. override fun selectImportFile(name: String, content: ByteArray) { val sourceName = name.substringBeforeLast('.') val format = importerRegistry.formatForFileName(name) val initialOptions = ImportOptions(format = format) - - // Open on the picker closing rather than when the parse lands, so the dialog itself carries - // the wait instead of the projects list sitting there looking like nothing happened. + val preview = + importerRegistry.forFormat(format).preview(sourceName, content, initialOptions) + val projectName = preview.title?.takeIf { it.isNotBlank() } ?: sourceName _state.getAndUpdate { it.copy( showImportFilePicker = false, showImportDialog = true, importOptions = initialOptions, importSourceName = sourceName, - importProjectName = sourceName, + importProjectName = projectName, importFileContent = content, - importPreview = ImportPreview(emptyList()), - isParsingImport = true, + importPreview = preview, ) } - - launchPreview { - val preview = buildPreview(sourceName, content, initialOptions) ?: return@launchPreview - val projectName = preview.title?.takeIf { it.isNotBlank() } ?: sourceName - withContext(mainDispatcher) { - _state.getAndUpdate { - it.copy( - importProjectName = projectName, - importPreview = preview, - isParsingImport = false, - ) - } - } - } } override fun updateImportProjectName(name: String) { @@ -401,66 +376,17 @@ class ProjectsListComponent( override fun updateImportOptions(options: ImportOptions) { val current = _state.value - _state.getAndUpdate { it.copy(importOptions = options, isParsingImport = true) } - - launchPreview { - // debounce: options update as you type - delay(PREVIEW_DEBOUNCE_MS) - val preview = buildPreview( - sourceName = current.importSourceName, - content = current.importFileContent, - options = options, - ) ?: return@launchPreview - withContext(mainDispatcher) { - _state.getAndUpdate { it.copy(importPreview = preview, isParsingImport = false) } - } + val preview = importerRegistry.forFormat(options.format).preview( + sourceName = current.importSourceName, + content = current.importFileContent, + options = options, + ) + _state.getAndUpdate { + it.copy(importOptions = options, importPreview = preview) } } - private fun launchPreview(block: suspend CoroutineScope.() -> Unit) { - importPreviewJob?.cancel() - importPreviewJob = scope.launch(block = block) - } - - /** - * Parses off the UI thread, returning null when the import fails or the caller was cancelled. - * The importers hand off to third-party parsers that can throw on a malformed file, and an - * escaping throw would take the component's whole scope down with it. - */ - private suspend fun buildPreview( - sourceName: String, - content: ByteArray, - options: ImportOptions, - ): ImportPreview? { - // The parse never suspends, so cancelling only takes effect around it; hold the lock so a - // superseded parse can't run alongside its replacement. - val preview = importPreviewLock.withLock { - coroutineContext.ensureActive() - withContext(dispatcherDefault) { - try { - importerRegistry.forFormat(options.format).preview(sourceName, content, options) - } catch (e: CancellationException) { - throw e - // Import can fail many ways (parse, malformed file); report and show failure toast. - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Import: failed to parse '$sourceName'", e) - null - } - } - } - if (preview == null) { - withContext(mainDispatcher) { - _state.getAndUpdate { - it.copy(importPreview = ImportPreview(emptyList()), isParsingImport = false) - } - showToast(scope, Res.string.project_home_action_import_toast_failure) - } - } - return preview - } - override fun cancelImportDialog() { - importPreviewJob?.cancel() _state.getAndUpdate { it.copy( showImportDialog = false, @@ -468,23 +394,15 @@ class ProjectsListComponent( importSourceName = "", importProjectName = "", importPreview = ImportPreview(emptyList()), - isParsingImport = false, ) } } override suspend fun confirmImportDialog() { - // A re-parse triggered by a last-moment option change must not land after we snapshot. - importPreviewJob?.join() val projectName = _state.value.importProjectName val previewToImport = _state.value.importPreview - // That re-parse may have emptied the preview, and the button was enabled against the old one. - if (previewToImport.isEmpty) { - Napier.w("Import: nothing to import for '$projectName'") - return - } - val result = projectsRepository.createProject(projectName, seedDefaultLanguage = true) + val result = projectsRepository.createProject(projectName) if (!isSuccess(result)) { result.displayMessage?.let { msg -> showToast(scope, msg) } Napier.e("Import: failed to create project '$projectName'") @@ -526,45 +444,84 @@ class ProjectsListComponent( } } - private val syncListener = object : SyncAccountListener { - override suspend fun onLog(message: SyncLogMessage) { - onSyncLog(message) - } + private suspend fun syncProject( + projectDef: ProjectDef, + onLog: OnSyncLog, + onProgress: suspend (Float, SyncLogMessage?) -> Unit + ): ProjectSyncOutcome { + onLog(syncLogI(strRes.get(Res.string.sync_log_begin_project, projectDef.name), projectDef)) - override suspend fun onProjectsDiscovered(projects: List) { - syncNewProjectStatus(projects) - } + var success = false + var conflicted = false - override suspend fun onProjectProgress(projectDef: ProjectDef, progress: Float?) { - syncProgressStatus(projectDef.name, ProjectsList.Status.Syncing, progress) - } + try { + temporaryProjectTask(projectDef) { projScope -> + val synchronizer: ClientProjectSynchronizer = + projScope.get { parametersOf(projectDef) } + val conflictBroker: ProjectDataConflictBroker = + projScope.get { parametersOf(projectDef) } - override suspend fun onProjectOutcome(projectDef: ProjectDef, outcome: ProjectSyncOutcome) { - when (outcome) { - ProjectSyncOutcome.Success, - ProjectSyncOutcome.Unchanged -> - syncProgressStatus(projectDef.name, ProjectsList.Status.Complete, progress = 1f) + coroutineScope { + // Bulk account sync has no interactive resolver. A project-data conflict reports + // to the broker and waits on resolutions forever, leaving the project stuck + // "Syncing". Watch for it and abort so the project stops instead of hanging. + val conflictWatcher = launch { + for (conflict in conflictBroker.conflicts) { + onLog( + syncLogW( + strRes.get( + Res.string.sync_log_project_conflict, + projectDef.name + ), + projectDef + ) + ) + conflicted = true + conflictBroker.abort() + } + } - ProjectSyncOutcome.NeedsResolution -> - syncProgressStatus(projectDef.name, ProjectsList.Status.NeedsResolution) - - ProjectSyncOutcome.Failed -> - syncProgressStatus(projectDef.name, ProjectsList.Status.Failed) - - ProjectSyncOutcome.NotOnServer, - ProjectSyncOutcome.Skipped -> - syncProgressStatus(projectDef.name, ProjectsList.Status.Pending) + try { + success = synchronizer.sync( + onProgress = onProgress, + onLog = { message -> onLog(message) }, + onConflict = { + onLog( + syncLogW( + strRes.get( + Res.string.sync_log_project_conflict, + projectDef.name + ), + projectDef + ) + ) + conflicted = true + throw IllegalStateException("Entity conflict must be handled by Project sync") + }, + onComplete = {}, + onUnauthorized = ::showReauth + ) + } finally { + conflictWatcher.cancel() + } + } } + } catch (e: CancellationException) { + throw e + } catch (e: Exception) { + // A conflict aborts the entity sync by throwing; that's a resolvable state, not a failure. + if (!conflicted) throw e } - override suspend fun onUnauthorized() { - showReauth() + return when { + success -> ProjectSyncOutcome.Success + conflicted -> ProjectSyncOutcome.NeedsResolution + else -> ProjectSyncOutcome.Failed } - - override suspend fun onIdeaConflict(conflict: IdeaConflict): StoryIdea? = - this@ProjectsListComponent.onIdeaConflict(conflict) } + private enum class ProjectSyncOutcome { Success, NeedsResolution, Failed } + private suspend fun syncNewProjectStatus(projects: List) { val newStatuses = mutableMapOf() projects.forEach { projDef -> @@ -649,7 +606,98 @@ class ProjectsListComponent( syncProjectsJob = newScope.launch { try { - val allSuccess = syncAccountUseCase.execute(syncListener).allSuccess + var projects = projectsRepository.getProjects() + syncNewProjectStatus(projects) + + onSyncLog(syncAccLogI(strRes.get(Res.string.sync_log_begin_account))) + + var ideasSuccess = true + val success = projectsSynchronizer.syncProjects( + onLog = ::onSyncLog, + onUnauthorized = ::showReauth, + onIdeaConflict = ::onIdeaConflict, + onIdeasSyncResult = { ideasSuccess = it }, + ) + + yield() + + var allSuccess = success && ideasSuccess + if (success) { + onSyncLog(syncAccLogI(strRes.get(Res.string.sync_log_begin_projects))) + + projects = projectsRepository.getProjects() + syncNewProjectStatus(projects) + + // Only sync projects that have a serverProjectId assigned + val projectsToSync = projects.mapNotNull { projectDef -> + val metadata = projectMetadataDatasource.loadMetadata(projectDef) + val serverProjectId = metadata.info.serverProjectId + if (serverProjectId == null) { + Napier.w { "Skipping project sync for '${projectDef.name}' - no server project ID yet" } + syncProgressStatus(projectDef.name, ProjectsList.Status.Pending) + null + } else { + SyncedProjectDefinition(projectDef, serverProjectId) + } + } + + // Pre-sync change probe: skip projects the server confirms are unchanged. + val unchangedProjectIds = + projectsSynchronizer.probeUnchangedProjects(projectsToSync) + + projectsToSync.parallelMap { synced -> + val projectDef = synced.projectDef + newScope.launch { + try { + if (synced.projectId in unchangedProjectIds) { + onSyncLog(syncLogI("No changes — skipped", projectDef)) + syncProgressStatus( + projectDef.name, + ProjectsList.Status.Complete + ) + return@launch + } + + syncProgressStatus(projectDef.name, ProjectsList.Status.Syncing) + + suspend fun onProgress(progress: Float, message: SyncLogMessage?) { + syncProgressStatus( + projectDef.name, + ProjectsList.Status.Syncing, + progress + ) + if (message != null) onSyncLog(message) + } + + val outcome = syncProject(projectDef, ::onSyncLog, ::onProgress) + allSuccess = allSuccess && (outcome == ProjectSyncOutcome.Success) + + val newStatus = when (outcome) { + ProjectSyncOutcome.Success -> ProjectsList.Status.Complete + ProjectSyncOutcome.NeedsResolution -> ProjectsList.Status.NeedsResolution + ProjectSyncOutcome.Failed -> ProjectsList.Status.Failed + } + syncProgressStatus(projectDef.name, newStatus) + } catch (e: CancellationException) { + throw e + } catch (e: Exception) { + Napier.e("Project sync failed for ${projectDef.name}", e) + onSyncLog( + syncLogE( + "Sync failed: ${e.message ?: "Unknown error"}", + projectDef + ) + ) + allSuccess = false + syncProgressStatus(projectDef.name, ProjectsList.Status.Failed) + } + } + }.joinAll() + } else { + projects.forEach { projectDef -> + syncProgressStatus(projectDef.name, ProjectsList.Status.Failed) + } + } callback(allSuccess) @@ -674,9 +722,7 @@ class ProjectsListComponent( throw e } catch (e: Exception) { Napier.e("Projects sync failed", e) - onSyncLog( - syncAccLogE(strRes.get(Res.string.sync_log_account_failed, e.message ?: "Unknown error")) - ) + onSyncLog(syncAccLogE("Sync failed: ${e.message ?: "Unknown error"}")) callback(false) withContext(NonCancellable + mainDispatcher) { @@ -789,8 +835,4 @@ class ProjectsListComponent( override fun dismissProjectDelete() { modalRouter.dismissProjectDelete() } - - private companion object { - const val PREVIEW_DEBOUNCE_MS = 150L - } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeas.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeas.kt index 6fb7e9d4d..f75c5ca5a 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeas.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeas.kt @@ -7,7 +7,6 @@ import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeaError import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.dependencyinjection.HammerComponent -import kotlinx.serialization.Serializable interface StoryIdeas : HammerComponent { val state: Value @@ -17,14 +16,8 @@ interface StoryIdeas : HammerComponent { fun closeEditor() fun suggestTags(prefix: String): List - fun beginEdit() - fun discardEdit() - fun updateTitle(title: String) - fun updateContent(content: String) - fun updateTags(tags: List) - fun updateTagDraft(tagDraft: String) - - suspend fun saveDraft(): SaveResult + suspend fun createIdea(title: String?, content: String, tags: Set): IdeaError + suspend fun saveIdea(id: IdeaId, title: String?, content: String, tags: Set): IdeaError suspend fun deleteIdea(id: IdeaId) suspend fun archiveIdea(id: IdeaId) suspend fun unarchiveIdea(id: IdeaId) @@ -35,46 +28,10 @@ interface StoryIdeas : HammerComponent { data class State( val ideas: List = emptyList(), val editor: Editor? = null, - val draft: Draft? = null, ) sealed class Editor { data object Create : Editor() data class Edit(val idea: StoryIdea) : Editor() } - - /** - * The editor's working copy, alongside the baseline it was seeded from. Owned by the component - * rather than the composable so an Android configuration change or process death can't take - * unsaved text with it. - * - * Set whenever an editor opens and left in place when it closes, so the outgoing editor still - * has something to render while it animates away. Only meaningful while [State.editor] is set. - */ - @Serializable - data class Draft( - val isEditing: Boolean, - val title: String = "", - val content: String = "", - val tags: List = emptyList(), - /** Typed into the tag field but not yet committed to a chip; folded in on save. */ - val tagDraft: String = "", - val savedTitle: String? = null, - val savedContent: String = "", - val savedTags: Set = emptySet(), - ) { - val isDirty: Boolean - get() = isEditing && ( - title != savedTitle.orEmpty() || - content != savedContent || - tags.toSet() != savedTags || - tagDraft.isNotBlank() - ) - } - - sealed interface SaveResult { - data object Created : SaveResult - data object Saved : SaveResult - data class Failed(val error: IdeaError) : SaveResult - } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeasComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeasComponent.kt index 606774303..64f68a907 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeasComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/storyideas/StoryIdeasComponent.kt @@ -17,7 +17,6 @@ import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.data.tagindex.AccountTagService import kotlinx.coroutines.launch import kotlinx.coroutines.withContext -import kotlinx.serialization.Serializable import org.koin.core.component.inject class StoryIdeasComponent( @@ -28,20 +27,10 @@ class StoryIdeasComponent( private val promoteIdeaUseCase: PromoteIdeaUseCase by inject() private val accountTagService: AccountTagService by inject() - private val _state = MutableValue(restoreState()) + private val _state = MutableValue(StoryIdeas.State()) override val state: Value = _state init { - stateKeeper.register(EDITOR_KEY, SavedEditor.serializer()) { - val editor = _state.value.editor - val draft = _state.value.draft - if (editor == null || draft == null) { - null - } else { - SavedEditor(idea = (editor as? StoryIdeas.Editor.Edit)?.idea, draft = draft) - } - } - scope.launch { ideasRepository.ideasFlow.collect { ideas -> withContext(dispatcherMain) { @@ -54,67 +43,19 @@ class StoryIdeasComponent( scope.launch { accountTagService.refreshProjectTags() } } - private fun restoreState(): StoryIdeas.State { - val saved = stateKeeper.consume(EDITOR_KEY, SavedEditor.serializer()) - ?: return StoryIdeas.State() - - return StoryIdeas.State( - editor = saved.idea?.let { StoryIdeas.Editor.Edit(it) } ?: StoryIdeas.Editor.Create, - draft = saved.draft, - ) - } - override fun showCreate() { - _state.update { - it.copy( - editor = StoryIdeas.Editor.Create, - draft = StoryIdeas.Draft(isEditing = true), - ) - } + _state.update { it.copy(editor = StoryIdeas.Editor.Create) } } override fun editIdea(id: IdeaId) { val idea = _state.value.ideas.find { it.id == id } ?: return - _state.update { - it.copy( - editor = StoryIdeas.Editor.Edit(idea), - // An existing idea opens read-only; creating starts straight in edit mode. - draft = idea.asDraft(isEditing = false), - ) - } + _state.update { it.copy(editor = StoryIdeas.Editor.Edit(idea)) } } override fun closeEditor() { - // The draft is left behind on purpose: the detail pane cross-fades out after the editor - // clears, and it still needs something to draw. Reopening always seeds a fresh draft. _state.update { it.copy(editor = null) } } - override fun beginEdit() { - updateDraft { it.copy(isEditing = true) } - } - - override fun discardEdit() { - if (_state.value.editor is StoryIdeas.Editor.Create) { - closeEditor() - } else { - updateDraft { draft -> - draft.copy( - isEditing = false, - title = draft.savedTitle.orEmpty(), - content = draft.savedContent, - tags = draft.savedTags.toList(), - tagDraft = "", - ) - } - } - } - - override fun updateTitle(title: String) = updateDraft { it.copy(title = title) } - override fun updateContent(content: String) = updateDraft { it.copy(content = content) } - override fun updateTags(tags: List) = updateDraft { it.copy(tags = tags) } - override fun updateTagDraft(tagDraft: String) = updateDraft { it.copy(tagDraft = tagDraft) } - override fun suggestTags(prefix: String): List { // Uncapped: the tag field filters out tags already on the idea, so a small hard cap here // could empty the strip when an idea's own tags fill the top ranks. The field's flow row @@ -122,56 +63,15 @@ class StoryIdeasComponent( return accountTagService.suggest(prefix, limit = Int.MAX_VALUE).map { it.tag } } - override suspend fun saveDraft(): StoryIdeas.SaveResult { - val editor = _state.value.editor ?: return StoryIdeas.SaveResult.Failed(IdeaError.EMPTY) - val draft = _state.value.draft ?: return StoryIdeas.SaveResult.Failed(IdeaError.EMPTY) + override suspend fun createIdea(title: String?, content: String, tags: Set): IdeaError { + return ideasRepository.createIdea(content = content, title = title, tags = tags).toIdeaError() + } - val title = draft.title.trim().ifEmpty { null } - val pendingTag = draft.tagDraft.trim().removePrefix("#") - val tags = if (pendingTag.isEmpty()) draft.tags.toSet() else draft.tags.toSet() + pendingTag - - val result = withContext(dispatcherDefault) { - when (editor) { - StoryIdeas.Editor.Create -> ideasRepository.createIdea( - content = draft.content, - title = title, - tags = tags, - ) - - is StoryIdeas.Editor.Edit -> { - val stored = ideasRepository.getIdeaById(editor.idea.id) - if (stored == null) { - CResult.failure(InvalidIdea(IdeaError.EMPTY)) - } else { - ideasRepository.updateIdea( - stored.copy(title = title, content = draft.content, tags = tags) - ) - } - } - } - } - - return when (result) { - is ClientResult.Failure -> StoryIdeas.SaveResult.Failed( - (result.exception as? InvalidIdea)?.error ?: IdeaError.EMPTY - ) - - is ClientResult.Success -> withContext(dispatcherMain) { - val created = editor is StoryIdeas.Editor.Create - // The editor can move on while the write is in flight; the result belongs to the - // one that started it, so don't stamp it onto whatever is open now. - if (isStillOpen(editor)) { - if (created) { - closeEditor() - } else { - // Re-baseline off what was actually stored, so the trimming and tag cleaning - // the repository applies don't leave the editor looking dirty. - updateDraft { result.data.asDraft(isEditing = false) } - } - } - if (created) StoryIdeas.SaveResult.Created else StoryIdeas.SaveResult.Saved - } - } + override suspend fun saveIdea(id: IdeaId, title: String?, content: String, tags: Set): IdeaError { + val idea = ideasRepository.getIdeaById(id) ?: return IdeaError.EMPTY + return ideasRepository.updateIdea( + idea.copy(title = title, content = content, tags = tags) + ).toIdeaError() } override suspend fun deleteIdea(id: IdeaId) { @@ -190,39 +90,8 @@ class StoryIdeasComponent( return promoteIdeaUseCase(id) } - private fun isStillOpen(editor: StoryIdeas.Editor): Boolean { - val current = _state.value.editor - return when (editor) { - StoryIdeas.Editor.Create -> current is StoryIdeas.Editor.Create - is StoryIdeas.Editor.Edit -> (current as? StoryIdeas.Editor.Edit)?.idea?.id == editor.idea.id - } - } - - private fun updateDraft(transform: (StoryIdeas.Draft) -> StoryIdeas.Draft) { - _state.update { state -> - val draft = state.draft ?: return@update state - state.copy(draft = transform(draft)) - } - } - - private fun StoryIdea.asDraft(isEditing: Boolean) = StoryIdeas.Draft( - isEditing = isEditing, - title = title.orEmpty(), - content = content, - tags = tags.toList(), - savedTitle = title, - savedContent = content, - savedTags = tags, - ) - - @Serializable - private data class SavedEditor( - /** Null while creating a new idea. */ - val idea: StoryIdea?, - val draft: StoryIdeas.Draft, - ) - - private companion object { - const val EDITOR_KEY = "story-ideas-editor" + private fun ClientResult.toIdeaError(): IdeaError = when (this) { + is ClientResult.Success -> IdeaError.NONE + is ClientResult.Failure -> (exception as? InvalidIdea)?.error ?: IdeaError.EMPTY } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectsync/ProjectSynchronizationComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectsync/ProjectSynchronizationComponent.kt index f4444cea0..d5f58bc1a 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectsync/ProjectSynchronizationComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectsync/ProjectSynchronizationComponent.kt @@ -333,9 +333,7 @@ class ProjectSynchronizationComponent( entryType = local.type.text, text = local.text, tags = local.tags, - image = image, - aliases = local.aliases, - excludeFromDictionary = local.excludeFromDictionary, + image = image ) withContext(mainDispatcher) { @@ -378,10 +376,8 @@ class ProjectSynchronizationComponent( } } - private suspend fun onSyncComplete(success: Boolean) { - if (success) { - updateSyncLog(syncLogI("Sync complete!", projectDef)) - } + private suspend fun onSyncComplete() { + updateSyncLog(syncLogI("Sync complete!", projectDef)) updateSync(false, 1f) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettings.kt index a27afc80b..a497e3e20 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettings.kt @@ -11,14 +11,12 @@ interface SpellCheckSettings { suspend fun setSpellcheckEnable(enable: Boolean) suspend fun setSpellCheckingInFocusEnabled(enable: Boolean) - suspend fun setSpellCheckEncyclopediaEnabled(enable: Boolean) suspend fun setSpellCheckLanguage(language: Locale) @Serializable data class State( val spellCheckingEnabled: Boolean, val spellCheckingInFocusEnabled: Boolean, - val spellCheckingEncyclopediaEnabled: Boolean = true, @Serializable(with = LocaleSerializer::class) val spellCheckingLanguage: Locale, @Serializable(with = LocaleListSerializer::class) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettingsComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettingsComponent.kt index 814b35257..0647562b5 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettingsComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/spellchecksettings/SpellCheckSettingsComponent.kt @@ -27,7 +27,6 @@ class SpellCheckSettingsComponent( SpellCheckSettings.State( spellCheckingEnabled = globalSettingsStore.globalSettings.spellCheckSettings.enabled, spellCheckingInFocusEnabled = globalSettingsStore.globalSettings.spellCheckSettings.enabledInFocusMode, - spellCheckingEncyclopediaEnabled = globalSettingsStore.globalSettings.spellCheckSettings.includeEncyclopediaNames, spellCheckingLanguage = globalSettingsStore.globalSettings.spellCheckSettings.locale, spellCheckLanguages = platformSpellCheckerFactory.availableLocales().map { it.toLocale() }, ) @@ -48,7 +47,6 @@ class SpellCheckSettingsComponent( it.copy( spellCheckingEnabled = settings.spellCheckSettings.enabled, spellCheckingInFocusEnabled = settings.spellCheckSettings.enabledInFocusMode, - spellCheckingEncyclopediaEnabled = settings.spellCheckSettings.includeEncyclopediaNames, spellCheckingLanguage = settings.spellCheckSettings.locale ) } @@ -77,16 +75,6 @@ class SpellCheckSettingsComponent( } } - override suspend fun setSpellCheckEncyclopediaEnabled(enable: Boolean) { - globalSettingsStore.updateSettings { - it.copy( - spellCheckSettings = it.spellCheckSettings.copy( - includeEncyclopediaNames = enable - ) - ) - } - } - override suspend fun setSpellCheckLanguage(locale: Locale) { globalSettingsStore.updateSettings { it.copy( diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/DetailsRouter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/DetailsRouter.kt index e9205eda8..ba6d88410 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/DetailsRouter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/DetailsRouter.kt @@ -7,12 +7,9 @@ import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.Draf import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftCompareComponent import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftsList import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftsListComponent -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderModeComponent import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditor import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditorComponent import com.darkrockstudios.apps.hammer.common.data.MenuDescriptor -import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.drafts.DraftDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef @@ -21,7 +18,6 @@ import kotlinx.serialization.Serializable internal class DetailsRouter( componentContext: ComponentContext, - private val projectDef: ProjectDef, private val selectedSceneItem: MutableSharedFlow, private val removeMenu: (id: String) -> Unit, private val closeDetails: () -> Unit, @@ -65,10 +61,6 @@ internal class DetailsRouter( draftDef = config.draftDef ) ) - - is Config.Reader -> StoryEditor.ChildDestination.Detail.ReaderDestination( - readerMode(componentContext = componentContext, sceneDef = config.sceneDef) - ) } private fun sceneEditor(componentContext: ComponentContext, sceneDef: SceneItem): SceneEditor = @@ -80,7 +72,6 @@ internal class DetailsRouter( closeSceneEditor = closeDetails, showDraftsList = ::showDraftsList, showFocusMode = openFocusMode, - showReader = ::showReader, showEntry = openEntry, showGlobalSearchForTag = openGlobalSearchForTag, ) @@ -106,36 +97,6 @@ internal class DetailsRouter( backToEditor = ::backToEditor ) - private fun readerMode(componentContext: ComponentContext, sceneDef: SceneItem?): ReaderMode = - ReaderModeComponent( - componentContext = componentContext, - projectDef = projectDef, - initialScene = sceneDef, - closeReader = closeDetails, - openSceneEditor = ::showScene, - onSceneInView = { selectedSceneItem.tryEmit(it) }, - ) - - fun activeReader(): ReaderMode? = - (stack.value.active.instance as? StoryEditor.ChildDestination.Detail.ReaderDestination)?.component - - // An open reader is reused: its config holds only the scene it was opened at. - fun showReader(sceneDef: SceneItem?) { - val reader = activeReader() - if (reader != null) { - sceneDef?.let(reader::showScene) - return - } - - navigation.navigate( - transformer = { stack -> - stack.dropLastWhile { it !is Config.None } - .plus(Config.Reader(sceneDef = sceneDef)) - }, - onComplete = { _, _ -> } - ) - } - fun showScene(sceneDef: SceneItem) { val top = stack.value.active.configuration if (top is Config.SceneEditor && top.sceneDef.id == sceneDef.id) return @@ -188,7 +149,6 @@ internal class DetailsRouter( fun isAtRoot(): Boolean { return stack.active.configuration is Config.SceneEditor || - stack.active.configuration is Config.Reader || stack.active.configuration is Config.None } @@ -216,8 +176,5 @@ internal class DetailsRouter( @Serializable data class DraftCompare(val sceneDef: SceneItem, val draftDef: DraftDef) : Config() - - @Serializable - data class Reader(val sceneDef: SceneItem?) : Config() } } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/ListRouter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/ListRouter.kt index 79be0e000..99f9c9ce8 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/ListRouter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/ListRouter.kt @@ -14,9 +14,7 @@ internal class ListRouter( private val projectDef: ProjectDef, private val selectedSceneItem: SharedFlow, private val onSceneSelected: (sceneDef: SceneItem) -> Unit, - private val openSceneEditor: (sceneDef: SceneItem) -> Unit, private val showOutlineOverview: () -> Unit, - private val showReaderMode: () -> Unit, ) { private val navigation = StackNavigation() @@ -42,9 +40,7 @@ internal class ListRouter( projectDef = projectDef, selectedSceneItem = selectedSceneItem, sceneSelected = onSceneSelected, - openSceneEditor = openSceneEditor, showOutlineOverviewDialog = showOutlineOverview, - showReader = showReaderMode, ) fun moveToBackStack() { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditor.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditor.kt index 5c37e99cb..02801d2eb 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditor.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditor.kt @@ -9,7 +9,6 @@ import com.darkrockstudios.apps.hammer.common.components.projectroot.Router import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftCompare import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftsList import com.darkrockstudios.apps.hammer.common.components.storyeditor.outlineoverview.OutlineOverview -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditor import com.darkrockstudios.apps.hammer.common.components.storyeditor.scenelist.SceneList import com.darkrockstudios.apps.hammer.common.data.ProjectDef @@ -39,9 +38,6 @@ interface StoryEditor : AppCloseManager, Router, HammerComponent, BackHandlerOwn fun closeDetails(): Boolean fun showScene(sceneItem: SceneItem) - /** Opens the reader at [sceneItem], or at the start of the story when null. */ - fun showReader(sceneItem: SceneItem?) - sealed class ChildDestination { sealed class List : ChildDestination() { data class Scenes(val component: SceneList) : List() @@ -52,7 +48,6 @@ interface StoryEditor : AppCloseManager, Router, HammerComponent, BackHandlerOwn data class EditorDestination(val component: SceneEditor) : Detail() data class DraftsDestination(val component: DraftsList) : Detail() data class DraftCompareDestination(val component: DraftCompare) : Detail() - data class ReaderDestination(val component: ReaderMode) : Detail() data object None : Detail() } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditorComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditorComponent.kt index c5c9778b2..fc7b7e688 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditorComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/StoryEditorComponent.kt @@ -46,7 +46,6 @@ class StoryEditorComponent( private val detailsRouter = DetailsRouter( componentContext = this, - projectDef = projectDef, selectedSceneItem = selectedSceneItemFlow, addMenu = addMenu, closeDetails = ::closeDetails, @@ -62,9 +61,7 @@ class StoryEditorComponent( projectDef = projectDef, selectedSceneItem = selectedSceneItemFlow, onSceneSelected = ::onSceneSelected, - openSceneEditor = ::showScene, - showOutlineOverview = ::showOutlineOverview, - showReaderMode = { showReader(null) }, + showOutlineOverview = ::showOutlineOverview ) private val dialogNavigation = SlotNavigation() @@ -125,26 +122,9 @@ class StoryEditorComponent( detailsRouter.closeScene() } - // While the reader is open the scene list is its table of contents. private fun onSceneSelected(sceneItem: SceneItem) { - if (detailsRouter.activeReader() != null) { - showReader(sceneItem) - } else { - showScene(sceneItem) - } - } - - override fun showScene(sceneItem: SceneItem) { detailsRouter.showScene(sceneItem) - showDetailsPane() - } - override fun showReader(sceneItem: SceneItem?) { - detailsRouter.showReader(sceneItem) - showDetailsPane() - } - - private fun showDetailsPane() { if (isMultiPaneMode()) { listRouter.show() } else { @@ -152,6 +132,10 @@ class StoryEditorComponent( } } + override fun showScene(sceneItem: SceneItem) { + onSceneSelected(sceneItem) + } + override fun setMultiPane(isMultiPane: Boolean) { _state.getAndUpdate { it.copy(isMultiPane = isMultiPane) } @@ -228,7 +212,6 @@ class StoryEditorComponent( is DetailsRouter.Config.DraftCompare -> config.sceneDef is DetailsRouter.Config.DraftsList -> config.sceneDef is DetailsRouter.Config.SceneEditor -> config.sceneDef - is DetailsRouter.Config.Reader -> null DetailsRouter.Config.None -> null } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusMode.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusMode.kt index 9707e3bea..0504e15c9 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusMode.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusMode.kt @@ -19,20 +19,12 @@ interface FocusMode { fun increaseTextSize() fun resetTextSize() - /** Persists the user's editor max width in dp. Call on drag end, not per frame. */ - fun setEditorMaxWidth(width: Float) - fun resetEditorMaxWidth() - - /** Adds a flagged word to the project's spell-check dictionary. */ - fun addWordToDictionary(word: String) - data class State( val projectDef: ProjectDef, val sceneItem: SceneItem, val sceneBuffer: SceneBuffer? = null, val isLoading: Boolean = true, val textSize: Float = GlobalSettings.DEFAULT_FONT_SIZE, - val editorMaxWidth: Float = GlobalSettings.DEFAULT_EDITOR_WIDTH, val spellChecker: PlatformSpellChecker? = null, val spellCheckingEnabled: Boolean = false, ) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusModeComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusModeComponent.kt index bd5cf5a43..df3bdad2c 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusModeComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/focusmode/FocusModeComponent.kt @@ -5,15 +5,13 @@ import com.arkivanov.decompose.value.MutableValue import com.arkivanov.decompose.value.getAndUpdate import com.arkivanov.decompose.value.update import com.darkrockstudios.apps.hammer.common.components.ProjectComponentBase -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.clampEditorWidth import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.decreaseEditorTextSize import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.increaseEditorTextSize import com.darkrockstudios.apps.hammer.common.data.* import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository +import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import io.github.aakira.napier.Napier import kotlinx.coroutines.Job import kotlinx.coroutines.launch @@ -29,8 +27,7 @@ class FocusModeComponent( ) : ProjectComponentBase(projectDef, componentContext), FocusMode { private val settingsRepository: GlobalSettingsStore by inject() - private val spellCheckRepository: ProjectSpellCheckRepository by projectInject() - private val projectDictionary: ProjectDictionaryUseCase by projectInject() + private val spellCheckRepository: SpellCheckRepository by inject() private val focusModeService: FocusModeService by inject() private val sceneEditor: SceneEditorService by projectInject() @@ -42,7 +39,6 @@ class FocusModeComponent( projectDef = projectDef, sceneItem = sceneItem, spellCheckingEnabled = (settingsRepository.globalSettings.spellCheckSettings.isEnabledInFocusMode()), - editorMaxWidth = settingsRepository.globalSettings.editorMaxWidth, ) ) override val state = _state @@ -118,30 +114,6 @@ class FocusModeComponent( } } - override fun setEditorMaxWidth(width: Float) { - scope.launch { - settingsRepository.updateSettings { - it.copy( - editorMaxWidth = clampEditorWidth(width) - ) - } - } - } - - override fun resetEditorMaxWidth() { - scope.launch { - settingsRepository.updateSettings { - it.copy( - editorMaxWidth = GlobalSettings.DEFAULT_EDITOR_WIDTH - ) - } - } - } - - override fun addWordToDictionary(word: String) { - scope.launch { projectDictionary.addWord(word) } - } - private fun subscribeToBufferUpdates() { Napier.d { "FocusModeComponent start collecting buffer updates" } @@ -157,7 +129,6 @@ class FocusModeComponent( _state.getAndUpdate { it.copy( textSize = settings.editorFontSize, - editorMaxWidth = settings.editorMaxWidth, spellCheckingEnabled = settings.spellCheckSettings.isEnabledInFocusMode(), ) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderMode.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderMode.kt deleted file mode 100644 index d5fe67d66..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderMode.kt +++ /dev/null @@ -1,53 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode - -import androidx.compose.runtime.Immutable -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings - -interface ReaderMode { - val state: Value - - fun showChapter(chapterId: Int) - fun nextChapter() - fun previousChapter() - - /** Brings [sceneItem] into view, switching chapters when it lives in another one. */ - fun showScene(sceneItem: SceneItem) - fun scrollHandled() - fun sceneInView(sceneItem: SceneItem?) - - /** Opens [sceneItem] in the scene editor, or the scene being read when null. */ - fun editScene(sceneItem: SceneItem? = null) - - fun toggleSceneHeadings() - fun increaseFontSize() - fun decreaseFontSize() - fun resetFontSize() - fun setEditorMaxWidth(width: Float) - fun resetEditorMaxWidth() - fun close() - - @Immutable - data class State( - val chapters: List = emptyList(), - val activeChapterId: Int? = null, - val scenes: List = emptyList(), - val isLoading: Boolean = true, - val showSceneHeadings: Boolean = false, - val fontSize: Float = GlobalSettings.DEFAULT_FONT_SIZE, - val editorMaxWidth: Float = GlobalSettings.DEFAULT_EDITOR_WIDTH, - /** One-shot request for the UI to scroll to a scene; cleared by [scrollHandled]. */ - val scrollToSceneId: Int? = null, - val sceneInView: SceneItem? = null, - ) { - val activeChapterIndex: Int - get() = chapters.indexOfFirst { it.chapter.id == activeChapterId } - } - - @Immutable - data class ReaderChapter(val chapter: SceneItem, val sceneCount: Int) - - @Immutable - data class ReaderScene(val sceneItem: SceneItem, val markdown: String) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderModeComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderModeComponent.kt deleted file mode 100644 index b05b5509c..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/readermode/ReaderModeComponent.kt +++ /dev/null @@ -1,341 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.common.components.ProjectComponentBase -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.clampEditorWidth -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.decreaseEditorTextSize -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.increaseEditorTextSize -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SceneBuffer -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.SceneSummary -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectInject -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.tree.ChapterScenes -import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree -import com.darkrockstudios.apps.hammer.common.data.tree.collectChapters -import kotlinx.coroutines.Job -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext -import kotlinx.serialization.Serializable -import org.koin.core.component.inject - -class ReaderModeComponent( - componentContext: ComponentContext, - projectDef: ProjectDef, - initialScene: SceneItem?, - private val closeReader: () -> Unit, - private val openSceneEditor: (SceneItem) -> Unit, - private val onSceneInView: (SceneItem?) -> Unit, -) : ProjectComponentBase(projectDef, componentContext), ReaderMode { - - private val sceneEditor: SceneEditorService by projectInject() - private val settingsStore: GlobalSettingsStore by inject() - - private var lastTree: ImmutableTree = sceneEditor.getSceneTree() - private var chapterScenes: List = lastTree.collectChapters() - - private var loadJob: Job? = null - private val bufferJobs = mutableMapOf() - - // Text from buffer updates that arrived during a load; newer than what the load read. - private val pendingMarkdown = mutableMapOf() - - private val _state = MutableValue(initialState(initialScene)) - override val state: Value = _state - - init { - stateKeeper.register(SAVED_STATE_KEY, ReaderSavedState.serializer()) { - val current = _state.value - ReaderSavedState( - activeChapterId = current.activeChapterId, - sceneId = current.scrollToSceneId ?: current.sceneInView?.id, - ) - } - } - - private fun initialState(initialScene: SceneItem?): ReaderMode.State { - val saved = stateKeeper.consume(SAVED_STATE_KEY, ReaderSavedState.serializer()) - val startSceneId = if (saved != null) saved.sceneId else initialScene?.id - val startChapter = chapterScenes.firstOrNull { it.chapter.id == saved?.activeChapterId } - ?: startSceneId?.let(::chapterContaining) - ?: chapterScenes.firstOrNull() - val settings = settingsStore.globalSettings - - return ReaderMode.State( - chapters = chapterScenes.toReaderChapters(), - activeChapterId = startChapter?.chapter?.id, - showSceneHeadings = settings.readerShowSceneHeadings, - fontSize = settings.readerFontSize, - editorMaxWidth = settings.editorMaxWidth, - scrollToSceneId = startSceneId?.takeIf { id -> startChapter?.scenes?.any { it.id == id } == true }, - ) - } - - override fun onCreate() { - super.onCreate() - - watchSettings() - watchSceneTree() - sceneEditor.subscribeToBufferUpdates(null, scope, ::onBufferUpdate) - - val chapterId = _state.value.activeChapterId - if (chapterId != null) { - loadChapter(chapterId, clearScenes = true) - } else { - _state.update { it.copy(isLoading = false) } - } - } - - private fun chapterContaining(sceneId: Int): ChapterScenes? = - chapterScenes.firstOrNull { chapter -> chapter.scenes.any { it.id == sceneId } } - - private fun List.toReaderChapters() = - map { ReaderMode.ReaderChapter(chapter = it.chapter, sceneCount = it.scenes.size) } - - private fun loadChapter(chapterId: Int, clearScenes: Boolean) { - val scenes = chapterScenes.firstOrNull { it.chapter.id == chapterId }?.scenes ?: return - - loadJob?.cancel() - bufferJobs.values.forEach { it.cancel() } - bufferJobs.clear() - pendingMarkdown.clear() - - _state.update { - it.copy( - activeChapterId = chapterId, - scenes = if (clearScenes) emptyList() else it.scenes, - isLoading = true, - ) - } - - loadJob = scope.launch { - val loaded = withContext(dispatcherIo) { - scenes.map { scene -> - ReaderMode.ReaderScene(scene, sceneEditor.getCurrentSceneContentOrNull(scene) ?: "") - } - } - withContext(dispatcherMain) { - if (_state.value.activeChapterId != chapterId) return@withContext - val current = loaded.map { scene -> - pendingMarkdown[scene.sceneItem.id]?.let { scene.copy(markdown = it) } ?: scene - } - pendingMarkdown.clear() - _state.update { it.copy(scenes = current, isLoading = false) } - } - } - } - - // Collected directly: subscribeToSceneUpdates would force a scene list reload from disk. - private fun watchSceneTree() { - scope.launch { - sceneEditor.sceneListChannel.collect { summary -> - withContext(dispatcherMain) { onSceneTreeUpdate(summary) } - } - } - } - - private fun watchSettings() { - scope.launch { - settingsStore.globalSettingsUpdates.collect { settings -> - withContext(dispatcherMain) { - _state.update { - it.copy( - showSceneHeadings = settings.readerShowSceneHeadings, - fontSize = settings.readerFontSize, - editorMaxWidth = settings.editorMaxWidth, - ) - } - } - } - } - } - - // Scene updates also fire on every autosave, so anything but a changed tree is ignored. - private fun onSceneTreeUpdate(summary: SceneSummary) { - val tree = summary.sceneTree - if (tree == lastTree) return - lastTree = tree - - val previousChapters = chapterScenes - chapterScenes = tree.collectChapters() - if (chapterScenes.isEmpty()) { - showEmptyStory() - return - } - - val activeId = _state.value.activeChapterId - val previousIndex = previousChapters.indexOfFirst { it.chapter.id == activeId } - val active = chapterScenes.firstOrNull { it.chapter.id == activeId } - ?: chapterScenes[previousIndex.coerceIn(0, chapterScenes.lastIndex)] - val previousSceneIds = previousChapters.getOrNull(previousIndex)?.scenes?.map { it.id } - val sceneIds = active.scenes.map { it.id } - - _state.update { it.copy(chapters = chapterScenes.toReaderChapters()) } - - if (active.chapter.id != activeId) { - _state.update { it.copy(scrollToSceneId = null, sceneInView = null) } - loadChapter(active.chapter.id, clearScenes = true) - onSceneInView(null) - } else if (sceneIds != previousSceneIds) { - loadChapter(active.chapter.id, clearScenes = false) - } else { - val current = active.scenes.associateBy { it.id } - _state.update { state -> - state.copy( - scenes = state.scenes.map { it.copy(sceneItem = current[it.sceneItem.id] ?: it.sceneItem) }, - sceneInView = state.sceneInView?.let { current[it.id] ?: it }, - ) - } - } - } - - private fun showEmptyStory() { - loadJob?.cancel() - bufferJobs.values.forEach { it.cancel() } - bufferJobs.clear() - pendingMarkdown.clear() - - val hadSceneInView = _state.value.sceneInView != null - _state.update { - it.copy( - chapters = emptyList(), - activeChapterId = null, - scenes = emptyList(), - isLoading = false, - scrollToSceneId = null, - sceneInView = null, - ) - } - if (hadSceneInView) onSceneInView(null) - } - - private fun activeChapterHasScene(sceneId: Int): Boolean = - chapterScenes.firstOrNull { it.chapter.id == _state.value.activeChapterId } - ?.scenes?.any { it.id == sceneId } == true - - private suspend fun onBufferUpdate(buffer: SceneBuffer) { - val sceneId = buffer.content.scene.id - if (!activeChapterHasScene(sceneId)) return - - bufferJobs[sceneId]?.cancel() - bufferJobs[sceneId] = scope.launch { - val markdown = withContext(dispatcherDefault) { buffer.content.coerceMarkdown() } - withContext(dispatcherMain) { - if (!activeChapterHasScene(sceneId)) return@withContext - if (_state.value.isLoading) pendingMarkdown[sceneId] = markdown - _state.update { state -> - state.copy( - scenes = state.scenes.map { - if (it.sceneItem.id == sceneId && it.markdown != markdown) it.copy(markdown = markdown) else it - } - ) - } - } - } - } - - override fun showChapter(chapterId: Int) { - if (chapterId == _state.value.activeChapterId) return - if (chapterScenes.none { it.chapter.id == chapterId }) return - - _state.update { it.copy(scrollToSceneId = null, sceneInView = null) } - loadChapter(chapterId, clearScenes = true) - onSceneInView(null) - } - - private fun showChapterAtOffset(offset: Int) { - val index = chapterScenes.indexOfFirst { it.chapter.id == _state.value.activeChapterId } - if (index < 0) return - val target = chapterScenes.getOrNull(index + offset) ?: return - showChapter(target.chapter.id) - } - - override fun nextChapter() = showChapterAtOffset(1) - - override fun previousChapter() = showChapterAtOffset(-1) - - override fun showScene(sceneItem: SceneItem) { - val chapter = chapterScenes.firstOrNull { it.chapter.id == sceneItem.id } - ?: chapterContaining(sceneItem.id) - if (chapter == null) { - // The list has already highlighted the tapped scene; put it back on the one in view. - onSceneInView(_state.value.sceneInView) - return - } - val targetId = if (sceneItem.type == SceneItem.Type.Scene) { - sceneItem.id - } else { - chapter.scenes.firstOrNull()?.id - } - - if (chapter.chapter.id != _state.value.activeChapterId) { - _state.update { it.copy(sceneInView = null) } - loadChapter(chapter.chapter.id, clearScenes = true) - } - _state.update { it.copy(scrollToSceneId = targetId) } - } - - override fun scrollHandled() { - val current = _state.value - val targetId = current.scrollToSceneId ?: return - val target = current.scenes.firstOrNull { it.sceneItem.id == targetId }?.sceneItem - - _state.update { it.copy(scrollToSceneId = null, sceneInView = target ?: it.sceneInView) } - if (target != null && target != current.sceneInView) onSceneInView(target) - } - - // Ignored while a scroll is pending, or the list highlight jumps to whatever is on screen first. - override fun sceneInView(sceneItem: SceneItem?) { - val current = _state.value - if (current.scrollToSceneId != null || sceneItem == current.sceneInView) return - - _state.update { it.copy(sceneInView = sceneItem) } - onSceneInView(sceneItem) - } - - override fun editScene(sceneItem: SceneItem?) { - val current = _state.value - val target = sceneItem - ?: current.sceneInView - ?: chapterScenes.firstOrNull { it.chapter.id == current.activeChapterId }?.scenes?.firstOrNull() - ?: return - openSceneEditor(target) - } - - private fun updateSettings(transform: (GlobalSettings) -> GlobalSettings) { - scope.launch { settingsStore.updateSettings(transform) } - } - - override fun toggleSceneHeadings() = - updateSettings { it.copy(readerShowSceneHeadings = !it.readerShowSceneHeadings) } - - override fun increaseFontSize() = - updateSettings { it.copy(readerFontSize = increaseEditorTextSize(it.readerFontSize)) } - - override fun decreaseFontSize() = - updateSettings { it.copy(readerFontSize = decreaseEditorTextSize(it.readerFontSize)) } - - override fun resetFontSize() = - updateSettings { it.copy(readerFontSize = GlobalSettings.DEFAULT_FONT_SIZE) } - - override fun setEditorMaxWidth(width: Float) = - updateSettings { it.copy(editorMaxWidth = clampEditorWidth(width)) } - - override fun resetEditorMaxWidth() = - updateSettings { it.copy(editorMaxWidth = GlobalSettings.DEFAULT_EDITOR_WIDTH) } - - override fun close() = closeReader() - - @Serializable - private data class ReaderSavedState(val activeChapterId: Int?, val sceneId: Int?) - - companion object { - private const val SAVED_STATE_KEY = "ReaderMode" - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditor.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditor.kt index de4c9270d..5bdcb3cd8 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditor.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditor.kt @@ -51,15 +51,7 @@ interface SceneEditor : HammerComponent, ComponentToaster { fun decreaseTextSize() fun increaseTextSize() fun resetTextSize() - - /** Persists the user's editor max width in dp. Call on drag end, not per frame. */ - fun setEditorMaxWidth(width: Float) - fun resetEditorMaxWidth() fun enterFocusMode() - fun readScene() - - /** Adds a flagged word to the project's spell-check dictionary. */ - fun addWordToDictionary(word: String) data class State( val sceneItem: SceneItem, @@ -76,7 +68,6 @@ interface SceneEditor : HammerComponent, ComponentToaster { val showMetadataModal: Boolean = false, val menuItems: Set = emptySet(), val textSize: Float = GlobalSettings.DEFAULT_FONT_SIZE, - val editorMaxWidth: Float = GlobalSettings.DEFAULT_EDITOR_WIDTH, val spellChecker: PlatformSpellChecker? = null, val spellCheckingEnabled: Boolean = true, ) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorComponent.kt index 46b15dafe..d98ccffcb 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorComponent.kt @@ -16,14 +16,12 @@ import com.darkrockstudios.apps.hammer.common.data.* import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftRepository import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings.Companion.DEFAULT_EDITOR_WIDTH import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings.Companion.DEFAULT_FONT_SIZE import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.references.AutoConfirmReferencesUseCase import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository +import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import io.github.aakira.napier.Napier import kotlinx.coroutines.Job import kotlinx.coroutines.launch @@ -39,7 +37,6 @@ class SceneEditorComponent( private val closeSceneEditor: () -> Unit, private val showDraftsList: (SceneItem) -> Unit, private val showFocusMode: (SceneItem) -> Unit, - private val showReader: (SceneItem) -> Unit, showEntry: (EntryDef) -> Unit, showGlobalSearchForTag: (String) -> Unit, ) : ProjectComponentBase(originalSceneItem.projectDef, componentContext), @@ -51,15 +48,13 @@ class SceneEditorComponent( private val draftsRepository: SceneDraftRepository by projectInject() private val autoConfirmReferences: AutoConfirmReferencesUseCase by projectInject() - private val spellCheckRepository: ProjectSpellCheckRepository by projectInject() - private val projectDictionary: ProjectDictionaryUseCase by projectInject() + private val spellCheckRepository: SpellCheckRepository by inject() private val _state = MutableValue( SceneEditor.State( sceneItem = originalSceneItem, spellCheckingEnabled = settingsRepository.globalSettings.spellCheckSettings.enabled, metadataPanelVisible = settingsRepository.globalSettings.metadataPanelVisible, - editorMaxWidth = settingsRepository.globalSettings.editorMaxWidth, ) ) override val state: Value = _state @@ -89,14 +84,12 @@ class SceneEditorComponent( val current = _state.value if ( current.spellCheckingEnabled != settings.spellCheckSettings.enabled || - current.metadataPanelVisible != settings.metadataPanelVisible || - current.editorMaxWidth != settings.editorMaxWidth + current.metadataPanelVisible != settings.metadataPanelVisible ) { _state.update { it.copy( spellCheckingEnabled = settings.spellCheckSettings.enabled, metadataPanelVisible = settings.metadataPanelVisible, - editorMaxWidth = settings.editorMaxWidth, ) } } @@ -118,7 +111,6 @@ class SceneEditorComponent( sceneItem = newSceneItem.value ) } - sceneMetadataComponent.onSceneItemChanged(newSceneItem.value) } else { Napier.e("Scene ${sceneDef.id} no longer exists in the tree, this are probably going to break.") } @@ -285,15 +277,6 @@ class SceneEditorComponent( enterFocusMode() } - val readItem = MenuItemDescriptor( - "scene-editor-read", - Res.string.scene_editor_menu_item_read, - "" - ) { - Napier.i("Read scene") - readScene() - } - val menuItems = setOf( renameItem, saveItem, @@ -304,7 +287,6 @@ class SceneEditorComponent( saveDraftItem, metadataItem, focusModeItem, - readItem, closeItem, ) val menu = MenuDescriptor( @@ -480,38 +462,10 @@ class SceneEditorComponent( } } - override fun setEditorMaxWidth(width: Float) { - scope.launch { - settingsRepository.updateSettings { - it.copy( - editorMaxWidth = clampEditorWidth(width) - ) - } - } - } - - override fun resetEditorMaxWidth() { - scope.launch { - settingsRepository.updateSettings { - it.copy( - editorMaxWidth = DEFAULT_EDITOR_WIDTH - ) - } - } - } - override fun enterFocusMode() { showFocusMode(sceneDef) } - override fun readScene() { - showReader(sceneDef) - } - - override fun addWordToDictionary(word: String) { - scope.launch { projectDictionary.addWord(word) } - } - override fun decreaseTextSize() { scope.launch { val size = decreaseEditorTextSize(state.value.textSize) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorUtils.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorUtils.kt index 508f43dd5..09d5408da 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorUtils.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/SceneEditorUtils.kt @@ -1,17 +1,14 @@ package com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import korlibs.memory.clamp -/** The body text sizes the editor steps through. A size off the ladder snaps to it on the next step. */ -val EDITOR_TEXT_SIZES = listOf(12f, 14f, 16f, 18f, 20f, 24f, 28f, 32f) +val MIN_FONT_SIZE = 8f +val MAX_FONT_SIZE = 32f -fun increaseEditorTextSize(currentSize: Float): Float = - EDITOR_TEXT_SIZES.firstOrNull { it > currentSize } ?: EDITOR_TEXT_SIZES.last() - -fun decreaseEditorTextSize(currentSize: Float): Float = - EDITOR_TEXT_SIZES.lastOrNull { it < currentSize } ?: EDITOR_TEXT_SIZES.first() - -fun clampEditorWidth(width: Float): Float { - return width.clamp(GlobalSettings.MIN_EDITOR_WIDTH, GlobalSettings.MAX_EDITOR_WIDTH) +fun increaseEditorTextSize(currentSize: Float): Float { + return (currentSize + 1f).clamp(MIN_FONT_SIZE, MAX_FONT_SIZE) } + +fun decreaseEditorTextSize(currentSize: Float): Float { + return (currentSize - 1f).clamp(MIN_FONT_SIZE, MAX_FONT_SIZE) +} \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/EntryAddSearch.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/EntryAddSearch.kt index 94a9f1f11..5c97839fb 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/EntryAddSearch.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/EntryAddSearch.kt @@ -1,7 +1,6 @@ package com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.scenemetadata import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType /** * Pre-loaded searchable representation of an encyclopedia entry: its [EntryDef] @@ -25,9 +24,6 @@ internal data class SearchableEntry( * Behavior: * - Empty / blank query -> empty result. * - Match: case-insensitive substring against name and any alias. - * - Restricted to [types], so a caller showing one tab per entry-type group - * narrows before [maxResults] truncates. Filtering after truncation would - * let a run of alphabetically-early entries from one group starve another. * - Already-confirmed entries are excluded (they're already chips above the * search field; surfacing them again is noise). * - Already-dismissed entries are included, with `isDismissed = true` so the @@ -41,13 +37,11 @@ internal fun filterEntriesForAdd( confirmedIds: Set, dismissedIds: Set, maxResults: Int, - types: Set = EntryType.entries.toSet(), ): List { val q = query.trim().lowercase() if (q.isEmpty()) return emptyList() return entries .asSequence() - .filter { it.entryDef.type in types } .filter { it.entryDef.id !in confirmedIds } .filter { entry -> entry.lowerCaseSearchTerms.any { it.contains(q) } } .sortedBy { it.entryDef.name.lowercase() } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanel.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanel.kt index 8165c3d17..9a30ea60a 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanel.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanel.kt @@ -3,7 +3,6 @@ package com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneedito import com.arkivanov.decompose.value.Value import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata import com.darkrockstudios.apps.hammer.common.data.tagindex.TagSuggesting import com.darkrockstudios.apps.hammer.common.dependencyinjection.HammerComponent @@ -11,7 +10,6 @@ import com.darkrockstudios.apps.hammer.common.dependencyinjection.HammerComponen interface SceneMetadataPanel : HammerComponent, TagSuggesting { val state: Value - fun onSceneItemChanged(sceneItem: SceneItem) fun updateOutline(text: String) fun updateNotes(text: String) fun updateDraftName(text: String) @@ -29,22 +27,18 @@ interface SceneMetadataPanel : HammerComponent, TagSuggesting { /** * Search entries by name or alias for the manual "add reference" affordance. - * Case-insensitive substring match, restricted to [types]. Already-confirmed + * Case-insensitive substring match across all entry types. Already-confirmed * entries are excluded; dismissed entries are included with [AddSuggestion.isDismissed] * flagged so the UI can hint that picking will un-dismiss. * - * Returns up to [maxResults] entries sorted by name. [types] is applied before - * the cap, so a caller showing one group at a time gets a full page of that group. + * Returns up to [maxResults] entries sorted by name. */ - fun searchEntriesForAdd( - query: String, - types: Set = EntryType.entries.toSet(), - maxResults: Int = 20, - ): List + fun searchEntriesForAdd(query: String, maxResults: Int = 20): List /** - * Adds one or more tags from a free-form space-separated string. Input is normalized by - * `parseTagInput`; invalid pieces are dropped. Tags already on the scene are silently no-ops. + * Adds one or more tags from a free-form space-separated string. Input is + * normalized (trim, strip `#`, regex `[\w-]+`); invalid pieces are dropped. + * Tags already on the scene are silently no-ops. */ fun addTags(input: String) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanelComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanelComponent.kt index 58dc14624..a633dc89e 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanelComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/sceneeditor/scenemetadata/SceneMetadataPanelComponent.kt @@ -7,14 +7,12 @@ import com.arkivanov.decompose.value.getAndUpdate import com.darkrockstudios.apps.hammer.common.components.ProjectComponentBase import com.darkrockstudios.apps.hammer.common.data.SceneBuffer import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.UpdateSource +import com.darkrockstudios.apps.hammer.common.data.SceneSummary import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaService import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType -import com.darkrockstudios.apps.hammer.common.data.projectGet import com.darkrockstudios.apps.hammer.common.data.projectInject -import com.darkrockstudios.apps.hammer.base.markdown.countWords +import com.darkrockstudios.apps.hammer.common.data.projectstatistics.countWords import com.darkrockstudios.apps.hammer.common.data.references.ScrubInvalidReferencesUseCase import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata @@ -31,10 +29,8 @@ import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.filter import kotlinx.coroutines.launch import kotlinx.coroutines.withContext -import okio.IOException import org.koin.core.component.inject import org.koin.core.qualifier.named -import kotlin.concurrent.Volatile import kotlin.time.Duration.Companion.milliseconds class SceneMetadataPanelComponent( @@ -46,13 +42,9 @@ class SceneMetadataPanelComponent( SceneMetadataPanel { private val appScope: CoroutineScope by inject(named(APP_SCOPE)) - - // Resolved eagerly because onDestroy uses them, and on project close the project scope is - // closed before this component is destroyed: a lazy first-resolve there would crash. - private val sceneEditor: SceneEditorService = projectGet() - private val scrubInvalidReferences: ScrubInvalidReferencesUseCase = projectGet() - + private val sceneEditor: SceneEditorService by projectInject() private val encyclopediaService: EncyclopediaService by projectInject() + private val scrubInvalidReferences: ScrubInvalidReferencesUseCase by projectInject() private val searchableEntries = MutableStateFlow>(emptyList()) @@ -66,15 +58,6 @@ class SceneMetadataPanelComponent( override val state: Value = _state private var bufferUpdateSubscription: Job? = null - private var metadataLoaded = false - - // True while an outline/notes edit is waiting on the debounced store. - @Volatile - private var unsavedTextEdits = false - - // True while any local change is waiting on the debounced store. - @Volatile - private var storePending = false private val _metadataUpdateFlow = MutableSharedFlow( extraBufferCapacity = 1, @@ -97,6 +80,8 @@ class SceneMetadataPanelComponent( loadSceneData() loadMetadataData() + + sceneEditor.subscribeToSceneUpdates(scope, ::onSceneTreeUpdate) } scope.launch { @@ -115,18 +100,15 @@ class SceneMetadataPanelComponent( private fun subscribeToMetadataUpdates() { scope.launch { sceneEditor.metadataUpdateFlow - .filter { it.sceneId == originalSceneItem.id } - .collect { update -> - val external = update.metadata + .filter { (sceneId, _) -> sceneId == originalSceneItem.id } + .collect { (_, external) -> val current = state.value.metadata // Keep the user-editable text fields local; let everything else (refs, tags, // future-added fields) take the external write. Listing the local-owned fields // is the more stable invariant when SceneMetadata gains new fields. - // A synced write also replaces outline/notes, unless a local edit is unsaved. - val keepLocalText = update.source != UpdateSource.Sync || unsavedTextEdits val merged = external.copy( - outline = if (keepLocalText) current.outline else external.outline, - notes = if (keepLocalText) current.notes else external.notes, + outline = current.outline, + notes = current.notes, currentDraftName = current.currentDraftName, ) if (merged == current) return@collect @@ -134,12 +116,9 @@ class SceneMetadataPanelComponent( _state.getAndUpdate { it.copy(metadata = merged) } } // Re-emit so a pending debounced write picks up the merged state instead of - // the stale value it had queued. Storage already holds an unchanged merge. - if (storePending || merged != external) { - storePending = true - if (_metadataUpdateFlow.tryEmit(merged).not()) { - Napier.w { "Failed to re-emit merged metadata after external update" } - } + // the stale value it had queued. + if (_metadataUpdateFlow.tryEmit(merged).not()) { + Napier.w { "Failed to re-emit merged metadata after external update" } } refreshReferences() } @@ -156,8 +135,7 @@ class SceneMetadataPanelComponent( } } - override fun onSceneItemChanged(sceneItem: SceneItem) { - _state.getAndUpdate { it.copy(sceneItem = sceneItem) } + private fun onSceneTreeUpdate(sceneSummary: SceneSummary) { scope.launch { loadSceneData() } @@ -165,7 +143,6 @@ class SceneMetadataPanelComponent( private suspend fun loadMetadataData() { val metadata = sceneEditor.loadSceneMetadata(originalSceneItem.id) - metadataLoaded = true _state.getAndUpdate { it.copy( metadata = metadata, @@ -221,17 +198,7 @@ class SceneMetadataPanelComponent( metadataStoreJob = scope.launch { metadataStoreFlow.debounceUntilQuiescent(STORE_COOL_DOWN).collect { metadata -> // Self-healing fail-safe: drop reference IDs whose entry no longer exists - try { - sceneEditor.storeMetadata(scrubInvalidReferences(metadata), originalSceneItem.id) - } catch (e: IOException) { - Napier.e("Failed to store metadata for scene ${originalSceneItem.id}", e) - return@collect - } - val current = state.value.metadata - if (current.outline == metadata.outline && current.notes == metadata.notes) { - unsavedTextEdits = false - } - if (current == metadata) storePending = false + sceneEditor.storeMetadata(scrubInvalidReferences(metadata), originalSceneItem.id) } } } @@ -254,8 +221,6 @@ class SceneMetadataPanelComponent( } override fun updateOutline(text: String) { - unsavedTextEdits = true - storePending = true _state.getAndUpdate { val updated = it.metadata.copy(outline = text) if (_metadataUpdateFlow.tryEmit(updated).not()) { @@ -268,8 +233,6 @@ class SceneMetadataPanelComponent( } override fun updateNotes(text: String) { - unsavedTextEdits = true - storePending = true _state.getAndUpdate { val updated = it.metadata.copy(notes = text) if (_metadataUpdateFlow.tryEmit(updated).not()) { @@ -282,7 +245,6 @@ class SceneMetadataPanelComponent( } override fun updateDraftName(text: String) { - storePending = true _state.getAndUpdate { val updated = it.metadata.copy(currentDraftName = text) if (_metadataUpdateFlow.tryEmit(updated).not()) { @@ -309,11 +271,7 @@ class SceneMetadataPanelComponent( } } - override fun searchEntriesForAdd( - query: String, - types: Set, - maxResults: Int, - ): List { + override fun searchEntriesForAdd(query: String, maxResults: Int): List { val metadata = state.value.metadata return filterEntriesForAdd( query = query, @@ -321,7 +279,6 @@ class SceneMetadataPanelComponent( confirmedIds = metadata.confirmedReferences, dismissedIds = metadata.dismissedReferences, maxResults = maxResults, - types = types, ) } @@ -356,7 +313,6 @@ class SceneMetadataPanelComponent( } private fun mutateMetadata(transform: (SceneMetadata) -> SceneMetadata) { - storePending = true _state.getAndUpdate { val updated = transform(it.metadata) if (_metadataUpdateFlow.tryEmit(updated).not()) { @@ -372,18 +328,10 @@ class SceneMetadataPanelComponent( bufferUpdateSubscription?.cancel() bufferUpdateSubscription = null - // If the load never completed, state still holds the default empty metadata; - // flushing it would wipe the scene's stored metadata. - if (metadataLoaded.not()) return - - // The scrub does filesystem walks, so it runs off the lifecycle thread. - val metadata = state.value.metadata + val scrubbed = scrubInvalidReferences(state.value.metadata) + val editor = sceneEditor appScope.launch { - try { - sceneEditor.storeMetadata(scrubInvalidReferences(metadata), originalSceneItem.id) - } catch (e: IOException) { - Napier.e("Failed to flush metadata for scene ${originalSceneItem.id}", e) - } + editor.storeMetadata(scrubbed, originalSceneItem.id) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneList.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneList.kt index 4e33b5749..747b57996 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneList.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneList.kt @@ -19,7 +19,6 @@ interface SceneList { fun onSceneListUpdate(scenes: SceneSummary) fun onSceneBufferUpdate(sceneBuffer: SceneBuffer) fun showOutlineOverview() - fun showReaderMode() suspend fun archiveScene(scene: SceneItem) suspend fun unarchiveScene(scene: SceneItem) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneListComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneListComponent.kt index e094dbe2d..022bfc3e8 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneListComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/storyeditor/scenelist/SceneListComponent.kt @@ -18,9 +18,7 @@ class SceneListComponent( projectDef: ProjectDef, selectedSceneItem: SharedFlow, private val sceneSelected: (sceneDef: SceneItem) -> Unit, - private val openSceneEditor: (sceneDef: SceneItem) -> Unit, private val showOutlineOverviewDialog: () -> Unit, - private val showReader: () -> Unit, ) : ProjectComponentBase(projectDef, componentContext), SceneList { private val projectEditor: SceneEditorService by projectInject() @@ -78,7 +76,7 @@ class SceneListComponent( val newSceneItem = projectEditor.createScene(foundParent, sceneName) if (newSceneItem != null) { Napier.i("Scene created: $sceneName") - openSceneEditor(newSceneItem) + sceneSelected(newSceneItem) } else { Napier.w("Failed to create Scene: $sceneName") } @@ -155,10 +153,6 @@ class SceneListComponent( showOutlineOverviewDialog() } - override fun showReaderMode() { - showReader() - } - override suspend fun archiveScene(scene: SceneItem) { if (projectEditor.archiveScene(scene)) { Napier.i("Scene archived: ${scene.name}") @@ -171,7 +165,7 @@ class SceneListComponent( val unarchived = projectEditor.unarchiveScene(scene) if (unarchived != null) { Napier.i("Scene unarchived: ${unarchived.name}") - openSceneEditor(unarchived) + sceneSelected(unarchived) dismissArchivedDialog() } else { Napier.w("Failed to unarchive scene: ${scene.name}") diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEvent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEvent.kt index 1807c6ce5..8f0b80e33 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEvent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEvent.kt @@ -24,6 +24,5 @@ interface CreateTimeLineEvent : TagSuggesting { data class State( val projectDef: ProjectDef, val confirmDiscard: Boolean = false, - val spellCheckAllowed: Boolean = true, ) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEventComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEventComponent.kt index 8e579e87c..092730718 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEventComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/CreateTimeLineEventComponent.kt @@ -44,10 +44,6 @@ class CreateTimeLineEventComponent( contentText.subscribe(lifecycle) { backButtonHandler.isEnabled = it.isNotBlank() } - - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } } override fun onContentChanged(newText: String) { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/TimeLineComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/TimeLineComponent.kt index d15237085..1c51047c5 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/TimeLineComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/TimeLineComponent.kt @@ -115,24 +115,19 @@ class TimeLineComponent( } override fun shouldConfirmClose(): Set { - val unsaved = stack.value.items.any { isUnsaved(it.instance) } - return if (unsaved) setOf(CloseConfirm.Timeline) else emptySet() - } + val unsaved = when (val destination = stack.value.active.instance) { + is TimeLine.Destination.CreateEventDestination -> true + is TimeLine.Destination.ViewEventDestination -> { + destination.component.isEditingAndDirty() + } - private fun isUnsaved(destination: TimeLine.Destination) = when (destination) { - is TimeLine.Destination.CreateEventDestination -> true - is TimeLine.Destination.ViewEventDestination -> destination.component.isEditingAndDirty() - else -> false - } - - override fun discardUnsaved(item: CloseConfirm) { - if (item != CloseConfirm.Timeline) return - stack.value.items.forEach { child -> - val view = child.instance as? TimeLine.Destination.ViewEventDestination ?: return@forEach - if (view.component.state.value.isEditing) view.component.discardEdit() + else -> false } - if (stack.value.active.instance is TimeLine.Destination.CreateEventDestination) { - navigation.pop() + + return if (unsaved) { + setOf(CloseConfirm.Timeline) + } else { + emptySet() } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEvent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEvent.kt index c993e1d20..8eb67ef73 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEvent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEvent.kt @@ -29,8 +29,7 @@ interface ViewTimeLineEvent : TagSuggesting { val confirmDelete: Boolean = false, val confirmClose: Boolean = false, val confirmDiscard: Boolean = false, - val isEditing: Boolean = false, - val spellCheckAllowed: Boolean = true, + val isEditing: Boolean = false ) val dateText: Value diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEventComponent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEventComponent.kt index add08bc73..84f91c954 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEventComponent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/components/timeline/ViewTimeLineEventComponent.kt @@ -81,10 +81,6 @@ class ViewTimeLineEventComponent( loadInitialEvent() watchTimeLine() - - watchSpellCheckAllowed { allowed -> - _state.getAndUpdate { it.copy(spellCheckAllowed = allowed) } - } } private fun watchTimeLine() { @@ -93,18 +89,12 @@ class ViewTimeLineEventComponent( withContext(mainDispatcher) { val updatedEvent = timeLine.events.find { it.id == eventId } if (updatedEvent != state.value.event) { - val keepDraft = isEditingAndDirty() _state.getAndUpdate { it.copy( event = updatedEvent, - tags = if (keepDraft) it.tags else (updatedEvent?.tags ?: emptySet()), + tags = if (it.isEditing) it.tags else (updatedEvent?.tags ?: emptySet()), ) } - // A dirty edit keeps its draft; otherwise follow the stored event. - if (!keepDraft && updatedEvent != null) { - _contentText.update { updatedEvent.content } - _dateText.update { updatedEvent.date ?: "" } - } } } } @@ -244,7 +234,7 @@ class ViewTimeLineEventComponent( // Baseline not loaded yet (e.g. restored mid-edit): assume dirty so we don't silently discard. val event = state.value.event ?: return true return event.content != contentText.value || - (event.date ?: "") != dateText.value || + event.date != dateText.value || event.tags != state.value.tags } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExampleProjectRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExampleProjectRepository.kt index 0a4d305b0..d1e6e5e8c 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExampleProjectRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExampleProjectRepository.kt @@ -1,10 +1,12 @@ package com.darkrockstudios.apps.hammer.common.data +import com.darkrockstudios.apps.hammer.base.http.writeToml import com.darkrockstudios.apps.hammer.base.http.writingactivity.DeviceLog import com.darkrockstudios.apps.hammer.base.http.writingactivity.WritingSession import com.darkrockstudios.apps.hammer.common.data.ExampleProjectRepository.Companion.EXAMPLE_DAYS import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.writingactivity.writeDeviceLog +import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource +import com.darkrockstudios.apps.hammer.common.data.writingactivity.WritingActivityDatasource import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectDefaultDispatcher import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectMainDispatcher import io.github.aakira.napier.Napier @@ -38,13 +40,6 @@ abstract class ExampleProjectRepository( fun shouldInstallFirstTime(): Boolean = !globalSettingsStore.globalSettings.nux.exampleProjectCreated - /** - * The NUX flag alone is not enough (it is never cleared when the example is deleted or renamed), - * and the name alone is not enough (a user may name their own project this). Both together are. - */ - fun isExampleProject(projectDef: ProjectDef): Boolean = - projectDef.name == PROJECT_NAME && globalSettingsStore.globalSettings.nux.exampleProjectCreated - fun install() { removeExampleProject() platformInstall() @@ -70,10 +65,13 @@ abstract class ExampleProjectRepository( @Suppress("TooGenericExceptionCaught") // Best-effort fabrication; any failure is logged private fun fabricateExampleActivity() { + val activityDir = projectsDir() / PROJECT_NAME / + SceneDatasource.SCENE_DIRECTORY / WritingActivityDatasource.ACTIVITY_DIRECTORY try { + fileSystem.createDirectories(activityDir) val sessions = generateExampleSessions(clock.now(), TimeZone.currentSystemDefault()) val log = DeviceLog(deviceLabel = FABRICATED_DEVICE_LABEL, sessions = sessions) - writeDeviceLog(projectsDir() / PROJECT_NAME, FABRICATED_DEVICE_ID, log, fileSystem, toml) + fileSystem.writeToml(activityDir / "$FABRICATED_DEVICE_ID.toml", toml, log) } catch (e: Exception) { Napier.e("Failed to fabricate example writing activity", e) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportOptions.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportOptions.kt index 3b38a92b6..d302e8ba3 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportOptions.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportOptions.kt @@ -5,29 +5,8 @@ import kotlinx.serialization.Serializable @Serializable enum class ExportFormat { Markdown, Epub, Pdf, Docx, Rtf } -/** Body typefaces offered for exports; the reader's own installed copy of [faceName] is what renders. */ -@Serializable -enum class ExportFont(val faceName: String, val cssFamily: String) { - Georgia("Georgia", "Georgia, \"Times New Roman\", serif"), - TimesNewRoman("Times New Roman", "\"Times New Roman\", Times, serif"), - Garamond("Garamond", "Garamond, \"EB Garamond\", Georgia, serif"), - Arial("Arial", "Arial, Helvetica, sans-serif"), - Verdana("Verdana", "Verdana, Geneva, sans-serif"), - CourierNew("Courier New", "\"Courier New\", Courier, monospace"), -} - @Serializable data class ExportOptions( val treatTopLevelAsChapters: Boolean = true, val format: ExportFormat = ExportFormat.Epub, - /** Scene ids the export is limited to; null exports the entire story. */ - val sceneIds: Set? = null, - /** Prefixes each chapter title with its position ("1. Title"). */ - val numberChapters: Boolean = false, - val font: ExportFont = ExportFont.Georgia, - /** - * Keeps the blank lines the author typed between paragraphs. Off drops a lone blank line, leaving the - * indent as the separator, while a run of two or more still leaves one break. - */ - val keepBlankLines: Boolean = true, ) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportableScene.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportableScene.kt deleted file mode 100644 index 924b2156c..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ExportableScene.kt +++ /dev/null @@ -1,27 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data - -import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree -import kotlinx.serialization.Serializable - -/** One row of the flattened scene tree shown in the export dialog. */ -@Serializable -data class ExportableScene( - val id: Int, - val name: String, - val isGroup: Boolean, - /** 0 for top-level nodes. */ - val depth: Int, -) - -/** Flattens [tree] in render order (preorder depth-first), excluding the root. */ -fun exportableScenes(tree: ImmutableTree): List = - tree.root - .filter { it.value.type != SceneItem.Type.Root } - .map { node -> - ExportableScene( - id = node.value.id, - name = node.value.name, - isGroup = node.value.type.isCollection, - depth = node.depth - 1, - ) - } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ImportOptions.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ImportOptions.kt index 5a967d5cf..6c645b561 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ImportOptions.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ImportOptions.kt @@ -5,22 +5,20 @@ import kotlinx.serialization.Serializable @Serializable enum class ImportFormat { Markdown, Rtf } -/** How a Markdown document is divided into scenes. */ @Serializable -enum class MarkdownSplitStrategy { Auto, H1, H2, Pattern } +enum class ChapterHeadingLevel { Auto, H1, H2 } /** How an RTF document is divided into scenes. */ @Serializable enum class RtfSplitStrategy { Formatting, Pattern, SingleScene } -const val DEFAULT_CHAPTER_PATTERN = "(?i)^(chapter|part|prologue|epilogue)\\b" +const val DEFAULT_RTF_CHAPTER_PATTERN = "(?i)^(chapter|part|prologue|epilogue)\\b" @Serializable data class ImportOptions( val format: ImportFormat = ImportFormat.Markdown, - val markdownSplitStrategy: MarkdownSplitStrategy = MarkdownSplitStrategy.Auto, + val chapterHeadingLevel: ChapterHeadingLevel = ChapterHeadingLevel.Auto, val createChapterGroups: Boolean = false, - val markdownChapterPattern: String = DEFAULT_CHAPTER_PATTERN, val rtfSplitStrategy: RtfSplitStrategy = RtfSplitStrategy.Formatting, - val rtfChapterPattern: String = DEFAULT_CHAPTER_PATTERN, + val rtfChapterPattern: String = DEFAULT_RTF_CHAPTER_PATTERN, ) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectEditorScopeUtils.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectEditorScopeUtils.kt index 5dd41d9a9..6f5b46673 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectEditorScopeUtils.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectEditorScopeUtils.kt @@ -3,13 +3,7 @@ package com.darkrockstudios.apps.hammer.common.data import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryService import io.github.aakira.napier.Napier -import kotlinx.atomicfu.atomic -import kotlinx.atomicfu.getAndUpdate -import kotlinx.atomicfu.locks.reentrantLock -import kotlinx.atomicfu.locks.withLock -import kotlinx.atomicfu.update import org.koin.core.Koin import org.koin.core.component.KoinComponent import org.koin.core.component.getScopeId @@ -19,56 +13,14 @@ import org.koin.core.scope.Scope import org.koin.core.scope.ScopeID import org.koin.mp.KoinPlatform.getKoin -private val temporaryScopeLock = reentrantLock() -private val temporaryScopeUsers = mutableMapOf() -private val temporaryScopesToClose = mutableSetOf() - -// Scopes an editor has opened. A temporary task that created the scope must not close it -// once an editor owns it, and an editor opening an existing temporary scope must still -// start the editor-only services. -private val editorScopes = atomic(emptySet()) - -/** - * Opens a project scope for [block], closing it afterwards only if this call is what brought it - * into existence, nothing else is still using it, and no editor has since adopted it. - * - * Thar be dragons: concurrent temporary tasks on one project must be counted, not each decide for - * themselves. Two overlapping tasks both see a scope they did not create, and whichever finishes - * first would otherwise close it out from under the other, which then fails with - * `ClosedScopeException` partway through. A background sync and a capture racing on the same - * project is the ordinary case, not a rare one. - */ suspend fun KoinComponent.temporaryProjectTask(projectDef: ProjectDef, block: suspend (projectScope: Scope) -> Unit) { - val scopeId = ProjectDefScope(projectDef).getScopeId() + val hadToCreate = getKoin().getScopeOrNull(ProjectDefScope(projectDef).getScopeId()) == null + val projScope = openProjectScope(projectDef) - temporaryScopeLock.withLock { - val users = temporaryScopeUsers[scopeId] ?: 0 - // Only the first temporary user can be the one creating the scope. A scope that was already - // open for real belongs to whoever opened it and is never closed here. - if (users == 0 && getKoin().getScopeOrNull(scopeId) == null) { - temporaryScopesToClose += scopeId - } - temporaryScopeUsers[scopeId] = users + 1 - } + block(projScope) - val projScope = openProjectScope(projectDef, temporary = true) - - try { - block(projScope) - } finally { - // Closed while still holding the lock: a task arriving between the decision and the close - // would otherwise see the scope still open, adopt it, and have it closed under it. - temporaryScopeLock.withLock { - val remaining = (temporaryScopeUsers[scopeId] ?: 1) - 1 - if (remaining > 0) { - temporaryScopeUsers[scopeId] = remaining - } else { - temporaryScopeUsers.remove(scopeId) - if (temporaryScopesToClose.remove(scopeId) && scopeId !in editorScopes.value) { - closeProjectScope(projScope, projectDef) - } - } - } + if (hadToCreate) { + closeProjectScope(projScope, projectDef) } } @@ -82,23 +34,20 @@ fun createProjectScope(projectDef: ProjectDef): Scope { return projScope } -suspend fun openProjectScope(projectDef: ProjectDef, temporary: Boolean = false): Scope { +suspend fun openProjectScope(projectDef: ProjectDef): Scope { val defScope = ProjectDefScope(projectDef) - val scopeId = defScope.getScopeId() - val needsInit = getKoin().getScopeOrNull(scopeId) == null - val projScope = getKoin().getOrCreateScope(scopeId, source = defScope) + val needsInit = getKoin().getScopeOrNull(ProjectDefScope(projectDef).getScopeId()) == null + val projScope = getKoin().getOrCreateScope(defScope.getScopeId(), source = defScope) if (needsInit) { - initializeProjectScope(projectDef, temporary) - } else if (!temporary && markOpenedForEditing(scopeId)) { - initializeEditorServices(projScope) + initializeProjectScope(projectDef) } return projScope } -suspend fun initializeProjectScope(projectDef: ProjectDef, temporary: Boolean = false) { +suspend fun initializeProjectScope(projectDef: ProjectDef) { val defScope = ProjectDefScope(projectDef) getKoin().getScopeOrNull(defScope.getScopeId())?.let { projScope -> // Creates the service (activating its autosave side-effect subscription from project open) @@ -108,32 +57,15 @@ suspend fun initializeProjectScope(projectDef: ProjectDef, temporary: Boolean = val timeLineRepository: TimeLineRepository = projScope.get { parametersOf(projectDef) } timeLineRepository.initialize() - - // Skipped for temporary scopes (background sync, import): loading session words - // there only churns the shared checker while the sync rewrites entries. - if (!temporary && markOpenedForEditing(defScope.getScopeId())) { - initializeEditorServices(projScope) - } } ?: throw IllegalStateException("No scope found for $projectDef") } -private fun initializeEditorServices(projScope: Scope) { - projScope.get().initialize() -} - -/** Returns true the first time [scopeId] is marked. */ -private fun markOpenedForEditing(scopeId: ScopeID): Boolean { - val before = editorScopes.getAndUpdate { it + scopeId } - return scopeId !in before -} - fun closeProjectScope(projectScope: Scope, projectDef: ProjectDef) { Napier.d { "closeProjectScope: ${projectDef.name}" } - editorScopes.update { it - ProjectDefScope(projectDef).getScopeId() } projectScope.close() } private inline fun Koin.getOrCreateScope(scopeId: ScopeID, source: Any? = null): Scope { val qualifier = TypeQualifier(T::class) return getScopeOrNull(scopeId) ?: createScope(scopeId, qualifier, source) -} +} \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectScoped.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectScoped.kt index a319abdae..702bcf609 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectScoped.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ProjectScoped.kt @@ -22,16 +22,4 @@ inline fun ProjectScoped.projectInject( ): Lazy = lazy(mode) { projectScope.get(qualifier, parameters) - } - -/** - * Resolves from the Project Scope immediately, at construction time. Use instead of - * [projectInject] for any dependency a component touches during teardown (onStop/onDestroy): - * on project close the scope is closed before child components are destroyed, so a first lazy - * resolution there either throws ClosedScopeException (scope handle already materialized) or - * silently resolves against a fresh replacement scope that never ran project initialization. - */ -inline fun ProjectScoped.projectGet( - qualifier: Qualifier? = null, - noinline parameters: ParametersDefinition? = null -): T = projectScope.get(qualifier, parameters) \ No newline at end of file + } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/account/AccountUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/account/AccountUseCase.kt index 448727676..ab019896e 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/account/AccountUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/account/AccountUseCase.kt @@ -3,7 +3,6 @@ package com.darkrockstudios.apps.hammer.common.data.account import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge import com.darkrockstudios.apps.hammer.base.http.Token -import com.darkrockstudios.apps.hammer.common.data.CResult import com.darkrockstudios.apps.hammer.common.data.Msg import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings @@ -29,11 +28,9 @@ class AccountUseCase( password: String, create: Boolean, acceptedTosVersion: String? = null, - ssl: Boolean = true, ): ServerSetupResult { val installId = globalSettingsStore.ensureInstallId() val newSettings = ServerSettings( - ssl = ssl, userId = -1, url = url, email = email, @@ -89,46 +86,6 @@ class AccountUseCase( } } - /** - * Mints a session for another of this user's installs. The settings returned belong to that - * install, so this install's credentials and stored settings are left untouched. - */ - suspend fun pairInstall(newInstallId: String): CResult { - val current = globalSettingsStore.serverSettings - if (current == null || current.userId < 0) { - return CResult.failure(error = "No signed-in server to pair with") - } - - val result = accountApi.pairInstall(newInstallId) - return if (result.isSuccess) { - val token = result.getOrThrow() - CResult.success( - current.copy( - userId = token.userId, - bearerToken = token.auth, - refreshToken = token.refresh, - ) - ) - } else { - val exception = result.exceptionOrNull() - val displayMessage = (exception as? HttpFailureException)?.error?.displayMessage?.toMsg() - ?: strRes.get(Res.string.server_setup_error_unknown).toMsg() - CResult.failure(error = "Pairing failed", displayMessage = displayMessage, exception = exception) - } - } - - /** Adopts a session another install minted for this one through [pairInstall]. */ - fun applyPairedSettings(settings: ServerSettings): CResult { - val bearerToken = settings.bearerToken - if (bearerToken.isNullOrBlank() || settings.userId < 0) { - return CResult.failure(error = "Paired settings carry no session") - } - - httpClient.updateCredentials(BearerTokens(accessToken = bearerToken, refreshToken = settings.refreshToken)) - globalSettingsStore.updateServerSettings(settings) - return CResult.success() - } - suspend fun testAuth(): Boolean { return accountApi.testAuth().isSuccess } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/appupdate/AppUpdater.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/appupdate/AppUpdater.kt deleted file mode 100644 index 3d7c551ac..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/appupdate/AppUpdater.kt +++ /dev/null @@ -1,59 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.appupdate - -import kotlinx.coroutines.flow.MutableStateFlow -import kotlinx.coroutines.flow.StateFlow - -/** - * Self-update for the builds that may do it: desktop installs from a GitHub release or the - * AppImage. Every other build binds [NoOpAppUpdater] and never leaves - * [AppUpdateState.Unsupported], so store builds carry no update UI. - */ -interface AppUpdater { - val state: StateFlow - - /** Looks for a newer release now, regardless of the automatic schedule. */ - fun checkNow() - - /** Downloads the available release and hands it to the installer, which quits the app. */ - fun update() - - /** Hides the banner for the available version until a newer one appears. */ - fun dismiss() -} - -sealed interface AppUpdateState { - /** This build cannot update itself; nothing update-related is shown. */ - data object Unsupported : AppUpdateState - - /** No check has completed yet. */ - data object Idle : AppUpdateState - - data object Checking : AppUpdateState - - /** The last check found nothing newer. */ - data object UpToDate : AppUpdateState - - /** - * A newer release exists. [installable] is false when this install can only be told about it - * and sent to the release page; [dismissed] hides the banner but not the About screen row. - */ - data class Available( - val version: String, - val installable: Boolean, - val dismissed: Boolean = false, - ) : AppUpdateState - - data class Downloading(val version: String, val fraction: Float) : AppUpdateState - - /** The installer has been handed the file; the app is about to quit. */ - data class Installing(val version: String) : AppUpdateState - - data class Failed(val version: String, val reason: String) : AppUpdateState -} - -object NoOpAppUpdater : AppUpdater { - override val state: StateFlow = MutableStateFlow(AppUpdateState.Unsupported) - override fun checkNow() = Unit - override fun update() = Unit - override fun dismiss() = Unit -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/Changelog.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/Changelog.kt deleted file mode 100644 index 15ee2c7a7..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/Changelog.kt +++ /dev/null @@ -1,35 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -import com.darkrockstudios.apps.hammer.base.BuildMetadata - -data class Changelog( - val version: String, - val date: String?, - val notes: String, -) - -private val HEADER = Regex("""^##\s*\[([^]]+)]\s*(?:-\s*(.+))?$""") - -/** - * Parses one `## [version] - date` CHANGELOG.md entry. A file without that header is still - * usable — it becomes notes for the running version — so a hand-edited resource never - * silently shows nothing. - */ -fun parseChangelog(text: String): Changelog? { - if (text.isBlank()) return null - - val lines = text.trimStart().lines() - val match = HEADER.matchEntire(lines.first().trim()) - ?: return Changelog( - version = BuildMetadata.APP_VERSION, - date = null, - notes = text.trim(), - ) - - val notes = lines.drop(1).joinToString("\n").trim() - return Changelog( - version = match.groupValues[1].trim(), - date = match.groupValues[2].trim().ifEmpty { null }, - notes = notes, - ) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogDatasource.kt deleted file mode 100644 index f7e21f2b8..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogDatasource.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -interface ChangelogDatasource { - suspend fun loadChangelog(): Changelog? -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogRepository.kt deleted file mode 100644 index 701f1c459..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ChangelogRepository.kt +++ /dev/null @@ -1,37 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import kotlinx.atomicfu.locks.reentrantLock -import kotlinx.atomicfu.locks.withLock - -/** - * The baked changelog plus whether the user has seen it. Loaded once per session; the - * resource can't change while the app runs. - */ -class ChangelogRepository( - private val datasource: ChangelogDatasource, - private val settingsStore: GlobalSettingsStore, -) { - private val lock = reentrantLock() - private var cached: Changelog? = null - - suspend fun getChangelog(): Changelog? { - if (!supportsInAppChangelog) return null - - lock.withLock { cached }?.let { return it } - - val changelog = datasource.loadChangelog() ?: return null - lock.withLock { cached = changelog } - return changelog - } - - suspend fun hasUnseenChangelog(): Boolean { - val changelog = getChangelog() ?: return false - return changelog.version != settingsStore.globalSettings.lastSeenChangelogVersion - } - - suspend fun markSeen() { - val version = getChangelog()?.version ?: return - settingsStore.updateSettings { it.copy(lastSeenChangelogVersion = version) } - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt deleted file mode 100644 index 1f4230d5d..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -/** - * Whether the in-app "What's New" dialog may be shown at all. - * - * False wherever Apple reviews the build. The baked changelog is the full release - * entry, so it names Android and other platforms, which draws guideline 2.3.10 - * rejections. - */ -expect val supportsInAppChangelog: Boolean diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ResourceChangelogDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ResourceChangelogDatasource.kt deleted file mode 100644 index b360558db..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/ResourceChangelogDatasource.kt +++ /dev/null @@ -1,24 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -import com.darkrockstudios.apps.hammer.Res -import io.github.aakira.napier.Napier -import org.jetbrains.compose.resources.ExperimentalResourceApi - -/** Reads the release notes baked in by `prepareForRelease`. No network, ever. */ -class ResourceChangelogDatasource : ChangelogDatasource { - - @OptIn(ExperimentalResourceApi::class) - @Suppress("TooGenericExceptionCaught") // A missing resource must not block app start - override suspend fun loadChangelog(): Changelog? { - return try { - parseChangelog(Res.readBytes(RESOURCE_PATH).decodeToString()) - } catch (e: Exception) { - Napier.w("Failed to read baked changelog", e) - null - } - } - - companion object { - private const val RESOURCE_PATH = "files/changelog.md" - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/DraftDefExt.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/DraftDefExt.kt index 2758e9675..4809b77a9 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/DraftDefExt.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/DraftDefExt.kt @@ -7,6 +7,6 @@ fun ApiProjectEntity.SceneDraftEntity.toDraftDef(): DraftDef { id = id, sceneId = sceneId, draftTimestamp = created, - draftName = name.trim() + draftName = name ) } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftRepository.kt index 12a33b03f..b67eae593 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftRepository.kt @@ -45,7 +45,7 @@ class SceneDraftRepository( id = newId, sceneId = sceneItem.id, draftTimestamp = newDraftTimestamp, - draftName = draftName.trim() + draftName = draftName ) val content: String = sceneContentRepository.getCurrentSceneContent(sceneItem) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftsDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftsDatasource.kt index 1cb70e1a7..f1dad9ebf 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftsDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/drafts/SceneDraftsDatasource.kt @@ -1,11 +1,8 @@ package com.darkrockstudios.apps.hammer.common.data.drafts import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidationResult -import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidator import com.darkrockstudios.apps.hammer.common.data.SceneContent import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource import com.darkrockstudios.apps.hammer.common.fileio.HPath import com.darkrockstudios.apps.hammer.common.fileio.okio.isWithin @@ -21,18 +18,11 @@ class SceneDraftsDatasource( private val fileSystem: FileSystem, private val sceneDatasource: SceneDatasource ) { - /** - * Where this draft lives on disk: the current `~`-delimited filename, or the pre-v3 - * `-`-delimited one when that is what is actually there. Falls back to the current format so - * callers writing a new file always produce it. - */ fun getDraftPath(draftDef: DraftDef): HPath { - val dir = getSceneDraftsDirectory(draftDef.sceneId).toOkioPath() - val current = dir / getFilename(draftDef) - if (fileSystem.exists(current)) return current.toHPath() - - val legacy = dir / getLegacyFilename(draftDef) - return (if (fileSystem.exists(legacy)) legacy else current).toHPath() + val dir = getSceneDraftsDirectory(draftDef.sceneId) + val filename = getFilename(draftDef) + val path = dir.toOkioPath() / filename + return path.toHPath() } fun getSceneIdsThatHaveDrafts(): List { @@ -223,49 +213,27 @@ class SceneDraftsDatasource( } private fun getFilename(draftDef: DraftDef): String { - val name = ProjectsRepository.encodeForFilename(draftDef.draftName) - return "${draftDef.sceneId}~${draftDef.id}~$name~${draftDef.draftTimestamp.epochSeconds}.md" - } - - private fun getLegacyFilename(draftDef: DraftDef): String { - val timestamp = draftDef.draftTimestamp.epochSeconds - return "${draftDef.sceneId}-${draftDef.id}-${draftDef.draftName}-$timestamp.md" + return "${draftDef.sceneId}-${draftDef.id}-${draftDef.draftName}-${draftDef.draftTimestamp.epochSeconds}.md" } companion object { const val DRAFTS_DIR = ".drafts" + val DRAFT_FILENAME_PATTERN = Regex("""(\d+)-(\d+)-([\da-zA-Z _']+)-(\d+)\.md""") + val DRAFT_NAME_PATTERN = Regex("""[\da-zA-Z _']+""") + val MAX_DRAFT_NAME_LENGTH = 128 - // Draft format: sceneId~draftId~name~timestamp.md (delimiter changed from `-` to `~` in - // data v3). The name group accepts any char except path separators and the delimiter; - // encoded lookalikes pass through naturally. - val DRAFT_FILENAME_PATTERN = Regex("""(\d+)~(\d+)~([^~/\\]+)~(\d+)\.md""") + fun validDraftName(name: String): Boolean { + return name.isNotBlank() && name.length <= MAX_DRAFT_NAME_LENGTH && DRAFT_NAME_PATTERN.matches(name) + } - // Pre-v3 pattern. Kept for read compatibility (e.g. fixtures, projects mid-migration). - // Old name set was the restricted `[\da-zA-Z _']` so `-` is unambiguously a delimiter. - val LEGACY_DRAFT_FILENAME_PATTERN = Regex("""(\d+)-(\d+)-([\da-zA-Z _']+)-(\d+)\.md""") - - /** - * Draft names are stored wrapped as `sceneId~draftId~name~timestamp`, so they never land - * on disk as a bare basename; only the character rules apply. Validates the trimmed name - * because that is what [DraftDef] stores. - */ - fun validDraftName(name: String): Boolean = - ProjectNameValidator.validate(name.trim(), usedAsRawFilename = false) == - ProjectNameValidationResult.VALID - - private fun matchDraftFileName(filename: String): MatchResult? = - DRAFT_FILENAME_PATTERN.matchEntire(filename) - ?: LEGACY_DRAFT_FILENAME_PATTERN.matchEntire(filename) - - fun validDraftFileName(filename: String): Boolean = matchDraftFileName(filename) != null + fun validDraftFileName(filename: String): Boolean = DRAFT_FILENAME_PATTERN.matches(filename) fun parseDraftFileName(filename: String): DraftDef? { - val matches = matchDraftFileName(filename) - return if (matches != null) { + val matches = DRAFT_FILENAME_PATTERN.matchEntire(filename) + return if (validDraftFileName(filename) && matches != null) { val sceneId = matches.groups[1]?.value?.toInt() val draftId = matches.groups[2]?.value?.toInt() val draftName = matches.groups[3]?.value - ?.let { ProjectsRepository.decodeFromFilename(it) } val draftTimestamp = matches.groups[4]?.value?.toLong() if (draftId == null) error("Failed to parsed draft ID from draft file name") diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaDatasource.kt index c1c3140e7..9792af6ad 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaDatasource.kt @@ -1,11 +1,11 @@ package com.darkrockstudios.apps.hammer.common.data.encyclopediarepository import com.darkrockstudios.apps.hammer.common.data.ProjectDef +import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource.Companion.ENTRY_FILENAME_PATTERN import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContainer import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContent import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.InvalidSceneFilename import com.darkrockstudios.apps.hammer.common.fileio.ExternalFileIo import com.darkrockstudios.apps.hammer.common.fileio.HPath @@ -33,24 +33,18 @@ class EncyclopediaDatasource( return getEncyclopediaDirectory(projectDef, fileSystem) } - fun getEntryPath(entryContent: EntryContent): HPath = - resolveEntryPath(entryContent.id, entryContent.type, entryContent.name).toHPath() + fun getEntryPath(entryContent: EntryContent): HPath { + val dir = getTypeDirectory(entryContent.type).toOkioPath() + val filename = getEntryFilename(entryContent) + val path = dir / filename + return path.toHPath() + } - fun getEntryPath(entryDef: EntryDef): HPath = - resolveEntryPath(entryDef.id, entryDef.type, entryDef.name).toHPath() - - /** - * Where this entry lives on disk: the current `~`-delimited filename, or the pre-v3 - * `-`-delimited one when that is what is actually there. Falls back to the current format so - * callers writing a new file always produce it. - */ - private fun resolveEntryPath(id: Int, type: EntryType, name: String): Path { - val dir = getTypeDirectory(type).toOkioPath() - val current = dir / getEntryFilename(id, type, name) - if (fileSystem.exists(current)) return current - - val legacy = dir / getLegacyEntryFilename(id, type, name) - return if (fileSystem.exists(legacy)) legacy else current + fun getEntryPath(entryDef: EntryDef): HPath { + val dir = getTypeDirectory(entryDef.type).toOkioPath() + val filename = getEntryFilename(entryDef) + val path = dir / filename + return path.toHPath() } fun getEntryPath(id: Int): HPath { @@ -82,34 +76,25 @@ class EncyclopediaDatasource( fun getEntryImagePath(entryDef: EntryDef, fileExtension: String): HPath { val dir = getTypeDirectory(entryDef.type).toOkioPath() - val existing = resolveEntryImagePath(entryDef, fileExtension) - val path = existing ?: dir / getEntryImageFilename(entryDef, fileExtension) + val filename = getEntryImageFilename(entryDef, fileExtension) + val path = dir / filename return path.toHPath() } - fun hasEntryImage(entryDef: EntryDef, fileExtension: String): Boolean = - resolveEntryImagePath(entryDef, fileExtension) != null + fun hasEntryImage(entryDef: EntryDef, fileExtension: String): Boolean { + val path = getEntryImagePath(entryDef, fileExtension).toOkioPath() + return fileSystem.exists(path) + } fun hasEntryImage(entryDef: EntryDef): Boolean = findEntryImagePath(entryDef) != null - /** - * Locates an entry's stored image of a specific extension, preferring the current filename - * format and falling back to the pre-v3 `-`-delimited one. - */ - private fun resolveEntryImagePath(entryDef: EntryDef, fileExtension: String): Path? { - val dir = getTypeDirectory(entryDef.type).toOkioPath() - return entryImagePrefixes(entryDef) - .map { prefix -> dir / "$prefix$fileExtension" } - .firstOrNull { fileSystem.exists(it) } - } - /** Locates an entry's stored image regardless of its file extension. */ fun findEntryImagePath(entryDef: EntryDef): HPath? { val dir = getTypeDirectory(entryDef.type).toOkioPath() - val prefixes = entryImagePrefixes(entryDef) + val prefix = "${entryDef.type.text}-${entryDef.id}-image." return fileSystem.list(dir) .firstOrNull { path -> - prefixes.any { path.name.startsWith(it) } && + path.name.startsWith(prefix) && path.name.substringAfterLast('.').lowercase() in IMAGE_EXTENSIONS } ?.toHPath() @@ -132,8 +117,12 @@ class EncyclopediaDatasource( } suspend fun hashEntryImage(entryDef: EntryDef, fileExtension: String): String? { - val path = resolveEntryImagePath(entryDef, fileExtension) ?: return null - return calculateFileMd5(fileSystem, path) + return if (hasEntryImage(entryDef, fileExtension)) { + val path = getEntryImagePath(entryDef, fileExtension).toOkioPath() + calculateFileMd5(fileSystem, path) + } else { + null + } } private fun calculateFileMd5(fileSystem: FileSystem, path: Path): String { @@ -216,8 +205,8 @@ class EncyclopediaDatasource( } fun loadEntryImage(entryDef: EntryDef, fileExtension: String): ByteArray { - val imagePath = getEntryImagePath(entryDef, fileExtension).toOkioPath() - fileSystem.read(imagePath) { + val imagePath = getEntryImagePath(entryDef, fileExtension) + fileSystem.read(imagePath.toOkioPath()) { return readByteArray() } } @@ -279,7 +268,7 @@ class EncyclopediaDatasource( } suspend fun deleteEntry(entryDef: EntryDef): Boolean { - val path = findEntryPath(entryDef.id)?.toOkioPath() ?: getEntryPath(entryDef).toOkioPath() + val path = getEntryPath(entryDef).toOkioPath() fileSystem.delete(path) findEntryImagePath(entryDef)?.let { imagePath -> @@ -294,8 +283,7 @@ class EncyclopediaDatasource( name: String, text: String, tags: Set, - aliases: List, - excludeFromDictionary: Boolean, + aliases: List = emptyList(), ): EntryContainer { val oldPath = getEntryPath(oldEntryDef.id).toOkioPath() fileSystem.delete(oldPath) @@ -307,7 +295,6 @@ class EncyclopediaDatasource( text = text.trim(), tags = tags, aliases = aliases, - excludeFromDictionary = excludeFromDictionary, ) val container = EntryContainer(entry) val entryToml = toml.encodeToString(container) @@ -322,16 +309,8 @@ class EncyclopediaDatasource( } companion object { - // Entry format: type~id~name.toml (delimiter changed from `-` to `~` in data v3). - // The name group accepts any char except path separators and the delimiter; encoded - // lookalikes pass through naturally. - val ENTRY_FILENAME_PATTERN = Regex("""([a-zA-Z]+)~(\d+)~([^~/\\]+)\.toml""") - - // Pre-v3 patterns. Kept for read compatibility (e.g. fixtures, projects mid-migration). - // Old name set was the restricted `[\d\p{L}+ _']` so `-` is unambiguously a delimiter. - val LEGACY_ENTRY_FILENAME_PATTERN = Regex("""([a-zA-Z]+)-(\d+)-([\d\p{L}+ _']+)\.toml""") - val LEGACY_ENTRY_IMAGE_FILENAME_PATTERN = Regex("""([a-zA-Z]+)-(\d+)-image\.([a-zA-Z0-9]+)""") - + val ENTRY_NAME_PATTERN = Regex("""([\d\p{L}+ _']+)""") + val ENTRY_FILENAME_PATTERN = Regex("""([a-zA-Z]+)-(\d+)-([\d\p{L}+ _']+)\.toml""") const val ENCYCLOPEDIA_DIRECTORY = "encyclopedia" fun getEntryFilename(entryDef: EntryDef): String = @@ -356,31 +335,15 @@ class EncyclopediaDatasource( ) private fun getEntryFilename(id: Int, type: EntryType, name: String): String { - return "${type.text}~$id~${ProjectsRepository.encodeForFilename(name)}.toml" - } - - private fun getEntryImageFilename(id: Int, type: EntryType, fileExtension: String): String { - return "${type.text}~$id~image.$fileExtension" - } - - private fun getLegacyEntryFilename(id: Int, type: EntryType, name: String): String { return "${type.text}-$id-$name.toml" } - /** Image filename prefixes an entry's image may carry on disk, newest format first. */ - private fun entryImagePrefixes(entryDef: EntryDef): List = listOf( - "${entryDef.type.text}~${entryDef.id}~image.", - "${entryDef.type.text}-${entryDef.id}-image.", - ) - - private fun matchEntryFilename(fileName: String): MatchResult? = - ENTRY_FILENAME_PATTERN.matchEntire(fileName) - ?: LEGACY_ENTRY_FILENAME_PATTERN.matchEntire(fileName) - - fun isEntryFilename(fileName: String): Boolean = matchEntryFilename(fileName) != null + private fun getEntryImageFilename(id: Int, type: EntryType, fileExtension: String): String { + return "${type.text}-$id-image.$fileExtension" + } fun getEntryIdFromFilename(fileName: String): Int { - val captures = matchEntryFilename(fileName) + val captures = ENTRY_FILENAME_PATTERN.matchEntire(fileName) ?: throw IllegalStateException("Entry filename was bad: $fileName") try { val entryId = captures.groupValues[2].toInt() @@ -393,12 +356,12 @@ class EncyclopediaDatasource( } fun getEntryDefFromFilename(fileName: String, projectDef: ProjectDef): EntryDef { - val captures = matchEntryFilename(fileName) + val captures = ENTRY_FILENAME_PATTERN.matchEntire(fileName) ?: throw IllegalStateException("Entry filename was bad: $fileName") try { val typeString = captures.groupValues[1] val entryId = captures.groupValues[2].toInt() - val entryName = ProjectsRepository.decodeFromFilename(captures.groupValues[3]) + val entryName = captures.groupValues[3] val type = EntryType.fromString(typeString) @@ -459,7 +422,7 @@ fun Sequence.filterEntryPathsOkio() = .filter { path -> !path.segments.any { part -> part.startsWith(".") } } fun Sequence.filterEntryPaths() = filter { - !it.name.startsWith(".") && EncyclopediaDatasource.isEntryFilename(it.name) + !it.name.startsWith(".") && ENTRY_FILENAME_PATTERN.matches(it.name) }.sortedBy { it.name } open class InvalidEntryFilename(message: String, fileName: String, cause: Throwable? = null) : diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaRepository.kt index 113e8de3d..b6d885bc5 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaRepository.kt @@ -1,10 +1,9 @@ package com.darkrockstudios.apps.hammer.common.data.encyclopediarepository import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidationResult -import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidator import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.ProjectScoped +import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource.Companion.ENTRY_NAME_PATTERN import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContainer import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContent import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef @@ -57,11 +56,6 @@ class EncyclopediaRepository( ) val entryContentChangedFlow: SharedFlow = _entryContentChangedFlow - private val _entryChangedFlow = MutableSharedFlow(extraBufferCapacity = 64) - - /** Emits the id of each entry that was created, updated or deleted. */ - val entryChangedFlow: SharedFlow = _entryChangedFlow - private suspend fun updateEntries(entries: List) { _entryListFlow.emit(entries) } @@ -86,7 +80,6 @@ class EncyclopediaRepository( text: String, tags: Set, aliases: List = emptyList(), - excludeFromDictionary: Boolean, ): EntryResult { val result = validateEntry(name, oldEntryDef.type, text, tags, aliases) if (result != EntryError.NONE) return EntryResult(result) @@ -101,19 +94,16 @@ class EncyclopediaRepository( text = text, tags = cleanedTags, aliases = cleanedAliases, - excludeFromDictionary = excludeFromDictionary, ) _entryContentChangedFlow.emit(Unit) - _entryChangedFlow.emit(oldEntryDef.id) return EntryResult(container, EntryError.NONE) } - suspend fun loadEntriesImperative(): List { + suspend fun loadEntriesImperative() { val entryDefs = datasource.loadEntriesImperative() updateEntries(entryDefs) - return entryDefs } suspend fun ensureEntriesLoaded(): List { @@ -142,10 +132,7 @@ class EncyclopediaRepository( return when { name.trim().isEmpty() -> EntryError.NAME_TOO_SHORT name.trim().length > MAX_NAME_SIZE -> EntryError.NAME_TOO_LONG - // The entry name is stored wrapped as `type~id~name`, so it never lands on disk as a - // bare basename; only the character rules apply. - ProjectNameValidator.validate(name.trim(), usedAsRawFilename = false) != - ProjectNameValidationResult.VALID -> EntryError.NAME_INVALID_CHARACTERS + !ENTRY_NAME_PATTERN.matches(name.trim()) -> EntryError.NAME_INVALID_CHARACTERS tags.any { it.length > MAX_TAG_SIZE } -> EntryError.TAG_TOO_LONG aliases.any { it.trim().length > MAX_NAME_SIZE } -> EntryError.ALIAS_TOO_LONG else -> EntryError.NONE @@ -166,7 +153,6 @@ class EncyclopediaRepository( imagePath: String?, forceId: Int? = null, aliases: List = emptyList(), - excludeFromDictionary: Boolean = false, ): EntryResult { val result = validateEntry(name, type, text, tags, aliases) if (result != EntryError.NONE) return EntryResult(result) @@ -182,7 +168,6 @@ class EncyclopediaRepository( text = text.trim(), tags = cleanedTags, aliases = cleanedAliases, - excludeFromDictionary = excludeFromDictionary, ) val container = EntryContainer(entry) @@ -195,7 +180,6 @@ class EncyclopediaRepository( if (forceId == null) markForSynchronization(newDef) _entryContentChangedFlow.emit(Unit) - _entryChangedFlow.emit(newId) return EntryResult(container, EntryError.NONE) } @@ -203,7 +187,6 @@ class EncyclopediaRepository( datasource.deleteEntry(entryDef) syncJournal.recordIdDeletion(entryDef.id) _entryContentChangedFlow.emit(Unit) - _entryChangedFlow.emit(entryDef.id) return true } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaService.kt index f401f3aed..a3879350b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaService.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/EncyclopediaService.kt @@ -31,10 +31,8 @@ class EncyclopediaService( imagePath: String?, forceId: Int? = null, aliases: List = emptyList(), - excludeFromDictionary: Boolean = false, ): EntryResult { - val result = - repository.createEntry(name, type, text, tags, imagePath, forceId, aliases, excludeFromDictionary) + val result = repository.createEntry(name, type, text, tags, imagePath, forceId, aliases) if (result.error == EntryError.NONE) statisticsRepository.markDirty() return result } @@ -45,9 +43,8 @@ class EncyclopediaService( text: String, tags: Set, aliases: List = emptyList(), - excludeFromDictionary: Boolean, ): EntryResult { - val result = repository.updateEntry(oldEntryDef, name, text, tags, aliases, excludeFromDictionary) + val result = repository.updateEntry(oldEntryDef, name, text, tags, aliases) if (result.error == EntryError.NONE) statisticsRepository.markDirty() return result } @@ -73,8 +70,6 @@ class EncyclopediaService( val entryListFlow: SharedFlow> get() = repository.entryListFlow - val entryChangedFlow: SharedFlow get() = repository.entryChangedFlow - fun loadEntries() = repository.loadEntries() suspend fun ensureEntriesLoaded(): List = repository.ensureEntriesLoaded() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/entry/EntryContent.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/entry/EntryContent.kt index 2c715f926..23f5b1dd1 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/entry/EntryContent.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/encyclopediarepository/entry/EntryContent.kt @@ -13,8 +13,6 @@ data class EntryContent( val text: String, val tags: Set, val aliases: List = emptyList(), - /** Keeps this entry's name and aliases out of the spell-check session dictionary. */ - val excludeFromDictionary: Boolean = false, ) { fun toDef(projectDef: ProjectDef): EntryDef = EntryDef( projectDef = projectDef, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsearch/SearchProjectUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsearch/SearchProjectUseCase.kt index 2fa0f3695..0e6fdbd8b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsearch/SearchProjectUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsearch/SearchProjectUseCase.kt @@ -10,8 +10,6 @@ import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesReposito import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneContentRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMetadataRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository -import com.darkrockstudios.apps.hammer.common.data.search.MarkdownProjector -import com.darkrockstudios.apps.hammer.common.data.search.MarkdownProjectorPool import com.darkrockstudios.apps.hammer.common.data.search.ParsedQuery import com.darkrockstudios.apps.hammer.common.data.search.matchesAllTags import com.darkrockstudios.apps.hammer.common.data.search.parseQuery @@ -27,9 +25,6 @@ import org.koin.core.component.inject import org.koin.core.qualifier.named import kotlin.coroutines.CoroutineContext -/** A tag match with nothing to preview: the result stands on the tag alone. */ -private val EMPTY_SNIPPET = AnnotatedSnippet(text = "", matchStart = 0, matchEnd = 0) - /** * Stateless cross-repo project search. Given a query and a filter it fans out across the * scene/notes/encyclopedia/timeline repositories and returns the matched results. Holds no state. @@ -46,9 +41,6 @@ class SearchProjectUseCase( private val dispatcherDefault: CoroutineContext by inject(named(DISPATCHER_DEFAULT)) private val dispatcherIo: CoroutineContext by inject(named(DISPATCHER_IO)) - // Outlives a single search so the buffers one scan grew are still sized for the next keystroke. - private val projectors = MarkdownProjectorPool() - suspend fun search(query: String, filter: GlobalSearchFilter): List { val parsed = parseQuery(query) if (!parsed.isUsable()) return emptyList() @@ -83,51 +75,50 @@ class SearchProjectUseCase( private val GlobalSearchFilter.includesTimeline: Boolean get() = this == GlobalSearchFilter.All || this == GlobalSearchFilter.Timeline - private suspend fun searchNotes(parsed: ParsedQuery): List = - projectors.borrow { projector -> - notes.getNotes() - .filter { it.note.tags.matchesAllTags(parsed.tags) } - .mapNotNull { container -> - val snippet = matchOrPreview(projector, container.note.content, parsed.text) - ?: return@mapNotNull null - SearchResult.Note( - noteId = container.note.id, - title = firstLineTitle(projector, container.note.content, fallback = "(empty note)"), - snippet = snippet, - ) - } - .take(PER_SOURCE_CAP) - } - - private suspend fun searchTimeline(parsed: ParsedQuery): List = projectors.borrow { projector -> - val timeline = timeLine.loadTimeline() - timeline.events - .filter { it.tags.matchesAllTags(parsed.tags) } - .mapNotNull { event -> - val snippet = matchTimelineEvent(projector, event.date, event.content, parsed.text) + private fun searchNotes(parsed: ParsedQuery): List { + return notes.getNotes() + .filter { it.note.tags.matchesAllTags(parsed.tags) } + .mapNotNull { container -> + val snippet = matchOrPreview(container.note.content, parsed.text) ?: return@mapNotNull null - SearchResult.TimelineEvent( - eventId = event.id, - title = event.date?.takeIf { it.isNotBlank() } - ?: firstLineTitle(projector, event.content, fallback = "(empty event)"), + SearchResult.Note( + noteId = container.note.id, + title = firstLineTitle(container.note.content, fallback = "(empty note)"), snippet = snippet, ) } .take(PER_SOURCE_CAP) } - private suspend fun searchEncyclopedia(parsed: ParsedQuery): List = - projectors.borrow { projector -> - collectEntryDefs() - .mapNotNull { def -> matchEncyclopediaEntry(projector, def, parsed) } - .take(PER_SOURCE_CAP) - } + private suspend fun searchTimeline(parsed: ParsedQuery): List { + val timeline = timeLine.loadTimeline() + return timeline.events + .filter { it.tags.matchesAllTags(parsed.tags) } + .mapNotNull { event -> + val combined = if (event.date.isNullOrBlank()) { + event.content + } else { + "${event.date} — ${event.content}" + } + val snippet = matchOrPreview(combined, parsed.text) ?: return@mapNotNull null + SearchResult.TimelineEvent( + eventId = event.id, + title = event.date?.takeIf { it.isNotBlank() } + ?: firstLineTitle(event.content, fallback = "(empty event)"), + snippet = snippet, + ) + } + .take(PER_SOURCE_CAP) + } - private suspend fun matchEncyclopediaEntry( - projector: MarkdownProjector, - def: EntryDef, - parsed: ParsedQuery, - ): SearchResult? { + private suspend fun searchEncyclopedia(parsed: ParsedQuery): List { + val entries = collectEntryDefs() + return entries + .mapNotNull { def -> matchEncyclopediaEntry(def, parsed) } + .take(PER_SOURCE_CAP) + } + + private suspend fun matchEncyclopediaEntry(def: EntryDef, parsed: ParsedQuery): SearchResult? { val needTags = parsed.tags.isNotEmpty() val freeText = parsed.text @@ -154,9 +145,7 @@ class SearchProjectUseCase( parsed.tags.any { tag.contains(it, ignoreCase = true) } } val title = if (matchedTag != null) "${def.name} • #$matchedTag" else def.name - val snippet = findMatch(def.name, freeText) - ?: matchOrPreview(projector, entry.text, freeText, fallback = def.name) - ?: return null + val snippet = matchOrPreview(entry.text, freeText) ?: return null return SearchResult.EncyclopediaEntry( entryDef = def, title = title, @@ -176,7 +165,7 @@ class SearchProjectUseCase( ) } - val textMatch = findMarkdownMatch(projector, entry.text, freeText) ?: return null + val textMatch = findMatch(entry.text, freeText) ?: return null return SearchResult.EncyclopediaEntry( entryDef = def, title = def.name, @@ -186,18 +175,16 @@ class SearchProjectUseCase( private suspend fun collectEntryDefs(): List = encyclopedia.ensureEntriesLoaded() - private suspend fun searchScenes(parsed: ParsedQuery): List = - projectors.borrow { projector -> - val query = parsed.text - val needTags = parsed.tags.isNotEmpty() - sceneEditor.getScenes() - .filter { it.type == SceneItem.Type.Scene } - .mapNotNull { scene -> matchScene(projector, scene, query, needTags, parsed.tags) } - .take(PER_SOURCE_CAP) - } + private suspend fun searchScenes(parsed: ParsedQuery): List { + val query = parsed.text + val needTags = parsed.tags.isNotEmpty() + val scenes = sceneEditor.getScenes().filter { it.type == SceneItem.Type.Scene } + return scenes + .mapNotNull { scene -> matchScene(scene, query, needTags, parsed.tags) } + .take(PER_SOURCE_CAP) + } private suspend fun matchScene( - projector: MarkdownProjector, scene: SceneItem, query: String, needTags: Boolean, @@ -209,9 +196,8 @@ class SearchProjectUseCase( if (nameMatch != null) { return SearchResult.Scene(sceneItem = scene, title = scene.name, snippet = nameMatch) } - val loaded = withContext(dispatcherIo) { projectScene(projector, scene) } - if (!loaded) return null - val bodyMatch = findProjectedMatch(projector, query) ?: return null + val text = withContext(dispatcherIo) { loadSceneText(scene) } ?: return null + val bodyMatch = findMatch(text, query) ?: return null return SearchResult.Scene(sceneItem = scene, title = scene.name, snippet = bodyMatch) } @@ -226,96 +212,36 @@ class SearchProjectUseCase( val title = if (matchedTag != null) "${scene.name} • #$matchedTag" else scene.name if (query.isEmpty()) { - val snippet = previewSnippet(scene.name) ?: EMPTY_SNIPPET + val snippet = previewSnippet(scene.name) ?: return null return SearchResult.Scene(sceneItem = scene, title = title, snippet = snippet) } val nameMatch = findMatch(scene.name, query) if (nameMatch != null) { return SearchResult.Scene(sceneItem = scene, title = title, snippet = nameMatch) } - val loaded = withContext(dispatcherIo) { projectScene(projector, scene) } - if (!loaded) return null - val bodyMatch = findProjectedMatch(projector, query) ?: return null + val text = withContext(dispatcherIo) { loadSceneText(scene) } ?: return null + val bodyMatch = findMatch(text, query) ?: return null return SearchResult.Scene(sceneItem = scene, title = title, snippet = bodyMatch) } - /** - * Both callers pass stored Markdown, so both paths go through the prose projection. With no free - * text the item already matched on its tags, so a blank body falls back to [fallback] and then to - * an empty snippet rather than discarding the result. - */ - private fun matchOrPreview( - projector: MarkdownProjector, - content: String, - query: String, - fallback: String = "", - ): AnnotatedSnippet? { - if (query.isEmpty()) { - return markdownPreviewSnippet(projector, content) - ?: previewSnippet(fallback) - ?: EMPTY_SNIPPET - } - return findMarkdownMatch(projector, content, query) + private fun matchOrPreview(content: String, query: String): AnnotatedSnippet? { + if (query.isEmpty()) return previewSnippet(content) + return findMatch(content, query) } - /** - * The date is a plain-text field, so only the body is projected. Both halves are searched as one - * string so a query can span the separator. - */ - private fun matchTimelineEvent( - projector: MarkdownProjector, - date: String?, - content: String, - query: String, - ): AnnotatedSnippet? { - projector.project(content) - val projected = withDate(date, projector.projected()) - if (query.isEmpty()) { - return previewSnippet(projected) - ?: previewSnippet(withDate(date, content)) - ?: EMPTY_SNIPPET - } - findMatch(projected, query)?.let { return it } - return findMatch(withDate(date, content), query) + private fun loadSceneText(scene: SceneItem): String? { + val buffer = sceneContentRepository.getSceneBuffer(scene) + val bufferText = buffer?.content?.markdown + if (bufferText != null) return bufferText + return runCatching { sceneEditor.loadSceneMarkdownRaw(scene) }.getOrNull() } - private fun withDate(date: String?, content: String): String = - if (date.isNullOrBlank()) content else "$date — $content" - - /** - * Loads the scene into [projector] and returns whether there is anything to match. An unsaved - * scene is already in memory as a string; a saved one is decoded straight off disk into the - * projector's own buffer, so scanning a project takes no string per file. - */ - private fun projectScene(projector: MarkdownProjector, scene: SceneItem): Boolean { - val bufferText = sceneContentRepository.getSceneBuffer(scene)?.content?.markdown - if (bufferText != null) { - if (bufferText.isEmpty()) return false - projector.project(bufferText) - return true - } - val chars = runCatching { - sceneEditor.readSceneMarkdownInto(scene, projector) - }.getOrDefault(0) - if (chars <= 0) return false - projector.projectSource(chars) - return true - } - - /** [content] is stored Markdown, so the derived title is projected the same way the UI does. */ - private fun firstLineTitle( - projector: MarkdownProjector, - content: String, - fallback: String, - ): String { - projector.project(content) - val title = projector.firstNonBlankLine().ifEmpty { - content.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() - } + private fun firstLineTitle(content: String, fallback: String): String { + val firstLine = content.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() return when { - title.isEmpty() -> fallback - title.length > TITLE_MAX -> title.take(TITLE_MAX).trimEnd() + "…" - else -> title + firstLine.isEmpty() -> fallback + firstLine.length > TITLE_MAX -> firstLine.take(TITLE_MAX).trimEnd() + "…" + else -> firstLine } } @@ -325,12 +251,9 @@ class SearchProjectUseCase( const val SNIPPET_BEFORE = 40 const val SNIPPET_AFTER = 80 - /** Compiled once: snippet assembly runs per result, and `Regex(…)` rebuilds the pattern. */ - private val WHITESPACE_RUN = Regex("\\s+") - internal fun previewSnippet(content: String): AnnotatedSnippet? { if (content.isEmpty()) return null - val flattened = content.replace(WHITESPACE_RUN, " ").trim() + val flattened = content.replace(Regex("\\s+"), " ").trim() if (flattened.isEmpty()) return null val maxLen = SNIPPET_BEFORE + SNIPPET_AFTER val truncated = if (flattened.length > maxLen) { @@ -348,91 +271,17 @@ class SearchProjectUseCase( return buildSnippet(text, pos, query.length) } - /** - * Matches against the prose projection of stored Markdown, so queries spanning storage - * syntax still hit and the snippet reads the way the document does. The raw source is - * searched as a fallback, which keeps queries for literal markup working. - * - * The projection is matched inside [projector]'s buffer, so a document that does not match - * costs nothing but the scan. - */ - internal fun findMarkdownMatch( - projector: MarkdownProjector, - markdown: String, - query: String, - ): AnnotatedSnippet? { - if (markdown.isEmpty() || query.isEmpty()) return null - projector.project(markdown) - return findProjectedMatch(projector, query) - } - - /** - * Matches a document [projector] already holds, whether it was copied in or read straight - * off disk. The raw fallback searches the source buffer, so neither path needs the document - * as a string. - */ - internal fun findProjectedMatch( - projector: MarkdownProjector, - query: String, - ): AnnotatedSnippet? { - if (query.isEmpty()) return null - val pos = projector.indexOf(query) - if (pos >= 0) { - return buildSnippetFrom(projector.length, pos, query.length, projector::substring) - } - return null - } - - /** Falls back to the raw source so a document made only of markup still previews. */ - internal fun markdownPreviewSnippet( - projector: MarkdownProjector, - markdown: String, - ): AnnotatedSnippet? { - if (markdown.isEmpty()) return null - projector.project(markdown) - val preview = projector.collapsedPreview(SNIPPET_BEFORE + SNIPPET_AFTER) - if (preview.isNotEmpty()) { - return AnnotatedSnippet(text = preview, matchStart = 0, matchEnd = 0) - } - return previewSnippet(markdown) - } - - internal fun buildSnippet(text: String, matchPos: Int, queryLen: Int): AnnotatedSnippet = - buildSnippetFrom(text.length, matchPos, queryLen, text::substring) - - /** - * Only the snippet window is copied out of [slice], so a hit costs a line rather than a - * document, whether the text lives in a String or in a scan buffer. - */ - private fun buildSnippetFrom( - totalLength: Int, - matchPos: Int, - queryLen: Int, - slice: (Int, Int) -> String, - ): AnnotatedSnippet { + internal fun buildSnippet(text: String, matchPos: Int, queryLen: Int): AnnotatedSnippet { val windowStart = (matchPos - SNIPPET_BEFORE).coerceAtLeast(0) - val windowEnd = (matchPos + queryLen + SNIPPET_AFTER).coerceAtMost(totalLength) - return assembleSnippet( - rawWindow = slice(windowStart, windowEnd), - matchedTerm = slice(matchPos, matchPos + queryLen), - hasPrefix = windowStart > 0, - hasSuffix = windowEnd < totalLength, - queryLen = queryLen, - ) - } + val windowEnd = (matchPos + queryLen + SNIPPET_AFTER).coerceAtMost(text.length) + val rawWindow = text.substring(windowStart, windowEnd) + val flattened = rawWindow.replace(Regex("\\s+"), " ").trim() - private fun assembleSnippet( - rawWindow: String, - matchedTerm: String, - hasPrefix: Boolean, - hasSuffix: Boolean, - queryLen: Int, - ): AnnotatedSnippet { - val flattened = rawWindow.replace(WHITESPACE_RUN, " ").trim() + val matchedTerm = text.substring(matchPos, matchPos + queryLen) val matchInFlattened = flattened.indexOf(matchedTerm, ignoreCase = true) - val prefix = if (hasPrefix) "…" else "" - val suffix = if (hasSuffix) "…" else "" + val prefix = if (windowStart > 0) "…" else "" + val suffix = if (windowEnd < text.length) "…" else "" val snippet = prefix + flattened + suffix val highlightStart = if (matchInFlattened >= 0) prefix.length + matchInFlattened else prefix.length diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettings.kt index d12c3d025..8c2765362 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettings.kt @@ -24,15 +24,7 @@ data class GlobalSettings( val automaticSyncing: Boolean = true, val nux: NewUserExperience = NewUserExperience(), val editorFontSize: Float = DEFAULT_FONT_SIZE, - /** - * The scene editor's maximum column width in dp; rendered width is - * min(available width, this). Only takes effect on windows wide enough - * to exceed it. - */ - val editorMaxWidth: Float = DEFAULT_EDITOR_WIDTH, val enableDndInFocusMode: Boolean = false, - val readerFontSize: Float = DEFAULT_FONT_SIZE, - val readerShowSceneHeadings: Boolean = false, /** * Whether the scene metadata panel is visible on wide layouts. UI state, * not really a user "preference" — lives here because we don't have a @@ -55,20 +47,13 @@ data class GlobalSettings( val installId: String? = null, val deviceLabel: String? = null, val initialProjectScreen: InitialProjectScreen = InitialProjectScreen.Home, - val lastSeenChangelogVersion: String? = null, - /** Whether the self-updating desktop builds look for a new release on a schedule. */ - val automaticUpdateChecks: Boolean = true, - /** The release the user chose "Later" on; the banner stays hidden until a newer one appears. */ - val dismissedUpdateVersion: String? = null, + val lastDismissedUpdateVersion: String? = null, ) { companion object { const val DEFAULT_BACKUPS = 20 const val MAX_BACKUPS = 50 const val DEFAULT_FONT_SIZE = 16f - const val DEFAULT_EDITOR_WIDTH = 700f - const val MIN_EDITOR_WIDTH = 700f - const val MAX_EDITOR_WIDTH = 1400f } } @@ -83,11 +68,6 @@ data class NewUserExperience( data class SpellCheckerSettings( val enabled: Boolean = true, val enabledInFocusMode: Boolean = false, - /** - * Add Encyclopedia entry names and aliases to the dictionary as session - * words while a project is open. Never persisted to any OS dictionary. - */ - val includeEncyclopediaNames: Boolean = true, @Serializable(with = LocaleSerializer::class) val locale: Locale ) { @@ -97,7 +77,6 @@ data class SpellCheckerSettings( enum class UiTheme { Light, Dark, - OledBlack, FollowSystem } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettingsStore.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettingsStore.kt index c00733632..0b0300822 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettingsStore.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/GlobalSettingsStore.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.common.data.globalsettings -import com.darkrockstudios.apps.hammer.base.BuildMetadata import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.GlobalSettingsDatasource import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.ServerSettingsDatasource import com.darkrockstudios.apps.hammer.common.fileio.HPath @@ -148,10 +147,7 @@ class GlobalSettingsStore( spellCheckSettings = SpellCheckerSettings( enabled = (hasSpForLang != null), locale = language.toLocale() - ), - // A brand new install has nothing to catch up on, so seed the changelog as seen. - // Upgrading users have no such key in their TOML and get the popup. - lastSeenChangelogVersion = BuildMetadata.APP_VERSION, + ) ) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerSettings.kt index f46923609..f837ccb50 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerSettings.kt @@ -5,8 +5,8 @@ import net.peanuuutz.tomlkt.TomlLiteralString @Serializable data class ServerSettings( - // HTTPS unless the user typed an http:// URL for a self-hosted server that has no - // certificate. See parseServerUrl. + // Clients always talk HTTPS; only test harnesses pointing at a plain-HTTP in-process + // server construct this with ssl = false. val ssl: Boolean = true, @TomlLiteralString val url: String, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerUrl.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerUrl.kt deleted file mode 100644 index 0181e1d18..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/ServerUrl.kt +++ /dev/null @@ -1,31 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.globalsettings - -/** A server address as typed by the user, split into the host and the scheme it implies. */ -data class ParsedServerUrl( - val host: String, - val ssl: Boolean, -) - -/** - * Sync is HTTPS unless the user explicitly types an `http://` URL. Self-hosted servers on a LAN or - * VPN often have no certificate, so plaintext is allowed, but it is never the default and never - * inferred: a bare host or an `https://` URL always stays encrypted. - */ -fun parseServerUrl(url: String): ParsedServerUrl { - val trimmed = url.trim() - val insecure = trimmed.startsWith(HTTP_SCHEME, ignoreCase = true) - - val host = trimmed - .lowercase() - .removePrefix(HTTP_SCHEME) - .removePrefix(HTTPS_SCHEME) - .removeSuffix("/") - - return ParsedServerUrl(host = host, ssl = !insecure) -} - -/** True when [url] would connect in the clear, for warning the user before they commit to it. */ -fun isInsecureServerUrl(url: String): Boolean = parseServerUrl(url).ssl.not() - -private const val HTTP_SCHEME = "http://" -private const val HTTPS_SCHEME = "https://" diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/PersistedServerSettings.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/PersistedServerSettings.kt index e5fd9fb81..4a959fb87 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/PersistedServerSettings.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/globalsettings/datasource/PersistedServerSettings.kt @@ -8,10 +8,8 @@ import net.peanuuutz.tomlkt.TomlLiteralString * Tokenless persisted form of [ServerSettings] written to the per-workspace * `server.json`. The secret token fields live in [AuthTokenStore] instead. * - * Thar be dragons: the scheme is stored as [plaintext], never under an `ssl` key. Files from before - * clients went HTTPS-only can still hold `ssl: false`, which was never chosen through the http:// - * opt-in, so reading `ssl` would silently downgrade them to cleartext. Only a file written after - * that opt-in existed can carry `plaintext: true`. + * Note the absence of an `ssl` field: clients are HTTPS-only, so a legacy `ssl` key + * in an existing `server.json` is ignored on load and every restored connection is HTTPS. */ @Serializable data class PersistedServerSettings( @@ -20,18 +18,16 @@ data class PersistedServerSettings( @TomlLiteralString val email: String, val userId: Long, - val plaintext: Boolean = false, ) fun ServerSettings.toPersisted(): PersistedServerSettings = PersistedServerSettings( url = url, email = email, userId = userId, - plaintext = !ssl, ) fun PersistedServerSettings.toServerSettings(tokens: AuthTokens?): ServerSettings = ServerSettings( - ssl = !plaintext, + ssl = true, url = url, email = email, userId = userId, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ideasrepository/PromoteIdeaUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ideasrepository/PromoteIdeaUseCase.kt index 126b84f8e..e2980e231 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ideasrepository/PromoteIdeaUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/ideasrepository/PromoteIdeaUseCase.kt @@ -1,6 +1,8 @@ package com.darkrockstudios.apps.hammer.common.data.ideasrepository import com.darkrockstudios.apps.hammer.base.IdeaId +import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData +import com.darkrockstudios.apps.hammer.base.http.writeToml import com.darkrockstudios.apps.hammer.common.data.CResult import com.darkrockstudios.apps.hammer.common.data.ClientResult import com.darkrockstudios.apps.hammer.common.data.ProjectDef @@ -8,10 +10,11 @@ import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesDatasource import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContainer import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent -import com.darkrockstudios.apps.hammer.common.data.projectdata.loadStoredProjectData -import com.darkrockstudios.apps.hammer.common.data.projectdata.saveStoredProjectData +import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource +import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectIoDispatcherNow +import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath import kotlinx.coroutines.withContext import net.peanuuutz.tomlkt.Toml import okio.FileSystem @@ -58,16 +61,14 @@ class PromoteIdeaUseCase( ) if (idea.tags.isNotEmpty()) { - // The datasource's scope-less helpers, because the project isn't loaded (no - // per-project Koin scope yet). Read-modify-write, not a fresh blob: createProject - // already seeded the default language and it must survive. - val stored = loadStoredProjectData(projectDef, fileSystem, toml) + // Written directly rather than through ProjectDataDatasource to avoid opening a + // per-project Koin scope for a project that isn't loaded. The project is brand new, + // so there is no existing blob to merge with. withContext(ioDispatcher) { - saveStoredProjectData( - projectDef, - fileSystem, + fileSystem.writeToml( + projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME, toml, - stored.copy(data = stored.data.copy(tags = idea.tags)), + StoredProjectData(data = ProjectData(tags = idea.tags)), ) } } @@ -78,10 +79,10 @@ class PromoteIdeaUseCase( } private fun createWithUniqueName(baseName: String): CResult { - var result = projectsRepository.createProject(baseName, seedDefaultLanguage = true) + var result = projectsRepository.createProject(baseName) var suffix = 2 while (result.isFailure && suffix <= MAX_NAME_ATTEMPTS) { - result = projectsRepository.createProject("$baseName $suffix", seedDefaultLanguage = true) + result = projectsRepository.createProject("$baseName $suffix") suffix++ } return result diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporter.kt index 1d9f3d003..cacf54dad 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporter.kt @@ -1,14 +1,9 @@ package com.darkrockstudios.apps.hammer.common.data.importer +import com.darkrockstudios.apps.hammer.common.data.ChapterHeadingLevel import com.darkrockstudios.apps.hammer.common.data.ImportFormat import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy -/** - * Imports a Markdown document. Chapters come from ATX (`#`) and Setext (`===`/`---`) headings, and - * in [MarkdownSplitStrategy.Auto] from bold-only lines when the document has next to no heading - * markup. [MarkdownSplitStrategy.Pattern] ignores markup entirely and splits on a user regex. - */ class MarkdownStoryImporter : StoryImporter { override val format: ImportFormat = ImportFormat.Markdown @@ -17,24 +12,23 @@ class MarkdownStoryImporter : StoryImporter { content: ByteArray, options: ImportOptions, ): ImportPreview { - val text = content.decodeToString().removePrefix(BOM) + val text = content.decodeToString() val lines = text.replace("\r\n", "\n").replace("\r", "\n").split("\n") - val strategy = options.markdownSplitStrategy - val tokens = if (strategy == MarkdownSplitStrategy.Pattern) { - tokenizeByPattern(lines, options.markdownChapterPattern) - } else { - tokenizeByMarkup(lines, detectBoldLines = strategy == MarkdownSplitStrategy.Auto) + val tokens = lines.map { line -> + val heading = parseHeading(line) + if (heading != null) { + ImportToken.Heading(heading.level, sanitizeImportName(heading.title), raw = line) + } else { + ImportToken.Body(line) + } } val fallbackName = sanitizeImportName(sourceName) - return when (strategy) { - MarkdownSplitStrategy.H1, - MarkdownSplitStrategy.Pattern, - -> buildImportPreview(tokens, 1, options.createChapterGroups, fallbackName) - - MarkdownSplitStrategy.H2 -> buildImportPreview(tokens, 2, options.createChapterGroups, fallbackName) - MarkdownSplitStrategy.Auto -> previewAuto(tokens, options.createChapterGroups, fallbackName) + return when (options.chapterHeadingLevel) { + ChapterHeadingLevel.H1 -> buildImportPreview(tokens, 1, options.createChapterGroups, fallbackName) + ChapterHeadingLevel.H2 -> buildImportPreview(tokens, 2, options.createChapterGroups, fallbackName) + ChapterHeadingLevel.Auto -> previewAuto(tokens, options.createChapterGroups, fallbackName) } } @@ -83,133 +77,28 @@ class MarkdownStoryImporter : StoryImporter { .copy(title = title) } - /** - * Bold-only lines are a last resort: they are only accepted when heading markup produced at most - * a story title, and only when several of them agree, so a bolded aside inside a properly headed - * manuscript can never restructure it. They sit one level below the title so that Auto still - * reads that title as the story name. - */ - private fun tokenizeByMarkup(lines: List, detectBoldLines: Boolean): List { - val tokens = tokenizeHeadingMarkup(lines, boldLevel = null) - val markupHeadings = tokens.filterIsInstance() - if (!detectBoldLines || markupHeadings.size >= MIN_MARKUP_HEADINGS) return tokens - - val boldLevel = ((markupHeadings.minOfOrNull { it.level } ?: 0) + 1).coerceAtMost(MAX_HEADING_LEVEL) - val withBold = tokenizeHeadingMarkup(lines, boldLevel) - val boldFound = withBold.count { it is ImportToken.Heading } - markupHeadings.size - return if (boldFound >= MIN_BOLD_HEADINGS) withBold else tokens - } - - private fun tokenizeHeadingMarkup(lines: List, boldLevel: Int?): List { - val tokens = mutableListOf() - var i = 0 - while (i < lines.size) { - val line = lines[i] - val atxLevel = atxHeadingLevel(line) - val underlineLevel = lines.getOrNull(i + 1)?.let { setextUnderlineLevel(it) } - when { - atxLevel != null -> tokens.add(headingToken(atxLevel, line)) - - underlineLevel != null && isSetextTitle(lines, i, underlineLevel) -> { - tokens.add(headingToken(underlineLevel, line)) - i++ - } - - boldLevel != null && isBoldOnlyLine(line) -> tokens.add(headingToken(boldLevel, line)) - - else -> tokens.add(ImportToken.Body(line)) - } - i++ + private fun parseHeading(line: String): Heading? { + var start = 0 + if (start < line.length && line[start] == BOM) start++ + var leadingSpaces = 0 + while (start < line.length && line[start] == ' ' && leadingSpaces < MAX_HEADING_INDENT) { + start++ + leadingSpaces++ } - return tokens + + var i = start + while (i < line.length && line[i] == '#') i++ + val level = i - start + if (level !in 1..MAX_HEADING_LEVEL) return null + + return Heading(level = level, title = line.substring(i).trim()) } - private fun tokenizeByPattern(lines: List, pattern: String): List { - val regex = if (pattern.isBlank()) null else runCatching { Regex(pattern) }.getOrNull() - val tokens = mutableListOf() - var i = 0 - while (i < lines.size) { - val line = lines[i] - val plain = plainText(line) - if (regex != null && plain.isNotBlank() && regex.containsMatchIn(plain)) { - tokens.add(headingToken(1, line)) - // The underline belongs to the title it underlines, not to the scene body. - if (lines.getOrNull(i + 1)?.let { setextUnderlineLevel(it) } != null) i++ - } else { - tokens.add(ImportToken.Body(line)) - } - i++ - } - return tokens - } - - private fun headingToken(level: Int, line: String) = - ImportToken.Heading(level, sanitizeImportName(plainText(line)), raw = line) - - private fun atxHeadingLevel(line: String): Int? { - val body = line.trimStart(' ') - if (line.length - body.length > MAX_HEADING_INDENT) return null - val level = body.takeWhile { it == '#' }.length - return if (level in 1..MAX_HEADING_LEVEL) level else null - } - - /** `===` underlines a level 1 heading, `---` a level 2 one; any other line is not an underline. */ - private fun setextUnderlineLevel(line: String): Int? { - val body = line.trimEnd().trimStart(' ') - if (line.trimEnd().length - body.length > MAX_HEADING_INDENT) return null - val marker = body.firstOrNull() ?: return null - if (marker != '=' && marker != '-') return null - if (body.any { it != marker }) return null - return if (marker == '=') 1 else 2 - } - - /** - * A `---` underline is also the spelling of a scene-break rule and of a front-matter fence, so it - * only makes a heading of the line above when that line opens a paragraph. `===` is unambiguous. - */ - private fun isSetextTitle(lines: List, index: Int, underlineLevel: Int): Boolean { - val line = lines[index] - if (line.isBlank()) return false - if (line.length - line.trimStart(' ').length > MAX_HEADING_INDENT) return false - if (setextUnderlineLevel(line) != null) return false - return underlineLevel == 1 || index == 0 || lines[index - 1].isBlank() - } - - /** True when the line is nothing but one short bold span. */ - private fun isBoldOnlyLine(line: String): Boolean { - val trimmed = line.trim() - return BOLD_MARKERS.any { marker -> - trimmed.length > marker.length * 2 && - trimmed.startsWith(marker) && - trimmed.endsWith(marker) && - trimmed.substring(marker.length, trimmed.length - marker.length).let { - it.isNotBlank() && !it.contains(marker) && it.trim().split(WHITESPACE).size <= HEADING_MAX_WORDS - } - } - } - - /** A line with its heading markers and wrapping emphasis removed. */ - private fun plainText(line: String): String { - var text = if (atxHeadingLevel(line) != null) line.trimStart(' ').trimStart('#').trim() else line.trim() - for (marker in EMPHASIS_MARKERS) { - while (text.length > marker.length * 2 && text.startsWith(marker) && text.endsWith(marker)) { - text = text.substring(marker.length, text.length - marker.length).trim() - } - } - return text - } + private class Heading(val level: Int, val title: String) companion object { private const val MAX_HEADING_LEVEL = 6 private const val MAX_HEADING_INDENT = 3 - private const val MIN_MARKUP_HEADINGS = 2 - private const val MIN_BOLD_HEADINGS = 2 - - /** Beyond this a bolded line is prose, not a chapter title. */ - private const val HEADING_MAX_WORDS = 12 - private const val BOM = "" - private val BOLD_MARKERS = listOf("**", "__") - private val EMPHASIS_MARKERS = listOf("**", "__", "*", "_") - private val WHITESPACE = Regex("\\s+") + private const val BOM = '' } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporter.kt index cd7cabd97..1c2381d25 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporter.kt @@ -157,9 +157,7 @@ class RtfStoryImporter : StoryImporter { /** * Walks the body destinations of an RTF document, emitting one [RtfParagraph] per `\par`. Tracks * group-scoped character formatting (bold/italic/font size) and paragraph properties (outline - * level), wrapping bold/italic runs in Markdown. Delimiters hug the emphasized text: RTF writers - * routinely put the surrounding spaces inside the run, and CommonMark rejects emphasis with - * whitespace immediately inside the markers. + * level), wrapping bold/italic runs in Markdown the way the library's own converter does. */ private class RtfParagraphCollector : com.darkrockstudios.libs.rtfparserkmp.parser.RtfListener { val paragraphs = mutableListOf() @@ -197,8 +195,9 @@ class RtfStoryImporter : StoryImporter { override fun processString(string: String) { if (!isBodyDestination()) return + openEmphasis() plain.append(string) - appendMarkdown(string) + markdown.append(escape(string)) for (ch in string) { if (ch.isWhitespace()) continue totalChars++ @@ -242,7 +241,7 @@ class RtfStoryImporter : StoryImporter { private fun endParagraph() { closeEmphasis() - val md = escapeOrderedListMarkers(markdown.toString().trim()) + val md = markdown.toString().trim() val text = plain.toString().trim() val dominantSize = sizeCounts.maxByOrNull { it.value }?.key val mostlyBold = totalChars > 0 && boldChars.toDouble() / totalChars >= BOLD_RATIO @@ -288,21 +287,6 @@ class RtfStoryImporter : StoryImporter { Marker.ITALIC -> italic } - /** - * Opens pending emphasis at the first non-whitespace character, so a run's leading whitespace - * stays outside the delimiters and an all-whitespace run opens nothing. - */ - private fun appendMarkdown(text: String) { - val firstVisible = text.indexOfFirst { !it.isWhitespace() } - if (firstVisible < 0) { - markdown.append(text) - return - } - markdown.append(text.substring(0, firstVisible)) - openEmphasis() - markdown.append(escape(text.substring(firstVisible))) - } - private fun openEmphasis() { if (bold && Marker.BOLD !in openMarkers) { markdown.append(Marker.BOLD.text) @@ -314,36 +298,28 @@ class RtfStoryImporter : StoryImporter { } } - /** - * Closes every marker down to the shallowest inactive one. Still-active markers come off the - * stack too and are reopened by [openEmphasis] at the next non-whitespace character. - */ private fun closeDisabledMarkers() { val deepestDisabled = openMarkers.indexOfFirst { !isActive(it) } if (deepestDisabled < 0) return + val reopen = ArrayDeque() while (openMarkers.size > deepestDisabled) { - closeMarker(openMarkers.removeLast()) + val top = openMarkers.removeLast() + markdown.append(top.text) + if (isActive(top)) reopen.addLast(top) + } + while (reopen.isNotEmpty()) { + val m = reopen.removeLast() + markdown.append(m.text) + openMarkers.addLast(m) } } private fun closeEmphasis() { while (openMarkers.isNotEmpty()) { - closeMarker(openMarkers.removeLast()) + markdown.append(openMarkers.removeLast().text) } } - /** Emits [marker] ahead of any trailing whitespace, keeping the delimiter against the text. */ - private fun closeMarker(marker: Marker) { - markdown.insert(markdown.length - trailingWhitespaceLength(), marker.text) - } - - private fun trailingWhitespaceLength(): Int = - markdown.length - (markdown.indexOfLast { !it.isWhitespace() } + 1) - - /** Keeps an imported paragraph that starts with "1." from parsing as an ordered list. */ - private fun escapeOrderedListMarkers(text: String): String = - text.replace(ORDERED_LIST_MARKER, "$1\\\\.") - private fun escape(text: String): String { val out = StringBuilder(text.length) for (ch in text) { @@ -357,15 +333,12 @@ class RtfStoryImporter : StoryImporter { private enum class Marker(val text: String) { BOLD("**"), - ITALIC("*"), + ITALIC("_"), } private companion object { const val BOLD_RATIO = 0.8 - - /** Mirrors `MARKDOWN_SPECIAL_CHARS` in ComposeTextEditor's Markdown escaper. */ - val MARKDOWN_SPECIAL = "\\`*_{}[]()<>#+-!|".toSet() - val ORDERED_LIST_MARKER = Regex("^(\\d+)\\.", RegexOption.MULTILINE) + val MARKDOWN_SPECIAL = "\\`*_{}[]<>#".toSet() } } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/StoryImporter.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/StoryImporter.kt index 77fd0da1f..3233bb57a 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/StoryImporter.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/StoryImporter.kt @@ -2,12 +2,7 @@ package com.darkrockstudios.apps.hammer.common.data.importer import com.darkrockstudios.apps.hammer.common.data.ImportFormat import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.base.markdown.countWords import kotlinx.serialization.Serializable -import kotlinx.serialization.Transient - -/** Above this, a scene reads as a failed chapter split rather than a long chapter. */ -const val LARGE_SCENE_WORD_COUNT = 10_000 interface StoryImporter { val format: ImportFormat @@ -34,17 +29,6 @@ data class ImportPreview( is PreviewItem.Group -> item.scenes.size } } - - /** Scenes at or over [LARGE_SCENE_WORD_COUNT], in document order. */ - val oversizedScenes: List - get() = buildList { - items.forEach { item -> - when (item) { - is PreviewItem.Scene -> if (item.isOversized) add(item) - is PreviewItem.Group -> item.scenes.filterTo(this) { it.isOversized } - } - } - } } @Serializable @@ -55,12 +39,7 @@ sealed interface PreviewItem { data class Scene( override val name: String, val markdown: String, - ) : PreviewItem { - @Transient - val wordCount: Int = countWords(markdown) - - val isOversized: Boolean get() = wordCount >= LARGE_SCENE_WORD_COUNT - } + ) : PreviewItem @Serializable data class Group( diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/DataMigrator.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/DataMigrator.kt index 3b110d2d2..ffa3b34e9 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/DataMigrator.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/DataMigrator.kt @@ -22,7 +22,6 @@ open class DataMigrator( getKoin().get().addToMap(migrators) getKoin().get().addToMap(migrators) - getKoin().get().addToMap(migrators) return migrators } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/Migration2_3.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/Migration2_3.kt deleted file mode 100644 index bcc5a1391..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/Migration2_3.kt +++ /dev/null @@ -1,115 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.migrator - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import io.github.aakira.napier.Napier -import okio.FileSystem -import okio.Path - -/** - * Renames encyclopedia entry files (`type-id-name.toml`), their images (`type-id-image.ext`), and - * scene draft files (`sceneId-draftId-name-timestamp.md`) from the legacy `-`-delimited format to - * the `~`-delimited one. The delimiter swap frees `-` (and the rest of the widened name character - * set) for use inside user-typed entry and draft names, matching what [Migration1_2] did for - * scenes. - */ -class Migration2_3( - private val fileSystem: FileSystem, -) : Migration { - override val toVersion: Int = 3 - - override fun migrate(projectDef: ProjectDef) { - Napier.i("Begin Migration2_3 for '${projectDef.name}'...") - - val renamed = migrateEncyclopedia(projectDef) + migrateDrafts(projectDef) - - Napier.i("Migration2_3 for '${projectDef.name}' complete, renamed $renamed file(s).") - } - - private fun migrateEncyclopedia(projectDef: ProjectDef): Int { - val projectDir = projectDef.path.toOkioPath() - val encyclopediaDir = projectDir / EncyclopediaDatasource.ENCYCLOPEDIA_DIRECTORY - if (!fileSystem.exists(encyclopediaDir)) { - Napier.i("No encyclopedia directory for '${projectDef.name}', skipping.") - return 0 - } - - return renameAll(encyclopediaDir) { name -> nextEntryName(name) } - } - - private fun migrateDrafts(projectDef: ProjectDef): Int { - val sceneDir = SceneDatasource.getSceneDirectory(projectDef, fileSystem).toOkioPath() - val draftsDir = sceneDir / SceneDraftsDatasource.DRAFTS_DIR - if (!fileSystem.exists(draftsDir)) { - Napier.i("No drafts directory for '${projectDef.name}', skipping.") - return 0 - } - - return renameAll(draftsDir) { name -> nextDraftName(name) } - } - - private fun renameAll(root: Path, nextName: (String) -> String?): Int { - var renamed = 0 - // Only files are renamed here, but walk deepest-first anyway so the traversal stays - // correct if a future format nests names inside directory names. - fileSystem.listRecursively(root) - .toList() - .sortedByDescending { it.segments.size } - .forEach { path -> - val newName = nextName(path.name) ?: return@forEach - val target = path.parent?.div(newName) ?: return@forEach - if (fileSystem.exists(target)) { - Napier.w("Migration2_3: target already exists, skipping rename of $path") - return@forEach - } - fileSystem.atomicMove(path, target) - renamed++ - } - return renamed - } - - /** - * Returns the `~`-delimited name for [oldName] if it matches a legacy encyclopedia entry or - * entry image filename, or null if it doesn't match (e.g. a type directory, or a file already - * in the new format). - */ - private fun nextEntryName(oldName: String): String? { - EncyclopediaDatasource.LEGACY_ENTRY_FILENAME_PATTERN.matchEntire(oldName)?.let { m -> - val (type, id) = Pair(m.groupValues[1], m.groupValues[2]) - val name = canonicalName(m.groupValues[3]) ?: return null - return "$type~$id~$name.toml" - } - EncyclopediaDatasource.LEGACY_ENTRY_IMAGE_FILENAME_PATTERN.matchEntire(oldName)?.let { m -> - val (type, id, extension) = Triple(m.groupValues[1], m.groupValues[2], m.groupValues[3]) - return "$type~$id~image.$extension" - } - return null - } - - /** - * Returns the `~`-delimited name for [oldName] if it matches the legacy draft filename, or - * null if it doesn't match (e.g. a per-scene directory, or an already-migrated file). - */ - private fun nextDraftName(oldName: String): String? { - val m = SceneDraftsDatasource.LEGACY_DRAFT_FILENAME_PATTERN.matchEntire(oldName) - ?: return null - val sceneId = m.groupValues[1] - val draftId = m.groupValues[2] - val name = canonicalName(m.groupValues[3]) ?: return null - val timestamp = m.groupValues[4] - return "$sceneId~$draftId~$name~$timestamp.md" - } - - /** - * The name exactly as the datasources would write it today. Both encode the name, which strips - * a trailing `.`/space that the old, narrower rules let through; without this the migrated file - * would never match the path rebuilt from its own parsed name. Null when nothing legal is left, - * so the file is skipped rather than renamed to an unparseable one. - */ - private fun canonicalName(rawName: String): String? = - ProjectsRepository.encodeForFilename(rawName).ifBlank { null } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/ProjectDataVersion.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/ProjectDataVersion.kt index 31c5f731f..7b664b39d 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/ProjectDataVersion.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/migrator/ProjectDataVersion.kt @@ -5,4 +5,4 @@ package com.darkrockstudios.apps.hammer.common.data.migrator * to this version. Incrementing this version requires that a DataMigrator be added for the new * version. */ -const val PROJECT_DATA_VERSION = 3 \ No newline at end of file +const val PROJECT_DATA_VERSION = 2 \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/pairing/PairingProtocol.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/pairing/PairingProtocol.kt deleted file mode 100644 index 7b4ce1470..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/pairing/PairingProtocol.kt +++ /dev/null @@ -1,86 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.pairing - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import kotlinx.serialization.SerialName -import kotlinx.serialization.Serializable -import kotlinx.serialization.json.Json - -/** - * The phone to watch pairing handshake, carried as Wearable Data Layer messages. The watch sends a - * [PairRequest] to a phone advertising [PHONE_CAPABILITY]; the phone answers with a [PairResponse] - * holding a session minted for the watch's own install. - */ -object PairingProtocol { - const val PHONE_CAPABILITY = "hammer_phone_pairing" - const val PATH_PREFIX = "/hammer/pair" - const val REQUEST_PATH = "$PATH_PREFIX/request" - const val RESPONSE_PATH = "$PATH_PREFIX/response" - const val VERSION = 1 - - private val json = Json { - ignoreUnknownKeys = true - classDiscriminator = "type" - // [PairRequest.version] is a defaulted field, and the compatibility check depends on it - // actually reaching the other device. - encodeDefaults = true - } - - fun encodeRequest(request: PairRequest): ByteArray = - json.encodeToString(PairRequest.serializer(), request).encodeToByteArray() - - /** Null when the payload is not a request this version understands. */ - fun decodeRequest(payload: ByteArray): PairRequest? = try { - json.decodeFromString(PairRequest.serializer(), payload.decodeToString()) - } catch (_: IllegalArgumentException) { - null - } - - fun encodeResponse(response: PairResponse): ByteArray = - json.encodeToString(PairResponse.serializer(), response).encodeToByteArray() - - /** Null when the payload is not a response this version understands. */ - fun decodeResponse(payload: ByteArray): PairResponse? = try { - json.decodeFromString(PairResponse.serializer(), payload.decodeToString()) - } catch (_: IllegalArgumentException) { - null - } -} - -@Serializable -data class PairRequest( - val requestId: String, - val installId: String, - val deviceLabel: String, - val version: Int = PairingProtocol.VERSION, -) - -@Serializable -sealed interface PairResponse { - val requestId: String - - @Serializable - @SerialName("success") - data class Success( - override val requestId: String, - val settings: ServerSettings, - ) : PairResponse - - @Serializable - @SerialName("error") - data class Error( - override val requestId: String, - val code: PairErrorCode, - val message: String? = null, - ) : PairResponse -} - -@Serializable -enum class PairErrorCode { - Declined, - NotSignedIn, - ServerRejected, - Unsupported, - - /** The phone got the request but could not put the confirmation in front of the user. */ - PhoneUnavailable, -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepository.kt index 34d9fad67..dbde9dc14 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepository.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.common.data.projectbackup -import com.darkrockstudios.apps.hammer.base.validate.validateProjectName import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository @@ -11,8 +10,6 @@ import com.darkrockstudios.apps.hammer.common.util.format import com.darkrockstudios.apps.hammer.common.util.zip.unzipToDirectory import com.darkrockstudios.apps.hammer.common.util.zip.zipDirectory import io.github.aakira.napier.Napier -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock import kotlinx.datetime.* import okio.FileNotFoundException import okio.FileSystem @@ -29,8 +26,6 @@ open class ProjectBackupRepository( protected val clock: Clock ) : KoinComponent { - private val restoreLock = Mutex() - fun getBackupsDirectory(): HPath { val dir = (projectsRepository.getProjectsDirectory().toOkioPath() / BACKUP_DIRECTORY) @@ -180,92 +175,23 @@ open class ProjectBackupRepository( } open suspend fun restoreBackup(backupDef: ProjectBackupDef, targetDir: HPath): Boolean { - val targetOkioPath = targetDir.toOkioPath() - val staging = getBackupsDirectory().toOkioPath() / RESTORE_STAGING_DIRECTORY - val extracted = staging / "new" - val displaced = staging / "old" + return try { + val targetOkioPath = targetDir.toOkioPath() + fileSystem.deleteRecursively(targetOkioPath) + fileSystem.createDirectories(targetOkioPath) - return restoreLock.withLock { - try { - fileSystem.deleteRecursively(staging) - fileSystem.createDirectories(extracted) - - unzipToDirectory( - fileSystem = fileSystem, - zipPath = backupDef.path.toOkioPath(), - destinationDirectory = extracted - ) - - swapIntoPlace(archiveRoot(extracted), targetOkioPath, displaced) - true - } catch (e: Exception) { - Napier.e("Failed to restore backup: ${backupDef.path.name}", e) - false - } finally { - try { - fileSystem.deleteRecursively(staging) - } catch (e: IOException) { - Napier.w("Failed to clean up restore staging directory", e) - } - } + unzipToDirectory( + fileSystem = fileSystem, + zipPath = backupDef.path.toOkioPath(), + destinationDirectory = targetOkioPath + ) + true + } catch (e: Exception) { + Napier.e("Failed to restore backup: ${backupDef.path.name}", e) + false } } - // The current project is moved aside, not deleted, so it can be put back if the swap fails. - private fun swapIntoPlace(restored: Path, target: Path, displaced: Path) { - val hadExisting = fileSystem.exists(target) - if (hadExisting) { - fileSystem.atomicMove(target, displaced) - } else { - target.parent?.let { fileSystem.createDirectories(it) } - } - - try { - fileSystem.atomicMove(restored, target) - } catch (e: IOException) { - if (hadExisting) fileSystem.atomicMove(displaced, target) - throw e - } - } - - // Backup archives hold the project inside a single directory named after the project. - private fun archiveRoot(extracted: Path): Path { - val onlyChild = fileSystem.list(extracted).singleOrNull() ?: return extracted - return if (fileSystem.metadata(onlyChild).isDirectory) onlyChild else extracted - } - - /** - * Every project that has at least one backup, including projects that no longer exist on - * disk, so a deleted project can still be restored from its backups. - */ - fun getBackedUpProjects(): List { - val backupKeys = fileSystem.list(getBackupsDirectory().toOkioPath()) - .mapNotNull { FILE_NAME_PATTERN.matchEntire(it.name)?.groups?.get(1)?.value } - .toSet() - - val projects = projectsRepository.getProjects() - val existing = projects.filter { project -> - backupKeysForProject(project.name).any { it in backupKeys } - } - - val claimedKeys = projects.flatMap { backupKeysForProject(it.name) }.toSet() - val missingNames = (backupKeys - claimedKeys) - .map { ProjectsRepository.decodeFromFilename(it) } - .filter { validateProjectName(it) } - .distinct() - - // A legacy-named backup belongs to the project whose current name also has backups. - val legacyAliases = missingNames - .filter { legacyBackupName(it) != it } - .map { legacyBackupName(it) } - .toSet() - val missing = missingNames - .filterNot { it in legacyAliases } - .map { projectsRepository.getProjectDefinition(it) } - - return existing + missing - } - private fun localDateTime(dateTimeStr: String): LocalDateTime { val match = DATE_PATTERN.matchEntire(dateTimeStr) ?: throw IllegalArgumentException("Failed to parse date time") val year = match.groupValues[1].toInt() @@ -287,7 +213,6 @@ open class ProjectBackupRepository( companion object { const val BACKUP_DIRECTORY = ".backups" - private const val RESTORE_STAGING_DIRECTORY = ".restore" val FILE_NAME_PATTERN = Regex("^(.+)-(\\d{4}-\\d{2}-\\d{2}T\\d+Z)\\.zip$") val DATE_PATTERN = Regex("^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2})(\\d{2})(\\d{2})Z$") } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataDatasource.kt index ac5494d27..d69e8968d 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataDatasource.kt @@ -42,7 +42,7 @@ class ProjectDataDatasource( } suspend fun save(stored: StoredProjectData): Unit = withContext(dispatcherIo) { - saveStoredProjectData(projectDef, fileSystem, toml, stored) + fileSystem.writeToml(getPath(), toml, stored) } companion object { @@ -68,47 +68,8 @@ suspend fun loadStoredProjectData( fileSystem: FileSystem, toml: Toml, ): StoredProjectData = withContext(Dispatchers.IO) { - readStoredProjectData(projectDef, fileSystem, toml) -} - -/** Blocking twin of [loadStoredProjectData] for callers that already own their threading (parallel mappers, IO-dispatched code). */ -fun readStoredProjectData( - projectDef: ProjectDef, - fileSystem: FileSystem, - toml: Toml, -): StoredProjectData { val path = projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME - return fileSystem.readTomlOrNull(path, toml) { e -> + fileSystem.readTomlOrNull(path, toml) { e -> Napier.d("No project_data.toml at $path (${e.message})") } ?: StoredProjectData() } - -/** - * The single writer for `project_data.toml`. [ProjectDataDatasource.save] delegates here; - * scope-less callers (project creation, before a per-project Koin scope exists) use it - * directly so the on-disk format has exactly one owner. - */ -fun saveStoredProjectData( - projectDef: ProjectDef, - fileSystem: FileSystem, - toml: Toml, - stored: StoredProjectData, -) { - fileSystem.writeToml(projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME, toml, stored) -} - -/** - * Drops [StoredProjectData.lastSyncedHash] while leaving [StoredProjectData.data] intact, for when - * the project starts pointing at a different server project and the old baseline no longer - * describes any agreement. Never creates the file: no file means no baseline to clear. - */ -fun clearProjectDataSyncBaseline( - projectDef: ProjectDef, - fileSystem: FileSystem, - toml: Toml, -) { - if (!fileSystem.exists(projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME)) return - val stored = readStoredProjectData(projectDef, fileSystem, toml) - if (stored.lastSyncedHash == null) return - saveStoredProjectData(projectDef, fileSystem, toml, stored.copy(lastSyncedHash = null)) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMerge.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMerge.kt deleted file mode 100644 index 2e482500c..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMerge.kt +++ /dev/null @@ -1,37 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.projectdata - -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData - -/** - * Dictionary words never need a decision: a conflict keeps both sides. Kept verbatim, because the - * merged set is uploaded: a word a newer build stored under laxer rules than this one accepts as - * input would otherwise be deleted server-side for every other device. - */ -fun mergeDictionaryWords(local: ProjectData, server: ProjectData): Set = - local.dictionaryWords + server.dictionaryWords - -/** True when something other than the auto-merged dictionary differs. */ -fun ProjectData.differsOutsideDictionary(other: ProjectData): Boolean = - copy(dictionaryWords = other.dictionaryWords) != other - -/** - * Re-applies the edits made between [base] and [local] on top of [incoming]: a field the user - * changed keeps its local value, the rest take the incoming value, and dictionary words carry - * the local additions and removals over as a delta. - */ -fun reapplyLocalEdits(base: ProjectData, local: ProjectData, incoming: ProjectData): ProjectData { - fun pick(baseValue: T, localValue: T, incomingValue: T): T = - if (localValue != baseValue) localValue else incomingValue - - return incoming.copy( - authorName = pick(base.authorName, local.authorName, incoming.authorName), - theme = pick(base.theme, local.theme, incoming.theme), - wordCountGoal = pick(base.wordCountGoal, local.wordCountGoal, incoming.wordCountGoal), - tags = pick(base.tags, local.tags, incoming.tags), - language = pick(base.language, local.language, incoming.language), - encyclopediaDictionary = pick(base.encyclopediaDictionary, local.encyclopediaDictionary, incoming.encyclopediaDictionary), - dictionaryWords = incoming.dictionaryWords + - (local.dictionaryWords - base.dictionaryWords) - - (base.dictionaryWords - local.dictionaryWords), - ) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataRepository.kt index d006eb47f..c9948e80a 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataRepository.kt @@ -47,32 +47,13 @@ class ProjectDataRepository( } /** - * Sync-only: drop [StoredProjectData.lastSyncedHash], keeping [ProjectData] intact, for when the - * project starts pointing at a different server project. Goes through the same lock as every - * other write so a concurrent [updateData] can't persist the stale baseline back out of the - * cache. Never creates the file: no baseline recorded means nothing to clear. + * Sync-only: replace both [ProjectData] and [StoredProjectData.lastSyncedHash] + * atomically, e.g. after a successful upload or after fast-forwarding to + * the server's state. */ - suspend fun clearSyncBaseline() = mutex.withLock { - val current = _state.value ?: datasource.load() - if (current.lastSyncedHash == null) return@withLock - val next = current.copy(lastSyncedHash = null) - datasource.save(next) - _state.value = next - } - - /** - * Sync-only: install [data] as the state agreed with the server under [lastSyncedHash], e.g. - * after a successful upload or a fast-forward. Edits made since the sync read [snapshot] - * are re-applied on top, so they stay pending for the next sync instead of being lost. - */ - suspend fun updateFromSync( - data: ProjectData, - lastSyncedHash: String, - snapshot: ProjectData, - ) = mutex.withLock { - val current = _state.value ?: datasource.load() - val merged = if (current.data == snapshot) data else reapplyLocalEdits(snapshot, current.data, data) - val next = StoredProjectData(data = merged, lastSyncedHash = lastSyncedHash) + suspend fun updateFromSync(data: ProjectData, lastSyncedHash: String) = mutex.withLock { + val current = _state.value + val next = StoredProjectData(data = data, lastSyncedHash = lastSyncedHash) if (current == next) return@withLock datasource.save(next) _state.value = next diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectsrepository/ProjectsRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectsrepository/ProjectsRepository.kt index 2dc824de7..db1b95aa1 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectsrepository/ProjectsRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectsrepository/ProjectsRepository.kt @@ -2,7 +2,6 @@ package com.darkrockstudios.apps.hammer.common.data.projectsrepository import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidationResult import com.darkrockstudios.apps.hammer.base.validate.ProjectNameValidator import com.darkrockstudios.apps.hammer.base.validate.validateProjectName @@ -14,21 +13,14 @@ import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.isSuccess import com.darkrockstudios.apps.hammer.common.data.migrator.PROJECT_DATA_VERSION -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData -import com.darkrockstudios.apps.hammer.common.data.projectdata.clearProjectDataSyncBaseline -import com.darkrockstudios.apps.hammer.common.data.projectdata.saveStoredProjectData import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository.Companion.MAX_FILENAME_LENGTH import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository.Companion.RECOVERED_PROJECT_NAME import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository.Companion.encodeForFilename import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository.Companion.sanitizeFileName import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository.Companion.validateFileName -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.clearProjectSyncBaseline import com.darkrockstudios.apps.hammer.common.data.toMsg import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_DEFAULT -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver import com.darkrockstudios.apps.hammer.common.fileio.HPath import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath @@ -40,14 +32,11 @@ import com.darkrockstudios.apps.hammer.create_project_error_too_long import io.github.aakira.napier.Napier import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.launch -import kotlinx.serialization.json.Json -import net.peanuuutz.tomlkt.Toml import okio.FileSystem import okio.IOException import okio.Path.Companion.toPath import org.jetbrains.compose.resources.StringResource import org.koin.core.component.KoinComponent -import org.koin.core.component.getScopeId import org.koin.core.component.inject import org.koin.core.qualifier.named import kotlin.coroutines.CoroutineContext @@ -56,10 +45,7 @@ import kotlin.time.Clock class ProjectsRepository( private val fileSystem: FileSystem, globalSettingsStore: GlobalSettingsStore, - private val projectsMetadataDatasource: ProjectMetadataDatasource, - private val toml: Toml, - private val json: Json, - private val deviceLocaleResolver: DeviceLocaleResolver, + private val projectsMetadataDatasource: ProjectMetadataDatasource ) : KoinComponent { private val dispatcherDefault: CoroutineContext by inject(named(DISPATCHER_DEFAULT)) @@ -98,48 +84,18 @@ class ProjectsRepository( getProjectsDirectory() } - suspend fun removeProjectId(projectDef: ProjectDef) { - clearSyncBaseline(projectDef) + fun removeProjectId(projectDef: ProjectDef) { projectsMetadataDatasource.updateMetadata(projectDef) { it.copy(info = it.info.copy(serverProjectId = null)) } } - suspend fun setProjectId(projectDef: ProjectDef, projectId: ProjectId) { - if (getProjectId(projectDef) != projectId) { - clearSyncBaseline(projectDef) - } + fun setProjectId(projectDef: ProjectDef, projectId: ProjectId) { projectsMetadataDatasource.updateMetadata(projectDef) { it.copy(info = it.info.copy(serverProjectId = projectId)) } } - /** - * The entity journal and `lastSyncedHash` record what one specific server already confirmed. - * Once the project points somewhere else they describe an agreement that no longer exists, and - * an untouched project reads as "already in sync": its content is never uploaded, and - * `ProjectDataSyncOperation` fast-forwards the local copy to the new server's empty one. - * The user's data is untouched — only the baseline goes, so the next sync uploads everything. - * - * Runs before the id is written: the two are separate files, so a failure or crash between them - * must leave a project that still points at the old server rather than one pointing at the new - * server with the old server's baseline, which is the corrupt state this exists to prevent. - */ - private suspend fun clearSyncBaseline(projectDef: ProjectDef) { - clearProjectSyncBaseline(projectDef, fileSystem, json) - - // An open project serves project data from ProjectDataRepository's cache, so clearing only - // the file would leave the stale hash live (and get it written straight back out). - val openProject = getKoin() - .getScopeOrNull(ProjectDefScope(projectDef).getScopeId()) - ?.get() - if (openProject != null) { - openProject.clearSyncBaseline() - } else { - clearProjectDataSyncBaseline(projectDef, fileSystem, toml) - } - } - fun getProjectId(projectDef: ProjectDef): ProjectId? { val metadata = projectsMetadataDatasource.loadMetadata(projectDef) return metadata.info.serverProjectId @@ -199,13 +155,7 @@ class ProjectsRepository( return ProjectDef(projectName, projectDir.toHPath()) } - /** - * [seedDefaultLanguage] must be false when materializing a project that already exists - * on the server (account sync): a fresh local shell has to keep the never-synced - * ProjectData baseline (empty data, null lastSyncedHash), or the first project sync - * reads the seed as a phantom local edit and raises a spurious conflict. - */ - fun createProject(projectName: String, seedDefaultLanguage: Boolean): CResult { + fun createProject(projectName: String): CResult { val strippedName = projectName.trim() val result = validateFileName(strippedName) return if (isSuccess(result)) { @@ -230,20 +180,6 @@ class ProjectsRepository( ) projectsMetadataDatasource.saveMetadata(metadata, newDef) - if (seedDefaultLanguage) { - // New projects start declared in the device's language, without a region: - // the auto-default must never gate spell check against a same-language - // dictionary of another region (en vs en-GB). Users can pick a full tag - // in project settings. - val languageTag = deviceLocaleResolver.getCurrentLocale().language - saveStoredProjectData( - newDef, - fileSystem, - toml, - StoredProjectData(data = ProjectData(language = languageTag)), - ) - } - CResult.success(newDef) } } else { @@ -291,43 +227,6 @@ class ProjectsRepository( } } - /** - * Drops a project's content but keeps the directory and its [ProjectMetadata.FILENAME], so the - * project stays listed and keeps its server id. The sync and project data files go with the - * content, so a later re-download starts from nothing rather than from a baseline claiming the - * content is already present. - */ - fun deleteProjectContent(projectDef: ProjectDef) { - val projectDir = projectDef.path.toOkioPath() - if (!fileSystem.exists(projectDir)) return - fileSystem.list(projectDir) - .filter { it.name != ProjectMetadata.FILENAME } - .forEach { entry -> - try { - fileSystem.deleteRecursively(entry) - } catch (e: IOException) { - Napier.e("Failed to delete $entry while removing project content", e) - } - } - } - - /** - * Deletes everything under the projects directory: every project along with ideas, backups, and - * account sync state. Only for a client discarding its whole account, such as a Wear OS sign out. - */ - fun deleteAllLocalData() { - val projectsDir = getProjectsDirectory().toOkioPath() - if (!fileSystem.exists(projectsDir)) return - fileSystem.list(projectsDir).forEach { child -> - // One unwritable entry must not abandon the rest of the wipe. - try { - fileSystem.deleteRecursively(child) - } catch (e: IOException) { - Napier.e("Failed to delete $child while discarding local data", e) - } - } - } - companion object { const val MAX_FILENAME_LENGTH = ProjectNameValidator.MAX_LENGTH diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatistics.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatistics.kt index 2864296e1..39f8a6172 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatistics.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatistics.kt @@ -2,8 +2,8 @@ package com.darkrockstudios.apps.hammer.common.data.projectstatistics import com.darkrockstudios.apps.hammer.base.http.projectdata.WordCountGoal import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType +import kotlinx.datetime.Instant import kotlinx.serialization.Serializable -import kotlin.time.Instant @Serializable data class EntryAppearance( diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatisticsCacheReader.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatisticsCacheReader.kt index 1bf83a645..a808e796f 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatisticsCacheReader.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/ProjectStatisticsCacheReader.kt @@ -1,17 +1,25 @@ package com.darkrockstudios.apps.hammer.common.data.projectstatistics +import com.darkrockstudios.apps.hammer.base.http.readTomlOrNull import com.darkrockstudios.apps.hammer.common.data.ProjectDef +import io.github.aakira.napier.Napier import net.peanuuutz.tomlkt.Toml import okio.FileSystem -/** Reads the cached stats file via the datasource's scope-less helper, without opening a ProjectDefScope. */ +/** Reads the cached stats file directly, without opening a ProjectDefScope. */ class ProjectStatisticsCacheReader( private val fileSystem: FileSystem, private val toml: Toml, ) { fun loadStatistics(projectDef: ProjectDef): ProjectStatistics? { - val stats = readProjectStatistics(projectDef, fileSystem, toml) ?: return null + val file = StatisticsCachePaths.statsFile(projectDef) + if (!fileSystem.exists(file)) return null + + val stats = fileSystem.readTomlOrNull(file, toml) { e -> + Napier.d("Failed to read statistics cache for ${projectDef.name}", e) + } ?: return null + if (stats.schemaVersion != ProjectStatistics.CURRENT_SCHEMA_VERSION) return null return stats } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsDatasource.kt index a249bb7b4..77ce749bf 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsDatasource.kt @@ -22,7 +22,14 @@ class StatisticsDatasource( private val dispatcherIo by injectIoDispatcher() suspend fun loadStatistics(): ProjectStatistics? = withContext(dispatcherIo) { - readProjectStatistics(projectDef, fileSystem, toml) + val file = StatisticsCachePaths.statsFile(projectDef) + return@withContext if (fileSystem.exists(file)) { + fileSystem.readTomlOrNull(file, toml) { e -> + Napier.e("Failed to load statistics cache", e) + } + } else { + null + } } suspend fun saveStatistics(stats: ProjectStatistics) = withContext(dispatcherIo) { @@ -61,20 +68,3 @@ class StatisticsDatasource( } } } - -/** - * Blocking, scope-less read of the statistics cache; callers own their threading. - * [StatisticsDatasource.loadStatistics] and the root-scoped - * [ProjectStatisticsCacheReader] both delegate here so the format has one reader. - */ -fun readProjectStatistics( - projectDef: ProjectDef, - fileSystem: FileSystem, - toml: Toml, -): ProjectStatistics? { - val file = StatisticsCachePaths.statsFile(projectDef) - if (!fileSystem.exists(file)) return null - return fileSystem.readTomlOrNull(file, toml) { e -> - Napier.d("Failed to read statistics cache for ${projectDef.name}", e) - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsService.kt index 833c9e9f4..249abd1bc 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsService.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/StatisticsService.kt @@ -1,11 +1,9 @@ package com.darkrockstudios.apps.hammer.common.data.projectstatistics -import com.darkrockstudios.apps.hammer.base.markdown.countWords import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.ProjectScoped import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesRepository import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository import com.darkrockstudios.apps.hammer.common.data.references.ReferenceIndexService @@ -198,10 +196,8 @@ class StatisticsService( sceneCount = sceneCount, ) } - // People only: this drives the "Characters by Appearances" chart. The - // totalEntryConnections count above stays across all entry types. val topAppearances = appearances - .filter { it.type == EntryType.PERSON && it.sceneCount > 0 } + .filter { it.sceneCount > 0 } .sortedByDescending { it.sceneCount } .take(TOP_APPEARANCES_LIMIT) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/WordCount.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/WordCount.kt new file mode 100644 index 000000000..e4efb20bb --- /dev/null +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/projectstatistics/WordCount.kt @@ -0,0 +1,8 @@ +package com.darkrockstudios.apps.hammer.common.data.projectstatistics + +private val whitespaceRun = Regex("""\s+""") + +fun countWords(text: String): Int { + val trimmed = text.trim() + return if (trimmed.isEmpty()) 0 else trimmed.split(whitespaceRun).size +} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/AutoConfirmReferencesUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/AutoConfirmReferencesUseCase.kt index cd2ff7b27..439e54071 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/AutoConfirmReferencesUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/AutoConfirmReferencesUseCase.kt @@ -1,7 +1,6 @@ package com.darkrockstudios.apps.hammer.common.data.references import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import io.github.aakira.napier.Napier @@ -44,6 +43,6 @@ class AutoConfirmReferencesUseCase( ) val newConfirmed = metadata.confirmedReferences + newRefs.map { it.entryId } val newMetadata = metadata.copy(confirmedReferences = newConfirmed) - sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneItem.id, UpdateSource.Repository) + sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneItem.id) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/BackfillEntryReferencesUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/BackfillEntryReferencesUseCase.kt index 4466bc814..85a97f461 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/BackfillEntryReferencesUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/BackfillEntryReferencesUseCase.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.common.data.references -import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContent import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService @@ -41,7 +40,7 @@ class BackfillEntryReferencesUseCase( val newMetadata = metadata.copy( confirmedReferences = metadata.confirmedReferences + entry.id, ) - sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneId, UpdateSource.Repository) + sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneId) } } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/CleanupReferencesOnEntryDeleteUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/CleanupReferencesOnEntryDeleteUseCase.kt index 9cac94607..eb6727513 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/CleanupReferencesOnEntryDeleteUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/CleanupReferencesOnEntryDeleteUseCase.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.common.data.references -import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService /** @@ -44,7 +43,7 @@ class CleanupReferencesOnEntryDeleteUseCase( confirmedReferences = newConfirmed, dismissedReferences = newDismissed, ) - sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneId, UpdateSource.Repository) + sceneEditor.storeMetadata(scrubInvalidReferences(newMetadata), sceneId) } } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/NameMatcher.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/NameMatcher.kt index ce58129b5..aeb592244 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/NameMatcher.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/references/NameMatcher.kt @@ -33,12 +33,10 @@ class WholeWordCaseSensitiveMatcher : NameMatcher { } companion object { - // Reject only adjacent letters/combining marks/digits/underscores in any script; - // punctuation and whitespace are fine on either side. This is more permissive than `\b`, - // which would fail when the name itself starts or ends with a non-word character - // (e.g. an alias "Mr. Smith"). - private const val WORD_CHAR = """[\p{L}\p{M}\p{N}_]""" - private const val NO_WORD_BEFORE = "(? = sceneBuffersLock.withLock { + private fun getDirtyBufferScenes(): List = sceneBuffersLock.withLock { sceneBuffers.filter { it.value.dirty }.map { it.value.content.scene } } @@ -216,18 +216,18 @@ class SceneContentRepository( * Drops the in-memory buffer + temp file and reloads from disk. Returns the reloaded buffer * (so the caller can re-establish a writing baseline), or null if nothing was buffered. */ - fun discardBuffer(sceneItem: SceneItem, scenePath: HPath): SceneBuffer? = - if (dropBuffer(sceneItem)) loadBuffer(sceneItem, scenePath) else null - - /** Drops the in-memory buffer + temp file without reloading. Returns whether one was buffered. */ - fun dropBuffer(sceneItem: SceneItem): Boolean { + fun discardBuffer(sceneItem: SceneItem, scenePath: HPath): SceneBuffer? { val wasPresent = sceneBuffersLock.withLock { val removed = sceneBuffers.remove(sceneItem.id) != null if (removed) _dirtyBufferIds.value = getDirtyBufferIds() removed } - if (wasPresent) clearTempScene(sceneItem) - return wasPresent + return if (wasPresent) { + clearTempScene(sceneItem) + loadBuffer(sceneItem, scenePath) + } else { + null + } } /** Stores all currently-dirty buffers to disk via [persist], one per dirty scene. */ @@ -268,12 +268,10 @@ class SceneContentRepository( } ?: Napier.w("Timed out waiting for temp scene saves on close; forcing shutdown.") } editorScope.cancel("Editor Closed") - // Thar be dragons: a scope can close without the user choosing Save or Discard, and a dirty - // buffer's temp file is the only durable copy of that work. Only clean buffers are cleared. - val dirtyIds = getDirtyBufferIds() - sceneDatasource.getSceneTempBufferContents() - .filterNot { it.scene.id in dirtyIds } - .forEach { clearTempScene(it.scene) } + // During a proper shutdown, we clear any remaining temp buffers that haven't been saved yet + sceneDatasource.getSceneTempBufferContents().forEach { + clearTempScene(it.scene) + } Napier.i("SceneContentRepository Closed.") } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneDatasource.kt index a100e45a2..2f8635891 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneDatasource.kt @@ -10,9 +10,9 @@ import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode import com.darkrockstudios.apps.hammer.common.fileio.HPath import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import com.darkrockstudios.apps.hammer.common.util.ScanBuffers -import com.darkrockstudios.apps.hammer.common.util.readUtf8Into import io.github.aakira.napier.Napier +import kotlinx.atomicfu.locks.SynchronizedObject +import kotlinx.atomicfu.locks.synchronized import okio.FileSystem import okio.IOException import okio.Path @@ -22,11 +22,15 @@ class SceneDatasource( private val fileSystem: FileSystem, ) { - private val scenePathIndex = ScenePathIndex(::scanScenePaths) + // Cached recursive scan of the (non-archived) scenes directory; invalidated on structural mutation. + private val scenePathCacheLock = SynchronizedObject() + private var cachedScenePaths: List? = null - private fun invalidateScenePathCache() = scenePathIndex.invalidate() + private fun invalidateScenePathCache() = synchronized(scenePathCacheLock) { cachedScenePaths = null } - private fun addScenePathToCache(scenePath: HPath) = scenePathIndex.onCreated(scenePath) + private fun addScenePathToCache(scenePath: HPath) = synchronized(scenePathCacheLock) { + cachedScenePaths = cachedScenePaths?.let { (it + scenePath).sortedBy { path -> path.name } } + } fun getSceneDirectory(): HPath = getSceneDirectory(projectDef, fileSystem) @@ -35,28 +39,31 @@ class SceneDatasource( return getSceneIdFromFilename(fileName) } - fun resolveScenePathFromFilesystem(id: Int): HPath? = scenePathIndex.pathFor(id) + fun resolveScenePathFromFilesystem(id: Int, paths: List = getAllScenePaths()): HPath? { + return paths.find { path -> getSceneIdFromPath(path) == id } + } - /** - * Number of scenes/groups directly inside [parentPath]. Directories the scan holds no entry for - * are counted from disk: an empty group reads the same to the index as one it never reached, - * and order numbers are derived from this, so guessing zero would mis-number a real directory. - */ - fun countScenePathsIn(parentPath: HPath): Int = - scenePathIndex.childCountOrNull(parentPath) ?: listChildScenePaths(parentPath).size - - private fun listChildScenePaths(parentPath: HPath): List = - fileSystem.list(parentPath.toOkioPath()).filterScenePathsOkio() + fun getPathFromFilesystem(sceneItem: SceneItem): HPath? { + return getAllScenePathsOkio() + .filterScenePathsOkio().firstOrNull { path -> + sceneItem.id == getSceneFromFilename(path).id + } + } private fun getAllScenePathsOkio(): List = getAllScenePaths().map { it.toOkioPath() } - fun getAllScenePaths(): List = scenePathIndex.paths() - - private fun scanScenePaths(): List = - fileSystem.listRecursively(getSceneDirectory().toOkioPath()) - .filterScenePathsOkio() - .sortedBy { it.name } - .toList() + // Scan runs inside the lock so an invalidation can't interleave between scan and store and + // resurrect a stale list. The scan is blocking, not suspending, so holding the lock is safe. + fun getAllScenePaths(): List = synchronized(scenePathCacheLock) { + cachedScenePaths ?: run { + val sceneDirPath = getSceneDirectory().toOkioPath() + fileSystem.listRecursively(sceneDirPath) + .filterScenePathsOkio() + .sortedBy { it.name } + .toList() + .also { cachedScenePaths = it } + } + } fun getAllScenes(): List { return getAllScenePathsOkio() @@ -187,25 +194,17 @@ class SceneDatasource( return scenePaths } - /** - * Scene paths directly inside [root], keyed by scene id. Two files claiming one id are settled - * the same way [validateScenePaths] and [ScenePathIndex] settle them: the name-first path wins. - * Every id lookup in the codebase must agree, or a pass that rewrites files picks a different - * copy than the one the tree was loaded from and discards the other. - */ fun getGroupChildPathsById(root: HPath): Map { - val byId = LinkedHashMap() - // filterScenePathsOkio sorts by name, so the first path seen for an id is the one it owns. - for (scenePath in getScenePathsFromFilesystem(root)) { - val sceneId = getSceneIdFromPath(scenePath.toHPath()) - if (!byId.containsKey(sceneId)) byId[sceneId] = scenePath.toHPath() - } - return byId + return getScenePathsFromFilesystem(root) + .map { scenePath -> + val sceneId = getSceneIdFromPath(scenePath.toHPath()) + Pair(sceneId, scenePath) + }.associateBy({ it.first }, { it.second.toHPath() }) } fun moveScene(sourcePath: HPath, targetPath: HPath) { fileSystem.atomicMove(sourcePath.toOkioPath(), targetPath.toOkioPath()) - scenePathIndex.invalidate() + invalidateScenePathCache() } fun getSceneBufferDirectory(): HPath { @@ -225,6 +224,13 @@ class SceneDatasource( fun getSceneFilename(path: HPath) = path.toOkioPath().name + fun getLastOrderNumber(parentPath: HPath): Int { + val numScenes = fileSystem.list(parentPath.toOkioPath()) + .filterScenePathsOkio() + .count() + return numScenes + } + fun clearTempScene(sceneItem: SceneItem) { val path = getSceneBufferTempPath(sceneItem).toOkioPath() fileSystem.delete(path) @@ -247,28 +253,6 @@ class SceneDatasource( return content } - /** - * Decodes the scene's Markdown into a buffer from [sink] and returns how many chars it holds, - * so a caller scanning every scene can reuse one buffer instead of taking a string per file. - * Returns 0 for a missing, empty or unreadable scene, and for anything that is not a scene. - */ - fun readSceneMarkdownInto( - sceneItem: SceneItem, - scenePath: HPath, - sink: ScanBuffers, - ): Int { - if (sceneItem.type != SceneItem.Type.Scene) return 0 - val path = scenePath.toOkioPath() - return try { - val byteCount = fileSystem.metadata(path).size ?: return 0 - if (byteCount <= 0L || byteCount > Int.MAX_VALUE) return 0 - fileSystem.read(path) { readUtf8Into(sink, byteCount.toInt()) } - } catch (e: IOException) { - Napier.e("Failed to read Scene markdown (${sceneItem.name})") - 0 - } - } - suspend fun storeSceneMarkdownRaw(sceneItem: SceneContent, scenePath: HPath): Boolean { sceneItem.markdown ?: return false @@ -295,14 +279,11 @@ class SceneDatasource( } } - /** - * The highest order number in use directly inside [parentPath]. Orders are a contiguous - * 0-based sequence, so a directory of N children tops out at N-1. Both the order given to the - * next child and the width of the zero-padded order field must derive from this, never from - * the raw child count: at a power of ten the two disagree, and the names on disk stop matching - * the ones [SceneRepository.getSceneFilePath] computes to read them back. - */ - fun countScenes(parentPath: HPath): Int = countScenePathsIn(parentPath) - 1 + fun countScenes(parentPath: HPath): Int { + return fileSystem.list(parentPath.toOkioPath()) + .filterScenePathsOkio() + .count() - 1 + } fun storeTempSceneBuffer(buffer: SceneBuffer): Boolean { val scenePath = getSceneBufferTempPath(buffer.content.scene).toOkioPath() @@ -564,7 +545,7 @@ class SceneDatasource( } } -internal fun Path.isInArchivedDirectory(): Boolean { +private fun Path.isInArchivedDirectory(): Boolean { val pathStr = this.toString() return pathStr.contains("${Path.DIRECTORY_SEPARATOR}${SceneDatasource.ARCHIVED_DIRECTORY}${Path.DIRECTORY_SEPARATOR}") || pathStr.contains("${Path.DIRECTORY_SEPARATOR}${SceneDatasource.ARCHIVED_DIRECTORY}") && this.parent?.name == SceneDatasource.ARCHIVED_DIRECTORY diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneEditorService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneEditorService.kt index a2c4d7d4a..74c3492df 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneEditorService.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneEditorService.kt @@ -118,8 +118,6 @@ class SceneEditorService( statisticsRepository.markDirty() referenceIndexRepository.markSceneDeleted(scene.id) writingSessionTracker.forgetBaseline(scene.id) - // A leftover temp file would attach itself to a later scene that reuses this id. - sceneContentRepository.dropBuffer(scene) } return deleted } @@ -150,14 +148,9 @@ class SceneEditorService( /** * Orchestrates a scene-metadata write: mark the scene's current identity for sync, persist * via [SceneMetadataRepository], then apply the reference-index delta if the confirmed set - * changed. The repo handles only the pure persist + flow emission. A write applying server - * state ([UpdateSource.Sync]) is not a local change, so it is not marked. + * changed. The repo handles only the pure persist + flow emission. */ - suspend fun storeMetadata( - metadata: SceneMetadata, - sceneId: Int, - source: UpdateSource = UpdateSource.Editor, - ) { + suspend fun storeMetadata(metadata: SceneMetadata, sceneId: Int) { // A flush can arrive after the scene was deleted (e.g. the metadata panel's save on // destroy). Nothing to persist for a scene that no longer exists. val scene = sceneEditorRepository.getSceneItemFromIdIncludingArchived(sceneId) @@ -165,8 +158,8 @@ class SceneEditorService( val previous = sceneMetadataRepository.loadRawMetadata(sceneId) - if (source != UpdateSource.Sync) sceneEditorRepository.markSceneForSynchronization(scene) - sceneMetadataRepository.storeMetadata(metadata, sceneId, source) + sceneEditorRepository.markSceneForSynchronization(scene) + sceneMetadataRepository.storeMetadata(metadata, sceneId) val previousConfirmed = previous?.confirmedReferences.orEmpty() val newConfirmed = metadata.confirmedReferences @@ -190,21 +183,9 @@ class SceneEditorService( return false } - // Outside the active tree an archived scene still has its file; a deleted one has nowhere to save. - val scenePath = if (sceneEditorRepository.getSceneItemFromId(sceneItem.id) != null) { - sceneEditorRepository.resolveSceneContentPath(sceneItem) - } else { - sceneEditorRepository.resolveScenePathFromFilesystemIncludingArchived(sceneItem.id) - } - if (scenePath == null) { - Napier.w { "Dropping buffer for scene ${sceneItem.id}, it no longer exists" } - sceneContentRepository.dropBuffer(sceneItem) - writingSessionTracker.forgetBaseline(sceneItem.id) - return false - } - sceneEditorRepository.markSceneForSynchronization(sceneItem) + val scenePath = sceneEditorRepository.getSceneFilePath(sceneItem) val success = sceneContentRepository.persistBuffer(buffer, scenePath) if (success) { @@ -227,24 +208,13 @@ class SceneEditorService( } fun discardSceneBuffer(sceneDef: SceneItem) { - // An archived or deleted scene has no active path to reload from. - if (sceneEditorRepository.getSceneItemFromId(sceneDef.id) == null) { - sceneContentRepository.dropBuffer(sceneDef) - writingSessionTracker.forgetBaseline(sceneDef.id) - return - } - val scenePath = sceneEditorRepository.resolveSceneContentPath(sceneDef) + val scenePath = sceneEditorRepository.getSceneFilePath(sceneDef) val reloaded = sceneContentRepository.discardBuffer(sceneDef, scenePath) if (reloaded != null) { writingSessionTracker.rememberBaseline(sceneDef.id, reloaded.content.coerceMarkdown()) } } - /** Reverts every dirty buffer to its on-disk content. */ - fun discardAllBuffers() { - sceneContentRepository.getDirtyBufferScenes().forEach { discardSceneBuffer(it) } - } - fun onContentChanged(content: SceneContent, source: UpdateSource) = sceneContentRepository.onContentChanged(content, source) @@ -269,7 +239,7 @@ class SceneEditorService( ) { tree, dirtyBufferIds -> SceneSummary(tree, dirtyBufferIds) } .shareIn(serviceScope, SharingStarted.Eagerly, replay = 1) - val metadataUpdateFlow: SharedFlow + val metadataUpdateFlow: SharedFlow> get() = sceneMetadataRepository.metadataUpdateFlow fun getSceneSummaries(): SceneSummary = SceneSummary( @@ -322,7 +292,7 @@ class SceneEditorService( val cached = sceneContentRepository.getSceneBuffer(sceneItem) if (cached != null) return cached - val scenePath = sceneEditorRepository.resolveSceneContentPath(sceneItem) + val scenePath = sceneEditorRepository.getSceneFilePath(sceneItem) val buffer = sceneContentRepository.loadBuffer(sceneItem, scenePath) writingSessionTracker.rememberBaseline(sceneItem.id, buffer.content.coerceMarkdown()) return buffer @@ -339,15 +309,6 @@ class SceneEditorService( suspend fun loadSceneMetadata(sceneId: Int): SceneMetadata = sceneMetadataRepository.loadSceneMetadata(sceneId) - /** - * The scene's live text (unsaved buffer first, then disk) with no caching and no - * writing-session baseline. Call off the main thread. - */ - fun getCurrentSceneContentOrNull(sceneItem: SceneItem): String? = - runCatching { sceneContentRepository.getCurrentSceneContent(sceneItem) } - .onFailure { Napier.w(it) { "Failed to read content for scene: ${sceneItem.id}" } } - .getOrNull() - fun loadSceneMarkdownRaw(sceneItem: SceneItem, scenePath: HPath? = null): String = if (scenePath != null) { sceneEditorRepository.loadSceneMarkdownRaw(sceneItem, scenePath) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneMetadataRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneMetadataRepository.kt index d9e2cd0c1..b902efc8b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneMetadataRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneMetadataRepository.kt @@ -3,7 +3,6 @@ package com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadataDatasource @@ -15,12 +14,6 @@ import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.first import kotlin.time.Clock -data class SceneMetadataUpdate( - val sceneId: Int, - val metadata: SceneMetadata, - val source: UpdateSource, -) - /** * Owns scene metadata (per-scene outline/notes/draft/references/timestamps) and the project * metadata. @@ -43,11 +36,11 @@ class SceneMetadataRepository( onBufferOverflow = BufferOverflow.DROP_OLDEST ) - private val _metadataUpdateFlow = MutableSharedFlow( + private val _metadataUpdateFlow = MutableSharedFlow>( extraBufferCapacity = 8, onBufferOverflow = BufferOverflow.DROP_OLDEST ) - val metadataUpdateFlow: SharedFlow = _metadataUpdateFlow + val metadataUpdateFlow: SharedFlow> = _metadataUpdateFlow /** Loads and caches the project metadata. Must be called once during project-scope init. */ suspend fun initialize() { @@ -76,13 +69,9 @@ class SceneMetadataRepository( * Pure persist + emit. Sync-marking and reference-index delta are the caller's concern * (see [SceneEditorService.storeMetadata]). */ - suspend fun storeMetadata( - metadata: SceneMetadata, - sceneId: Int, - source: UpdateSource = UpdateSource.Editor, - ) { + suspend fun storeMetadata(metadata: SceneMetadata, sceneId: Int) { sceneMetadataDatasource.storeMetadata(metadata, sceneId) - _metadataUpdateFlow.tryEmit(SceneMetadataUpdate(sceneId, metadata, source)) + _metadataUpdateFlow.tryEmit(sceneId to metadata) } /** Stamp a scene's last-edited timestamp (backfilling `created` for older scenes). */ @@ -97,6 +86,6 @@ class SceneMetadataRepository( ) sceneMetadataDatasource.storeMetadata(updated, sceneId) // Refresh open editors so their snapshot has the new timestamps. - _metadataUpdateFlow.tryEmit(SceneMetadataUpdate(sceneId, updated, UpdateSource.Editor)) + _metadataUpdateFlow.tryEmit(sceneId to updated) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/ScenePathIndex.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/ScenePathIndex.kt deleted file mode 100644 index c841f5d24..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/ScenePathIndex.kt +++ /dev/null @@ -1,118 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository - -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import kotlinx.atomicfu.locks.SynchronizedObject -import kotlinx.atomicfu.locks.synchronized -import okio.Path - -/** - * A cached view of the scene files on disk, backed by one recursive [scan]. Everything a caller can - * ask is derived from that scan: the name-ordered path list, the path owning a scene id, and how - * many scenes sit directly inside a directory. - * - * Invariants, all maintained under one lock: - * - Paths are ordered by file name, matching what the scan produces. - * - A scene id maps to the name-first path claiming it, which is how duplicate ids are settled. - * - A directory's count is the number of cached paths whose parent it is. - * - * A new file is absorbed in place, since it cannot change any of those answers for a file already - * held. Every other change drops the cache and the next read re-scans, so callers that rename in a - * loop should read what they need before it, not inside it. - */ -internal class ScenePathIndex(private val scan: () -> List) { - - private val lock = SynchronizedObject() - - private var paths: List? = null - private var pathsById: MutableMap? = null - private var childCounts: MutableMap? = null - - fun paths(): List = synchronized(lock) { pathsLocked() } - - fun pathFor(id: Int): HPath? = synchronized(lock) { pathsByIdLocked()[id] } - - /** - * Number of scenes and groups directly inside [parent], or null when the scan holds no entry - * for that directory. Null means unknown, not empty: a directory the scan never reached is - * indistinguishable here from one that is genuinely empty, and only the caller can tell them - * apart by looking at the disk. - */ - fun childCountOrNull(parent: HPath): Int? = synchronized(lock) { - childCountsLocked()[parent.toOkioPath()] - } - - fun invalidate() = synchronized(lock) { invalidateLocked() } - - fun onCreated(scenePath: HPath) = synchronized(lock) { - val current = paths ?: return@synchronized - paths = current.withPathInserted(scenePath) - - pathsById?.let { byId -> - val id = sceneIdOf(scenePath) - val owner = byId[id] - if (owner == null || scenePath.name < owner.name) byId[id] = scenePath - } - childCounts?.let { counts -> counts.increment(scenePath.toOkioPath().parent) } - } - - // region Locked internals - - private fun invalidateLocked() { - paths = null - pathsById = null - childCounts = null - } - - private fun pathsLocked(): List = paths ?: scan().also { paths = it } - - private fun pathsByIdLocked(): Map { - pathsById?.let { return it } - - val byId = HashMap() - // The scan is name-ordered, so the first path seen for an id is the one that owns it. - for (path in pathsLocked()) { - val id = sceneIdOf(path) - if (!byId.containsKey(id)) byId[id] = path - } - return byId.also { pathsById = it } - } - - private fun childCountsLocked(): MutableMap { - childCounts?.let { return it } - - val counts = HashMap() - for (path in pathsLocked()) counts.increment(path.toOkioPath().parent) - return counts.also { childCounts = it } - } - - // endregion - - private fun sceneIdOf(path: HPath): Int = - SceneDatasource.getSceneIdFromFilename(path.toOkioPath().name) -} - -private fun MutableMap.increment(parent: Path?) { - if (parent != null) this[parent] = (this[parent] ?: 0) + 1 -} - -/** Inserts in name order, so the list never has to be re-sorted. */ -private fun List.withPathInserted(path: HPath): List { - val at = upperBoundByName(path.name) - return buildList(size + 1) { - addAll(this@withPathInserted.subList(0, at)) - add(path) - addAll(this@withPathInserted.subList(at, this@withPathInserted.size)) - } -} - -/** Index just past the last path whose name is `<= name`. */ -private fun List.upperBoundByName(name: String): Int { - var low = 0 - var high = size - while (low < high) { - val mid = (low + high) ushr 1 - if (this[mid].name <= name) low = mid + 1 else high = mid - } - return low -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneRepository.kt index 5245cbb81..abab7ab31 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sceneeditorrepository/SceneRepository.kt @@ -11,7 +11,6 @@ import com.darkrockstudios.apps.hammer.common.data.tree.Tree import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.util.ScanBuffers import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath import com.darkrockstudios.apps.hammer.common.util.numDigits @@ -156,47 +155,24 @@ class SceneRepository( val parentPath = resolveParentPathFromFilesystem(parentId) val orderDigits = if (isNewScene && willNextSceneIncreaseMagnitude(parentId)) { - sceneDatasource.countScenes(parentPath).numDigits() + 1 + sceneDatasource.getLastOrderNumber(parentPath).numDigits() + 1 } else { - sceneDatasource.countScenes(parentPath).numDigits() + sceneDatasource.getLastOrderNumber(parentPath).numDigits() } - return sceneFileName(sceneDef, orderDigits) - } - - /** The `order~name~id` filename itself, given how wide the order field is in its directory. */ - private fun sceneFileName(sceneDef: SceneItem, orderDigits: Int): String { val order = sceneDef.order.toString().padStart(orderDigits, '0') val delim = ProjectsRepository.FILENAME_DELIMITER val encodedName = ProjectsRepository.encodeForFilename(sceneDef.name) val bareName = "$order$delim$encodedName$delim${sceneDef.id}" - return if (sceneDef.type == SceneItem.Type.Scene) { + val filename = if (sceneDef.type == SceneItem.Type.Scene) { "$bareName${SceneDatasource.SCENE_FILENAME_EXTENSION}" } else { bareName } + return filename } - /** How wide the order field is for items directly inside [parentPath]. */ - private fun orderDigitsIn(parentPath: HPath): Int = - sceneDatasource.countScenes(parentPath).numDigits() - - /** - * Where [sceneItem]'s content actually sits. Resolved by id from disk, falling back to the - * computed name only for a scene that has no file yet. Reading or writing content through a - * recomputed name lets any disagreement between the tree and disk silently retarget the - * operation: reads land on nothing and come back empty, writes create a rival file. - */ - fun resolveSceneContentPath(sceneItem: SceneItem): HPath = - sceneDatasource.resolveScenePathFromFilesystem(sceneItem.id) ?: getSceneFilePath(sceneItem) - - /** The path of [child] directly inside [parentPath], given the order field width there. */ - private fun childScenePath(parentPath: HPath, child: SceneItem, orderDigits: Int): HPath = - parentPath.toOkioPath() - .div(sceneFileName(child, orderDigits)) - .toHPath() - fun getSceneItemFromId(id: Int): SceneItem? { return sceneTree.findValueOrNull { it.id == id } } @@ -370,12 +346,11 @@ class SceneRepository( ?: error("Could not find parent on filesystem: ${parent.value.id}") } val existingSceneFiles = sceneDatasource.getGroupChildPathsById(parentPath) - val orderDigits = orderDigitsIn(parentPath) parent.children().forEach { childNode -> val existingPath = existingSceneFiles[childNode.value.id] ?: error("Scene wasn't present in directory") - val newPath = childScenePath(parentPath, childNode.value, orderDigits) + val newPath = getSceneFilePath(childNode.value.id) if (existingPath != newPath) { try { @@ -514,16 +489,12 @@ class SceneRepository( null } - // Renaming siblings changes none of this, so it is read once rather than per child. That - // also keeps the loop off the path cache, so the renames cost one re-scan between them all. - val orderDigits = orderDigitsIn(parentPath) - parent.children().forEachIndexed { index, childNode -> childNode.value = childNode.value.copy(order = index) val existingPath = existingSceneFiles[childNode.value.id] ?: error("Scene wasn't present in directory") - val newPath = childScenePath(parentPath, childNode.value, orderDigits) + val newPath = getSceneFilePath(childNode.value.id) if (existingPath != newPath) { try { @@ -574,42 +545,25 @@ class SceneRepository( */ fun rationalizeTree() { correctSceneOrders() - rationalizeChildren(sceneTree.root(), sceneDatasource.getSceneDirectory()) - } - /** - * Recursively moves [parentNode]'s children to their intended paths. Order padding is the - * width of the highest order among the children present on disk, computed once per directory: - * it is immune to the moves below changing the directory's live count, and it matches the - * padding [getSceneFilePath] derives once the directory holds exactly these children. Parents - * are finalized before their children so every destination directory exists. - */ - private fun rationalizeChildren(parentNode: TreeNode, parentPath: HPath) { - // Children already inside this directory, snapshotted once: a sibling's rename never - // relocates another sibling's file, so each entry stays valid until its own move. - // Children arriving from elsewhere fall back to a live resolve. - val childPathsInDir = sceneDatasource.getGroupChildPathsById(parentPath) + sceneTree.forEach { node -> + if (node.value.type == SceneItem.Type.Root) return@forEach - val children = parentNode.children() - val presentCount = children.count { node -> - childPathsInDir.containsKey(node.value.id) || - sceneDatasource.resolveScenePathFromFilesystem(node.value.id) != null - } - val orderDigits = (presentCount - 1).numDigits() + val intendedPath = getSceneFilePath(node.value.id) - children.forEach { node -> - val intendedPath = childScenePath(parentPath, node.value, orderDigits) + val allPaths = sceneDatasource.getAllScenePaths() + val realPath = allPaths.find { path -> + val scene = sceneDatasource.getSceneFromPath(path) + scene.id == node.value.id + } - val realPath = childPathsInDir[node.value.id] - ?: sceneDatasource.resolveScenePathFromFilesystem(node.value.id) if (realPath != null) { if (realPath != intendedPath) { Napier.i { "Moving scene to new path: ${intendedPath.path} from old path: ${realPath.path}" } sceneDatasource.moveScene(realPath, intendedPath) - } - - if (node.value.type == SceneItem.Type.Group) { - rationalizeChildren(node, intendedPath) + } else { + // Too chatty, don't need it + //Napier.d { "Scene ${node.value.id} is in the correct location" } } } else { Napier.e { "Scene ${node.value.id} is missing from the filesystem" } @@ -783,27 +737,16 @@ class SceneRepository( */ fun loadSceneMarkdownRaw( sceneItem: SceneItem, - scenePath: HPath = resolveSceneContentPath(sceneItem) + scenePath: HPath = getSceneFilePath(sceneItem) ): String = sceneDatasource.loadSceneMarkdownRaw(sceneItem, scenePath) - /** - * Reads the scene's Markdown into a caller-owned buffer and returns its length in chars. Global - * search scans every scene on each keystroke, so it reuses one buffer rather than taking a - * string per file. - */ - fun readSceneMarkdownInto( - sceneItem: SceneItem, - sink: ScanBuffers, - scenePath: HPath = resolveSceneContentPath(sceneItem), - ): Int = sceneDatasource.readSceneMarkdownInto(sceneItem, scenePath, sink) - /** * This should only be used for server syncing */ suspend fun storeSceneMarkdownRaw( sceneItem: SceneContent, - scenePath: HPath = resolveSceneContentPath(sceneItem.scene) + scenePath: HPath = getSceneFilePath(sceneItem.scene) ): Boolean { markForSynchronization(sceneItem.scene) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapes.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapes.kt deleted file mode 100644 index cbd55bbf8..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapes.kt +++ /dev/null @@ -1,31 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -private const val ASCII_PUNCTUATION = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~" - -/** - * Resolves CommonMark backslash escapes (`\*` becomes `*`) to their bare ASCII punctuation, so text - * reads the way it does on screen rather than the way it is stored. Allocates only when [text] - * actually holds a backslash. - * - * Escapes are resolved everywhere, including inside code spans and fenced blocks where CommonMark - * keeps them literal. Telling those apart needs a parser, and no marker is added or removed either - * way, so the text is never rewritten beyond dropping a backslash. - */ -fun unescapeMarkdown(text: CharSequence): String { - if (!text.contains('\\')) return text.toString() - - val sb = StringBuilder(text.length) - var i = 0 - while (i < text.length) { - val c = text[i] - val next = if (i + 1 < text.length) text[i + 1] else null - if (c == '\\' && next != null && next in ASCII_PUNCTUATION) { - sb.append(next) - i += 2 - } else { - sb.append(c) - i++ - } - } - return sb.toString() -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjection.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjection.kt deleted file mode 100644 index 140e16b8f..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjection.kt +++ /dev/null @@ -1,58 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -/** - * Flattens stored Markdown into the prose a reader sees. Backslash escapes resolve to their literal - * character (`well\-known` becomes `well-known`), paired emphasis and code delimiters are dropped - * (`**Chapter** One` becomes `Chapter One`), and leading blockquote, heading and bullet markers are - * removed from each line. - * - * Delimiters pair only within a paragraph, and only where CommonMark's flanking rules allow, so - * literal markers survive: `user_name`, `2 * 3`, a bare `***` divider and a stray apostrophe-backtick - * are all left intact. - * - * Link and image syntax is left as written. Punctuation is tested against ASCII only, and escapes - * resolve inside code spans as well as outside them. - * - * Scanning a whole project repeatedly wants [MarkdownProjector] instead: this convenience builds a - * workspace per call, where the projector reuses one across every document in a scan. - */ -fun projectMarkdownToPlainText(markdown: String): String { - if (!containsMarkdownSyntax(markdown)) return markdown - val projector = MarkdownProjector(markdown.length) - projector.project(markdown) - return projector.projected() -} - -/** - * The prose title for [markdown]: the first non-blank line of its projection. Falls back to the raw - * first line when the projection of it is blank, so a marker-only line still yields a title rather - * than reading as an empty document. - */ -fun markdownTitleLine(markdown: String): String { - if (!containsMarkdownSyntax(markdown)) { - return markdown.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() - } - val projector = MarkdownProjector(markdown.length) - projector.project(markdown) - val title = projector.firstNonBlankLine() - if (title.isNotEmpty()) return title - return markdown.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() -} - -/** - * True when [text] holds a character the projection can remove. Text without one projects to itself, - * so the scan can be skipped entirely. - */ -internal fun containsMarkdownSyntax(text: CharSequence): Boolean { - var i = 0 - while (i < text.length) { - val c = text[i] - if (c == '*' || c == '_' || c == '`' || - c == '\\' || c == '#' || c == '>' || c == '-' || c == '+' - ) { - return true - } - i++ - } - return false -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjector.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjector.kt deleted file mode 100644 index 926243999..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjector.kt +++ /dev/null @@ -1,471 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import com.darkrockstudios.apps.hammer.common.util.ScanBuffers - -private const val FLAG_CAN_OPEN = 1 -private const val FLAG_CAN_CLOSE = 2 -private const val FLAG_INERT = 4 - -private const val INITIAL_OUT = 8 * 1024 -private const val INITIAL_RUNS = 256 -private const val MIN_RUNS = 16 - -/** - * CommonMark's ASCII punctuation set, as the four contiguous ranges it actually is. Tested once per - * character of every document scanned, so the ranges beat a membership scan over a 32-char string. - */ -internal fun Char.isAsciiPunctuation(): Boolean = - this in '!'..'/' || - this in ':'..'@' || - this in '['..'`' || - this in '{'..'~' - -private fun Char.isDelimiterChar(): Boolean = this == '*' || this == '_' || this == '`' - -private fun Char.isSpaceOrTabChar(): Boolean = this == ' ' || this == '\t' - -/** - * A reusable workspace for [projectMarkdownToPlainText]'s scan. Every buffer grows to the largest - * document it has seen and is then reused, so scanning a project a second time allocates nothing: - * the delimiter runs live in parallel primitive arrays rather than objects, and the projected prose - * lands in a char buffer that is matched against in place rather than being turned into a String. - * - * Not thread safe. A concurrent scan needs its own instance. - */ -class MarkdownProjector(initialCapacity: Int = INITIAL_OUT) : ScanBuffers { - - /** - * The source is copied in and then indexed as a flat array: the scan and the render each walk - * every character, and going through `CharSequence` would pay an interface call on both passes. - */ - private var src = CharArray(initialCapacity) - private var srcLength = 0 - - private var rawBytes = ByteArray(0) - - /** The projection only ever deletes, so it can never outgrow the source it came from. */ - private var out = CharArray(initialCapacity) - private var outLength = 0 - - /** - * Sized from the document rather than a fixed floor, so projecting one short note does not pay - * for a novel's worth of run slots. Grows to whatever the widest document actually needs. - */ - private val initialRuns = (initialCapacity / 32).coerceIn(MIN_RUNS, INITIAL_RUNS) - - private var runChar = CharArray(initialRuns) - private var runStart = IntArray(initialRuns) - private var runEnd = IntArray(initialRuns) - private var runParagraph = IntArray(initialRuns) - private var runDropFront = IntArray(initialRuns) - private var runDropBack = IntArray(initialRuns) - private var runFlags = IntArray(initialRuns) - private var runCount = 0 - - private var openStack = IntArray(initialRuns) - private var openCount = 0 - - /** Length of the projected prose currently held in the buffer. */ - val length: Int get() = outLength - - operator fun get(index: Int): Char = out[index] - - /** - * Projects [source] into this workspace and returns the projected length. The result stays valid - * until the next call. - */ - fun project(source: CharSequence): Int { - val length = source.length - ensureSource(length) - var i = 0 - while (i < length) { - src[i] = source[i] - i++ - } - return projectSource(length) - } - - /** - * The source buffer, grown to hold at least [minCapacity] characters. Fill it directly and then - * call [projectSource] to skip copying the document in at all. - */ - fun sourceBuffer(minCapacity: Int): CharArray { - ensureSource(minCapacity) - return src - } - - override fun charBuffer(minCapacity: Int): CharArray = sourceBuffer(minCapacity) - - /** Scratch for the raw bytes of a document being read in, before they are decoded into [src]. */ - override fun byteBuffer(minCapacity: Int): ByteArray { - if (rawBytes.size < minCapacity) rawBytes = ByteArray(minCapacity) - return rawBytes - } - - /** Projects the first [length] characters already sitting in [sourceBuffer]. */ - fun projectSource(length: Int): Int { - srcLength = length - outLength = 0 - ensureOut(length) - scanDelimiterRuns() - resolveCodeSpans() - resolveEmphasis() - render() - return outLength - } - - /** - * Index of [query] in the projected prose, or -1. Compares against the buffer directly so a scan - * that finds nothing never builds a string. - */ - fun indexOf(query: String, ignoreCase: Boolean = true): Int { - val queryLength = query.length - if (queryLength == 0 || queryLength > outLength) return -1 - val buffer = out - val first = query[0] - val last = outLength - queryLength - var i = 0 - outer@ while (i <= last) { - if (!buffer[i].equals(first, ignoreCase)) { - i++ - continue - } - var j = 1 - while (j < queryLength) { - if (!buffer[i + j].equals(query[j], ignoreCase)) { - i++ - continue@outer - } - j++ - } - return i - } - return -1 - } - - /** The projected prose as a String. Allocates, so reserve it for a hit. */ - fun substring(startIndex: Int, endIndex: Int): String { - val from = startIndex.coerceIn(0, outLength) - val to = endIndex.coerceIn(from, outLength) - return out.concatToString(from, to) - } - - fun projected(): String = substring(0, outLength) - - /** - * Up to [maxChars] of the projection with runs of whitespace collapsed to a single space, and an - * ellipsis when prose remained. Walks the buffer, so previewing never materializes the whole - * document just to throw most of it away. - */ - fun collapsedPreview(maxChars: Int): String { - val sb = StringBuilder(maxChars + 1) - var i = 0 - var pendingSpace = false - while (i < outLength && sb.length <= maxChars) { - val c = out[i] - if (c.isWhitespace()) { - if (sb.isNotEmpty()) pendingSpace = true - } else { - if (pendingSpace) { - sb.append(' ') - pendingSpace = false - } - sb.append(c) - } - i++ - } - // Anything left that is not whitespace means the preview is a truncation, not the whole text. - var more = false - while (i < outLength) { - if (!out[i].isWhitespace()) { - more = true - break - } - i++ - } - if (sb.length > maxChars || more) { - while (sb.length > maxChars) sb.deleteAt(sb.length - 1) - while (sb.isNotEmpty() && sb.last().isWhitespace()) sb.deleteAt(sb.length - 1) - sb.append('…') - } - return sb.toString() - } - - /** The first non-blank line of the projection, or "" when every line is blank. */ - fun firstNonBlankLine(): String { - var i = 0 - while (i < outLength) { - var end = i - while (end < outLength && out[end] != '\n') end++ - var start = i - while (start < end && out[start].isWhitespace()) start++ - var stop = end - while (stop > start && out[stop - 1].isWhitespace()) stop-- - if (stop > start) return out.concatToString(start, stop) - i = end + 1 - } - return "" - } - - private fun ensureSource(needed: Int) { - if (src.size < needed) src = CharArray(needed) - } - - private fun ensureOut(needed: Int) { - if (out.size < needed) out = CharArray(needed) - } - - private fun ensureRuns(needed: Int) { - if (runChar.size >= needed) return - val size = needed * 2 - runChar = runChar.copyOf(size) - runStart = runStart.copyOf(size) - runEnd = runEnd.copyOf(size) - runParagraph = runParagraph.copyOf(size) - runDropFront = runDropFront.copyOf(size) - runDropBack = runDropBack.copyOf(size) - runFlags = runFlags.copyOf(size) - openStack = openStack.copyOf(size) - } - - private fun available(run: Int): Int = - runEnd[run] - runStart[run] - runDropFront[run] - runDropBack[run] - - private fun addRun(char: Char, start: Int, end: Int, paragraph: Int, flags: Int) { - ensureRuns(runCount + 1) - runChar[runCount] = char - runStart[runCount] = start - runEnd[runCount] = end - runParagraph[runCount] = paragraph - runDropFront[runCount] = 0 - runDropBack[runCount] = 0 - runFlags[runCount] = flags - runCount++ - } - - private fun isBlankOrEdge(index: Int): Boolean = - index < 0 || index >= srcLength || src[index].isWhitespace() - - private fun isPunctuationAt(index: Int): Boolean = - index >= 0 && index < srcLength && src[index].isAsciiPunctuation() - - private fun scanDelimiterRuns() { - runCount = 0 - val length = srcLength - var i = 0 - var paragraph = 0 - while (i < length) { - val c = src[i] - if (c == '\\' && i + 1 < length && src[i + 1].isAsciiPunctuation()) { - i += 2 - continue - } - if (c == '\n') { - var k = i + 1 - while (k < length && (src[k].isSpaceOrTabChar() || src[k] == '\r')) k++ - if (k >= length || src[k] == '\n') paragraph++ - i++ - continue - } - if (!c.isDelimiterChar()) { - i++ - continue - } - - val start = i - var end = start + 1 - while (end < length && src[end] == c) end++ - i = end - - var canOpen = true - var canClose = true - if (c != '`') { - val prevBlank = isBlankOrEdge(start - 1) - val nextBlank = isBlankOrEdge(end) - val prevPunct = isPunctuationAt(start - 1) - val nextPunct = isPunctuationAt(end) - val leftFlanking = !nextBlank && (!nextPunct || prevBlank || prevPunct) - val rightFlanking = !prevBlank && (!prevPunct || nextBlank || nextPunct) - if (c == '*') { - canOpen = leftFlanking - canClose = rightFlanking - } else { - // Underscores cannot delimit emphasis inside a word, which is what saves `user_name`. - canOpen = leftFlanking && (!rightFlanking || prevPunct) - canClose = rightFlanking && (!leftFlanking || nextPunct) - } - // A run that can do neither is literal text; leaving it out keeps it out of the render. - if (!canOpen && !canClose) continue - } - - var flags = 0 - if (canOpen) flags = flags or FLAG_CAN_OPEN - if (canClose) flags = flags or FLAG_CAN_CLOSE - addRun(c, start, end, paragraph, flags) - } - } - - /** Code spans bind tighter than emphasis, so they claim their delimiters first. */ - private fun resolveCodeSpans() { - var i = 0 - while (i < runCount) { - if (runChar[i] != '`') { - i++ - continue - } - - val width = runEnd[i] - runStart[i] - var j = i + 1 - var closer = -1 - while (j < runCount && runParagraph[j] == runParagraph[i]) { - if (runChar[j] == '`' && runEnd[j] - runStart[j] == width) { - closer = j - break - } - j++ - } - if (closer < 0) { - i++ - continue - } - - runDropBack[i] = width - runDropFront[closer] = width - for (k in i + 1 until closer) runFlags[k] = runFlags[k] or FLAG_INERT - i = closer + 1 - } - } - - private fun resolveEmphasis() { - openCount = 0 - var paragraph = -1 - for (run in 0 until runCount) { - if (runParagraph[run] != paragraph) { - openCount = 0 - paragraph = runParagraph[run] - } - if (runChar[run] == '`' || runFlags[run] and FLAG_INERT != 0) continue - - if (runFlags[run] and FLAG_CAN_CLOSE != 0) { - while (available(run) > 0) { - var openerSlot = -1 - var s = openCount - 1 - while (s >= 0) { - if (runChar[openStack[s]] == runChar[run]) { - openerSlot = s - break - } - s-- - } - if (openerSlot < 0) break - - val opener = openStack[openerSlot] - val consumed = minOf(available(run), available(opener)) - runDropBack[opener] += consumed - runDropFront[run] += consumed - - // Anything stacked above the matched opener can never close now. - openCount = openerSlot - if (available(opener) > 0) pushOpen(opener) - } - } - if (available(run) > 0 && runFlags[run] and FLAG_CAN_OPEN != 0) pushOpen(run) - } - } - - private fun pushOpen(run: Int) { - ensureRuns(openCount + 1) - openStack[openCount] = run - openCount++ - } - - /** - * The offset after any blockquote, heading or bullet marker opening the line at [start], or - * [start] itself when the line opens with prose. Ordered-list markers are left alone: a single - * line cannot distinguish "1. Draft opening" from "1984. The year everything changed". - */ - private fun skipBlockPrefix(start: Int): Int { - val length = srcLength - var i = start - var found = false - - while (i < length && src[i].isSpaceOrTabChar()) i++ - - while (i < length && src[i] == '>') { - i++ - found = true - while (i < length && src[i].isSpaceOrTabChar()) i++ - } - - if (i < length && src[i] == '#') { - var j = i - var hashes = 0 - while (j < length && src[j] == '#') { - j++ - hashes++ - } - if (hashes <= 6 && j < length && src[j].isSpaceOrTabChar()) { - i = j - found = true - } - } else if (i < length && (src[i] == '-' || src[i] == '*' || src[i] == '+')) { - if (i + 1 < length && src[i + 1].isSpaceOrTabChar()) { - i++ - found = true - } - } - - if (!found) return start - while (i < length && src[i].isSpaceOrTabChar()) i++ - return i - } - - private fun appendOut(c: Char) { - out[outLength] = c - outLength++ - } - - private fun appendOut(from: Int, to: Int) { - var i = from - while (i < to) { - out[outLength] = src[i] - outLength++ - i++ - } - } - - private fun render() { - val length = srcLength - var i = 0 - var r = 0 - var atLineStart = true - while (i < length) { - if (atLineStart) { - atLineStart = false - val afterPrefix = skipBlockPrefix(i) - if (afterPrefix > i) { - i = afterPrefix - while (r < runCount && runStart[r] < i) r++ - continue - } - } - - if (r < runCount && i == runStart[r]) { - appendOut(runStart[r] + runDropFront[r], runEnd[r] - runDropBack[r]) - i = runEnd[r] - r++ - continue - } - - val c = src[i] - if (c == '\n') atLineStart = true - if (c == '\\' && i + 1 < length && src[i + 1].isAsciiPunctuation()) { - appendOut(src[i + 1]) - i += 2 - } else { - appendOut(c) - i++ - } - } - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorPool.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorPool.kt deleted file mode 100644 index 95f93fcee..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorPool.kt +++ /dev/null @@ -1,31 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock - -private const val MAX_RETAINED = 8 - -/** - * Lends [MarkdownProjector]s to concurrent scans and keeps them afterwards, so the buffers a scan - * grew are still there for the next keystroke rather than being rebuilt from scratch. - * - * A projector cannot be a plain field on the use case: cancelling a search is cooperative, so the - * outgoing scan can still be running when the next one starts, and the two would share a buffer. - * Borrowing serializes that without forcing the scans themselves to run one at a time. - */ -class MarkdownProjectorPool { - - private val mutex = Mutex() - private val available = mutableListOf() - - suspend fun borrow(block: suspend (MarkdownProjector) -> T): T { - val projector = mutex.withLock { available.removeLastOrNull() } ?: MarkdownProjector() - try { - return block(projector) - } finally { - mutex.withLock { - if (available.size < MAX_RETAINED) available.add(projector) - } - } - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/SearchQuery.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/SearchQuery.kt index b7faed6d7..ba136a3c2 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/SearchQuery.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/search/SearchQuery.kt @@ -1,9 +1,5 @@ package com.darkrockstudios.apps.hammer.common.data.search -import com.darkrockstudios.apps.hammer.common.data.tagindex.isTagPrefix -import com.darkrockstudios.apps.hammer.common.data.tagindex.isTagSeparator -import com.darkrockstudios.apps.hammer.common.data.tagindex.normalizeTagNeedle - /** Parsed search query: free text plus any `#tags` pulled out of it. */ data class ParsedQuery( val text: String, @@ -21,54 +17,27 @@ data class ParsedQuery( } } -/** - * A `#` opening a word starts a tag; everything else is free text. Tags are split and normalized - * the way tag input splits them on save, so a needle typed decomposed, or joined to the next by a - * comma, still matches what is stored. A `#` inside a word (`C#`) is part of the word. - */ +/** A `#` starts a tag that runs to the next whitespace; everything else is free text. */ fun parseQuery(query: String): ParsedQuery { - val tags = LinkedHashSet() + val tags = mutableListOf() val textBuilder = StringBuilder() var i = 0 while (i < query.length) { val c = query[i] - if (c.isTagPrefix() && (i == 0 || query[i - 1].isTagSeparator())) { + if (c == '#') { i++ - // A comma chains straight into the next tag; whitespace ends tag context entirely. - while (i < query.length) { - val tagStart = i - while (i < query.length && !query[i].isTagSeparator()) i++ - normalizeTagNeedle(query.substring(tagStart, i)) - .takeIf { it.isNotEmpty() } - ?.let(tags::add) - if (i < query.length && !query[i].isWhitespace()) i++ else break - } + val tagStart = i + while (i < query.length && !query[i].isWhitespace()) i++ + if (i > tagStart) tags.add(query.substring(tagStart, i)) } else { textBuilder.append(c) i++ } } val text = textBuilder.toString().replace(Regex("\\s+"), " ").trim() - return ParsedQuery(text = text, tags = tags.toList()) + return ParsedQuery(text = text, tags = tags) } -/** - * True when [query] appears, as literal text, in the prose [content] displays as: escapes resolved - * and paired emphasis, code and block markers dropped. So `well-known` finds `well\-known`, and - * `Chapter One` finds `**Chapter** One`. - * - * The query is never read as Markdown, and the storage form is never searched. `**Chapter**` finds - * nothing, because those asterisks are not on screen to be found; `well\-known` finds nothing for - * the same reason, while text stored as `well\\-known` renders a real backslash and is found by - * typing one. Markers the projection leaves alone, `5*4` and `user_name`, match where they sit, - * because there they are prose. - * - * Global search needs offsets rather than a boolean, so it projects and matches separately in - * `SearchProjectUseCase.findMarkdownMatch`. `MarkdownContainsTest` pins the two to the same answer. - */ -fun markdownContains(content: String, query: String): Boolean = - projectMarkdownToPlainText(content).contains(query, ignoreCase = true) - /** True when every needle is contained (case-insensitively) in at least one tag. */ fun Set.matchesAllTags(needles: List): Boolean { if (needles.isEmpty()) return true diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/ClientAccountSynchronizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/ClientAccountSynchronizer.kt index da12ff130..b0ec9155c 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/ClientAccountSynchronizer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/ClientAccountSynchronizer.kt @@ -81,31 +81,21 @@ class ClientAccountSynchronizer( syncId = serverSyncData.syncId val clientSyncData = loadSyncData() - val serverKnownIds = serverSyncData.knownProjectIds() yield() - // Deletions go first: a project name is unique per account on the server, so a - // rename into a name still held by a project queued for deletion is rejected. + syncRenamedProjects(clientSyncData, serverSyncData, onLog, onUnauthorized) + + yield() + syncDeletedProjects(clientSyncData, serverSyncData, onLog, onUnauthorized) yield() - syncRenamedProjects(clientSyncData, serverSyncData, serverKnownIds, onLog, onUnauthorized) - - yield() - val updatedServerSyncData = processProjectSyncData(serverSyncData, clientSyncData) val localProjects = projectsRepository.getProjects() - syncCreatedProjects( - clientSyncData, - updatedServerSyncData, - serverKnownIds, - localProjects, - onLog, - onUnauthorized, - ) + syncCreatedProjects(clientSyncData, updatedServerSyncData, localProjects, onLog, onUnauthorized) yield() @@ -283,21 +273,11 @@ class ClientAccountSynchronizer( private suspend fun syncRenamedProjects( clientSyncData: ProjectsSynchronizationData, serverSyncData: BeginProjectsSyncResponse, - serverKnownIds: Set, onLog: OnSyncLog, onUnauthorized: suspend () -> Unit = {}, ) { // Rename projects on the server clientSyncData.projectsToRename.forEach { (projectId, newName) -> - // The server can't rename an id it never issued, and would fail this every session - // forever. Recreation covers the rename anyway: it creates under the local name, - // which a local rename has already updated. A tombstoned id is just as unrenamable, - // and its local project has already been deleted by syncDeletedProjects. - if (projectId !in serverKnownIds || projectId in serverSyncData.deletedProjects) { - dropQueuedRename(projectId) - return@forEach - } - val result = serverProjectsApi.renameProject(projectId, serverSyncData.syncId, newName) if (result.isSuccess) { onLog( @@ -308,7 +288,12 @@ class ClientAccountSynchronizer( ) ) ) - dropQueuedRename(projectId) + updateSyncData { syncData -> + syncData.copy( + projectsToRename = syncData.projectsToRename + .filterNot { it.projectId == projectId }.toSet(), + ) + } } else { val exception = result.exceptionOrNull() Napier.e("Failed to rename project: $projectId", exception) @@ -329,15 +314,6 @@ class ClientAccountSynchronizer( } } - private fun dropQueuedRename(projectId: ProjectId) { - updateSyncData { syncData -> - syncData.copy( - projectsToRename = syncData.projectsToRename - .filterNot { it.projectId == projectId }.toSet(), - ) - } - } - private suspend fun syncDeletedProjects( clientSyncData: ProjectsSynchronizationData, serverSyncData: BeginProjectsSyncResponse, @@ -426,7 +402,6 @@ class ClientAccountSynchronizer( private suspend fun syncCreatedProjects( clientSyncData: ProjectsSynchronizationData, serverSyncData: BeginProjectsSyncResponse, - serverKnownIds: Set, localProjects: List, onLog: OnSyncLog, onUnauthorized: suspend () -> Unit = {}, @@ -450,57 +425,23 @@ class ClientAccountSynchronizer( onLog ) - // Claim server projects by name before uploading anything. The other order uploads a - // same-named local project as a second server project and only then overwrites its id - // with the name match, stranding an orphan duplicate on the server. - val liveServerIds = serverProjects.mapTo(mutableSetOf()) { it.uuid } - val claimedNames = createLocalProjectsFromServer(newServerProjects, liveServerIds, onLog) + createProjectsOnServer(localProjectsWithIds, clientSyncData, serverSyncData, onLog, onUnauthorized) - createProjectsOnServer( - localProjectsWithIds, - claimedNames, - clientSyncData, - serverSyncData, - serverKnownIds, - onLog, - onUnauthorized, - ) + createLocalProjectsFromServer(newServerProjects, onLog) } /** - * Create local projects from server. Returns the local names now backed by a server project, - * whether adopted or freshly created, so [createProjectsOnServer] does not re-upload them. - * - * A name match only claims a local project that is not already bound to one of - * [liveServerIds]: re-pointing it would abandon the server project holding its content, and - * two server names can sanitize to a single local name. Tombstoned ids are absent from - * [liveServerIds], so a project whose server copy was deleted elsewhere can still be claimed. + * Create local projects from server */ private suspend fun createLocalProjectsFromServer( newServerProjects: List, - liveServerIds: Set, onLog: OnSyncLog - ): Set { - val claimedNames = mutableSetOf() + ) { newServerProjects.forEach { serverProject -> val localName = ProjectsRepository.toLocalSafeName(serverProject.name) val existingProject = projectsRepository.findProject(localName) if (existingProject != null) { - val existingId = projectsRepository.getProjectId(existingProject) - if (existingId != null && existingId in liveServerIds) { - onLog( - syncAccLogW( - strRes.get( - Res.string.sync_log_account_project_create_client_name_taken, - serverProject.name - ) - ) - ) - return@forEach - } - projectsRepository.setProjectId(existingProject, serverProject.uuid) - claimedNames += existingProject.name onLog( syncAccLogI( strRes.get( @@ -510,11 +451,10 @@ class ClientAccountSynchronizer( ) ) } else { - val createResult = projectsRepository.createProject(localName, seedDefaultLanguage = false) + val createResult = projectsRepository.createProject(localName) if (isSuccess(createResult)) { val projectDef = createResult.data projectsRepository.setProjectId(projectDef, serverProject.uuid) - claimedNames += projectDef.name onLog( syncAccLogI( strRes.get( @@ -527,52 +467,31 @@ class ClientAccountSynchronizer( onLog( syncAccLogE( strRes.get( - Res.string.sync_log_account_project_create_local_failure, - serverProject.name, + Res.string.sync_log_account_project_create_client_failure, + serverProject.toString(), ) ) ) } } } - return claimedNames } /** - * Create projects on the server which this client has created locally. A cached [ProjectId] - * absent from [serverKnownIds] is dead (the client last synced against a different or - * since-reset server): recreate it, or per-project sync gets an id it can only 410 on. - * - * [claimedNames] are local projects that just adopted a server project by name; uploading them - * would duplicate that project on the server. + * Create projects on the server which this client has created locally */ private suspend fun createProjectsOnServer( localProjectsWithIds: List>, - claimedNames: Set, clientSyncData: ProjectsSynchronizationData, serverSyncData: BeginProjectsSyncResponse, - serverKnownIds: Set, onLog: OnSyncLog, onUnauthorized: suspend () -> Unit = {}, ) { - val localOnly = localProjectsWithIds.filter { (def, uuid) -> - (uuid == null || uuid !in serverKnownIds) && def.name !in claimedNames + val localOnly = localProjectsWithIds.filter { (_, uuid) -> + uuid == null }.map { it.first.name } - // A queued name with no local project was deleted before it ever reached the server. - // Creating it would push an empty project to every device, and resolving its definition - // would point at a directory that is gone. A queued name that just adopted a server - // project is equally dead. Drop both rather than acting on them. - val localNames = localProjectsWithIds.mapTo(mutableSetOf()) { it.first.name } - val withdrawnCreates = clientSyncData.projectsToCreate - .filterTo(mutableSetOf()) { it !in localNames || it in claimedNames } - if (withdrawnCreates.isNotEmpty()) { - updateSyncData { syncData -> - syncData.copy(projectsToCreate = syncData.projectsToCreate - withdrawnCreates) - } - } - - val newLocalProjects = (clientSyncData.projectsToCreate - withdrawnCreates) + localOnly + val newLocalProjects = clientSyncData.projectsToCreate + localOnly // Create projects on the server newLocalProjects.forEach { projectName -> val result = serverProjectsApi.createProject(projectName, serverSyncData.syncId) @@ -580,23 +499,9 @@ class ClientAccountSynchronizer( // Save the newly provisioned project id val response = result.getOrThrow() val projectDef = projectsRepository.getProjectDefinition(projectName) - val idSaved = try { + try { projectsRepository.setProjectId(projectDef, response.projectId) - true - } catch (e: Exception) { - Napier.e("Failed to save project id for $projectName", e) - onLog( - syncAccLogE( - strRes.get( - Res.string.sync_log_account_project_id_save_failure, - projectName - ) - ) - ) - false - } - if (idSaved) { onLog( syncAccLogI( strRes.get( @@ -610,6 +515,16 @@ class ClientAccountSynchronizer( projectsToCreate = syncData.projectsToCreate - projectName, ) } + } catch (e: Exception) { + Napier.e("Failed to save project id for $projectName", e) + onLog( + syncAccLogE( + strRes.get( + Res.string.sync_log_account_project_create_server_failure, + projectName + ) + ) + ) } } else { onLog( @@ -710,19 +625,6 @@ class ClientAccountSynchronizer( } } - /** - * A project deleted before it ever synced has no id to tombstone, only a queued creation to - * withdraw. Left queued, the next sync would create it on the server and push it back to - * every device. - */ - fun deleteUnsyncedProject(projectName: String) { - updateSyncData { syncData -> - syncData.copy( - projectsToCreate = syncData.projectsToCreate - projectName, - ) - } - } - private fun getSyncDataPath(): Path = projectsRepository.getProjectsDirectory().toOkioPath() / SYNC_FILE_NAME @@ -806,12 +708,4 @@ private data class ProjectPair( ) private fun Throwable?.isAuthenticationFailure(): Boolean = - (this is HttpFailureException && statusCode == HttpStatusCode.Unauthorized) - -/** - * Every project id the server accounted for, live or tombstoned. Must be read from the raw - * begin_sync response: `processProjectSyncData` drops projects this client has queued for - * deletion, and a project missing for that reason is still known to the server, not dead. - */ -private fun BeginProjectsSyncResponse.knownProjectIds(): Set = - projects.mapTo(mutableSetOf()) { it.uuid } + deletedProjects \ No newline at end of file + (this is HttpFailureException && statusCode == HttpStatusCode.Unauthorized) \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/SyncAccountUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/SyncAccountUseCase.kt deleted file mode 100644 index 612dd023e..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/accountsync/SyncAccountUseCase.kt +++ /dev/null @@ -1,281 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.sync.accountsync - -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SyncedProjectDefinition -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataConflictBroker -import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeaConflict -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ClientProjectSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncAccLogI -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogE -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogI -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.syncLogW -import com.darkrockstudios.apps.hammer.common.data.temporaryProjectTask -import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.sync_log_begin_account -import com.darkrockstudios.apps.hammer.sync_log_begin_project -import com.darkrockstudios.apps.hammer.sync_log_begin_projects -import com.darkrockstudios.apps.hammer.sync_log_project_conflict -import com.darkrockstudios.apps.hammer.sync_log_project_failed -import com.darkrockstudios.apps.hammer.sync_log_project_unchanged -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.async -import kotlinx.coroutines.awaitAll -import kotlinx.coroutines.coroutineScope -import kotlinx.coroutines.launch -import kotlinx.coroutines.yield -import okio.IOException -import org.koin.core.component.KoinComponent -import org.koin.core.parameter.parametersOf - -enum class ProjectSyncOutcome { - Success, - - /** The change probe confirmed nothing to transfer. */ - Unchanged, - NeedsResolution, - Failed, - - /** Account sync has not assigned this project a server ID yet. */ - NotOnServer, - - /** Excluded by the caller's project filter. */ - Skipped, -} - -data class SyncAccountResult( - val accountSuccess: Boolean, - val ideasSuccess: Boolean, - /** Keyed by project name. */ - val projects: Map, -) { - val allSuccess: Boolean - get() = accountSuccess && ideasSuccess && projects.values.none { - it == ProjectSyncOutcome.Failed || it == ProjectSyncOutcome.NeedsResolution - } -} - -interface SyncAccountListener { - suspend fun onLog(message: SyncLogMessage) - - /** The full local project list, reported before account sync and again after it. */ - suspend fun onProjectsDiscovered(projects: List) - - /** The project is syncing; [progress] is null until the synchronizer reports some. */ - suspend fun onProjectProgress(projectDef: ProjectDef, progress: Float?) - - suspend fun onProjectOutcome(projectDef: ProjectDef, outcome: ProjectSyncOutcome) - - suspend fun onUnauthorized() - - /** Returns the resolved idea, or null to leave the conflict unresolved. */ - suspend fun onIdeaConflict(conflict: IdeaConflict): StoryIdea? = null -} - -/** - * Syncs the account, then every synced project the filter admits, in parallel. Per-project - * failures are reported as outcomes; failures outside a project propagate to the caller. - */ -class SyncAccountUseCase( - private val projectsRepository: ProjectsRepository, - private val accountSynchronizer: ClientAccountSynchronizer, - private val projectMetadataDatasource: ProjectMetadataDatasource, - private val strRes: StrRes, -) : KoinComponent { - - suspend fun execute( - listener: SyncAccountListener, - projectFilter: (SyncedProjectDefinition) -> Boolean = { true }, - ): SyncAccountResult { - val initialProjects = projectsRepository.getProjects() - listener.onProjectsDiscovered(initialProjects) - - listener.onLog(syncAccLogI(strRes.get(Res.string.sync_log_begin_account))) - - var ideasSuccess = true - val accountSuccess = accountSynchronizer.syncProjects( - onLog = listener::onLog, - onUnauthorized = listener::onUnauthorized, - onIdeaConflict = listener::onIdeaConflict, - onIdeasSyncResult = { ideasSuccess = it }, - ) - - yield() - - if (!accountSuccess) { - initialProjects.forEach { listener.onProjectOutcome(it, ProjectSyncOutcome.Failed) } - return SyncAccountResult( - accountSuccess = false, - ideasSuccess = ideasSuccess, - projects = initialProjects.associate { it.name to ProjectSyncOutcome.Failed }, - ) - } - - listener.onLog(syncAccLogI(strRes.get(Res.string.sync_log_begin_projects))) - - // Account sync may have created or removed local projects. - val projects = projectsRepository.getProjects() - listener.onProjectsDiscovered(projects) - - val outcomes = mutableMapOf() - val candidates = projects.mapNotNull { projectDef -> - val outcome = classify(projectDef, projectFilter) - if (outcome is Candidate.Settled) { - outcomes[projectDef.name] = outcome.outcome - listener.onProjectOutcome(projectDef, outcome.outcome) - null - } else { - (outcome as Candidate.ToSync).synced - } - } - - val unchangedProjectIds = accountSynchronizer.probeUnchangedProjects(candidates) - - val synced = coroutineScope { - candidates.map { synced -> - async { - val projectDef = synced.projectDef - val outcome = if (synced.projectId in unchangedProjectIds) { - listener.onLog(syncLogI(strRes.get(Res.string.sync_log_project_unchanged), projectDef)) - ProjectSyncOutcome.Unchanged - } else { - syncProjectSafely(projectDef, listener) - } - listener.onProjectOutcome(projectDef, outcome) - projectDef.name to outcome - } - }.awaitAll() - } - outcomes.putAll(synced) - - return SyncAccountResult( - accountSuccess = true, - ideasSuccess = ideasSuccess, - projects = outcomes, - ) - } - - private sealed interface Candidate { - data class Settled(val outcome: ProjectSyncOutcome) : Candidate - data class ToSync(val synced: SyncedProjectDefinition) : Candidate - } - - private fun classify( - projectDef: ProjectDef, - projectFilter: (SyncedProjectDefinition) -> Boolean, - ): Candidate { - // The project can be deleted concurrently. - val metadata = try { - projectMetadataDatasource.loadMetadata(projectDef) - } catch (e: IOException) { - Napier.w("Failed to load metadata for '${projectDef.name}'", e) - return Candidate.Settled(ProjectSyncOutcome.Failed) - } - - val serverProjectId = metadata.info.serverProjectId - if (serverProjectId == null) { - Napier.w { "Skipping project sync for '${projectDef.name}' - no server project ID yet" } - return Candidate.Settled(ProjectSyncOutcome.NotOnServer) - } - - val synced = SyncedProjectDefinition(projectDef, serverProjectId) - return if (projectFilter(synced)) { - Candidate.ToSync(synced) - } else { - Candidate.Settled(ProjectSyncOutcome.Skipped) - } - } - - private suspend fun syncProjectSafely( - projectDef: ProjectDef, - listener: SyncAccountListener, - ): ProjectSyncOutcome { - return try { - listener.onProjectProgress(projectDef, null) - syncProject(projectDef, listener) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Project sync failed for ${projectDef.name}", e) - listener.onLog( - syncLogE( - strRes.get(Res.string.sync_log_project_failed, e.message ?: "Unknown error"), - projectDef - ) - ) - ProjectSyncOutcome.Failed - } - } - - private suspend fun syncProject( - projectDef: ProjectDef, - listener: SyncAccountListener, - ): ProjectSyncOutcome { - listener.onLog(syncLogI(strRes.get(Res.string.sync_log_begin_project, projectDef.name), projectDef)) - - var success = false - var conflicted = false - - suspend fun reportConflict() { - listener.onLog( - syncLogW(strRes.get(Res.string.sync_log_project_conflict, projectDef.name), projectDef) - ) - conflicted = true - } - - try { - temporaryProjectTask(projectDef) { projScope -> - val synchronizer: ClientProjectSynchronizer = - projScope.get { parametersOf(projectDef) } - val conflictBroker: ProjectDataConflictBroker = - projScope.get { parametersOf(projectDef) } - - coroutineScope { - // Bulk account sync has no interactive resolver. A project-data conflict reports - // to the broker and waits on resolutions forever, leaving the project stuck - // "Syncing". Watch for it and abort so the project stops instead of hanging. - val conflictWatcher = launch { - for (conflict in conflictBroker.conflicts) { - reportConflict() - conflictBroker.abort() - } - } - - try { - success = synchronizer.sync( - onProgress = { progress, message -> - listener.onProjectProgress(projectDef, progress) - if (message != null) listener.onLog(message) - }, - onLog = listener::onLog, - onConflict = { - reportConflict() - throw IllegalStateException("Entity conflict must be handled by Project sync") - }, - onComplete = {}, - onUnauthorized = listener::onUnauthorized, - ) - } finally { - conflictWatcher.cancel() - } - } - } - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - // A conflict aborts the entity sync by throwing; that's a resolvable state, not a failure. - if (!conflicted) throw e - } - - return when { - success -> ProjectSyncOutcome.Success - conflicted -> ProjectSyncOutcome.NeedsResolution - else -> ProjectSyncOutcome.Failed - } - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/ClientProjectSynchronizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/ClientProjectSynchronizer.kt index 971d83666..10850fde6 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/ClientProjectSynchronizer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/ClientProjectSynchronizer.kt @@ -71,7 +71,7 @@ class ClientProjectSynchronizer( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit, + onComplete: suspend () -> Unit, onlyNew: Boolean = false, onUnauthorized: suspend () -> Unit, ): Boolean = coroutineScope { @@ -110,7 +110,7 @@ class ClientProjectSynchronizer( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit, + onComplete: suspend () -> Unit, onUnauthorized: suspend () -> Unit = {} ): CResult { var currentState = initialState @@ -142,7 +142,7 @@ class ClientProjectSynchronizer( private suspend fun handleSyncFailure( e: Throwable, onLog: OnSyncLog, - onComplete: suspend (success: Boolean) -> Unit, + onComplete: suspend () -> Unit, onUnauthorized: suspend () -> Unit = {} ) { Napier.e("Sync failed: ${e.message}", e) @@ -154,7 +154,7 @@ class ClientProjectSynchronizer( ) ) endSync() - onComplete(false) + onComplete() // Check if the error is a 401 Unauthorized error if (e is HttpFailureException && e.statusCode == HttpStatusCode.Unauthorized) { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/SyncDataDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/SyncDataDatasource.kt index 194c89df5..c7a3ef775 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/SyncDataDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/SyncDataDatasource.kt @@ -100,58 +100,4 @@ class SyncDataDatasource( companion object { const val SYNC_FILE_NAME = "sync.json" } -} - -/** - * Resets everything in the entity journal that records agreement with a *specific* server, for - * scope-less callers moving a project to a different server project. Local pending work the new - * server has never seen — [ProjectSynchronizationData.dirty], `newIds`, `deletedIds`, `lastId` — - * is kept, so an unsynced edit or a tombstone can't be lost by the move. Dirty entries keep their - * id but drop [EntityOriginalState.originalHash]: a baseline the old server confirmed would forge - * a phantom conflict against the new one, while a null baseline uploads unconditionally. - * - * No-op when the journal doesn't exist. A corrupt journal is deleted so - * [SyncDataDatasource.createSyncData] rebuilds it from local state, matching [loadSyncData]. - */ -// Corrupt sync data recovers by deleting it; not an error to surface. -@Suppress("SwallowedException") -fun clearProjectSyncBaseline(projectDef: ProjectDef, fileSystem: FileSystem, json: Json) { - val path = projectDef.path.toOkioPath() / SyncDataDatasource.SYNC_FILE_NAME - if (!fileSystem.exists(path)) return - - val current = try { - fileSystem.read(path) { json.decodeFromString(readUtf8()) } - } catch (e: SerializationException) { - fileSystem.delete(path) - return - } - - val cleared = current.copy( - currentSyncId = null, - lastSync = Instant.DISTANT_PAST, - dirty = current.dirty.map { it.copy(originalHash = null) }, - syncedHashes = emptyMap(), - cachedProjectHash = null, - hashAlgoVersion = 0, - ) - if (cleared == current) return - - fileSystem.write(path) { writeUtf8(json.encodeToString(cleared)) } -} - -/** - * The entities a project has written but not yet had accepted by the server: new ones plus changed - * ones. Read without a project scope, because callers that only need the number must not pay for - * opening the whole project. - * - * A project with no journal has never synced and so has nothing outstanding. A journal that cannot - * be read throws rather than reporting zero: callers use this to decide whether local writing is - * safe to discard, and an unreadable journal is not evidence that it is. - */ -fun loadPendingEntityCount(projectDef: ProjectDef, fileSystem: FileSystem, json: Json): Int { - val path = projectDef.path.toOkioPath() / SyncDataDatasource.SYNC_FILE_NAME - if (!fileSystem.exists(path)) return 0 - - val data = fileSystem.read(path) { json.decodeFromString(readUtf8()) } - return (data.dirty.map { it.id }.toSet() + data.newIds).size -} +} \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/BackupOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/BackupOperation.kt index 5becf5505..7889d8c30 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/BackupOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/BackupOperation.kt @@ -21,7 +21,7 @@ class BackupOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { if ( globalSettingsStore.globalSettings.automaticBackups && diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/CoalateIdsOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/CoalateIdsOperation.kt index fc33917a5..fa80b39ba 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/CoalateIdsOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/CoalateIdsOperation.kt @@ -18,7 +18,7 @@ class CollateIdsOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as FetchServerDataState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EnsureProjectIdOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EnsureProjectIdOperation.kt index 36412b6c7..951233aba 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EnsureProjectIdOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EnsureProjectIdOperation.kt @@ -24,7 +24,7 @@ class EnsureProjectIdOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { val metadata = projectMetadataDatasource.loadMetadata(projectDef) if (metadata.info.serverProjectId == null) { diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityDeleteOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityDeleteOperation.kt index b41e0e07e..f12b9636f 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityDeleteOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityDeleteOperation.kt @@ -23,7 +23,7 @@ class EntityDeleteOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as IdConflictResolutionState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityTransferOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityTransferOperation.kt index 0c642738d..f8fbb612d 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityTransferOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/EntityTransferOperation.kt @@ -59,7 +59,7 @@ class EntityTransferOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as EntityDeleteOperationState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchLocalDataOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchLocalDataOperation.kt index b62c502ba..bf095bef6 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchLocalDataOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchLocalDataOperation.kt @@ -25,7 +25,7 @@ class FetchLocalDataOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { return try { state as InitialSyncOperationState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchServerDataOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchServerDataOperation.kt index 6b29afb4b..23d0ae0ae 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchServerDataOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FetchServerDataOperation.kt @@ -6,14 +6,10 @@ import com.darkrockstudios.apps.hammer.common.data.CResult import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.* -import com.darkrockstudios.apps.hammer.common.server.HttpFailureException import com.darkrockstudios.apps.hammer.common.server.ServerProjectApi import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.sync_log_project_id_stale import com.darkrockstudios.apps.hammer.sync_log_server_data_loaded -import io.ktor.http.HttpStatusCode import kotlinx.coroutines.flow.first class FetchServerDataOperation( @@ -21,7 +17,6 @@ class FetchServerDataOperation( private val globalSettingsStore: GlobalSettingsStore, private val serverProjectApi: ServerProjectApi, private val projectMetadataDatasource: ProjectMetadataDatasource, - private val projectsRepository: ProjectsRepository, private val strRes: StrRes, ) : SyncOperation(projectDef) { @@ -30,7 +25,7 @@ class FetchServerDataOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as FetchLocalDataState @@ -60,18 +55,9 @@ class FetchServerDataOperation( CResult.success(fetchServerDataStateState) } else { - val exception = + CResult.failure( serverSyncDataResult.exceptionOrNull() ?: IllegalStateException("No exception") - - // 410 means the server has no record of this id, so it can never succeed. Drop it and - // EnsureProjectIdOperation creates the project fresh next sync, instead of this - // failing forever. - if (exception is HttpFailureException && exception.statusCode == HttpStatusCode.Gone) { - projectsRepository.removeProjectId(projectDef) - onLog(syncLogW(strRes.get(Res.string.sync_log_project_id_stale), projectDef)) - } - - CResult.failure(exception) + ) } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FinalizeSyncOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FinalizeSyncOperation.kt index 3d5f4d79e..9606bf575 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FinalizeSyncOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/FinalizeSyncOperation.kt @@ -35,7 +35,7 @@ class FinalizeSyncOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as EntityTransferState @@ -126,7 +126,7 @@ class FinalizeSyncOperation( yield() - onComplete(allSuccess) + onComplete() return if (allSuccess) { CResult.success(state) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/IdConflictResolutionOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/IdConflictResolutionOperation.kt index 27312053d..918a21942 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/IdConflictResolutionOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/IdConflictResolutionOperation.kt @@ -19,7 +19,7 @@ class IdConflictResolutionOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { state as CollateIdsState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/PrepareForSyncOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/PrepareForSyncOperation.kt index fb96f543f..1e23eaec2 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/PrepareForSyncOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/PrepareForSyncOperation.kt @@ -18,7 +18,7 @@ class PrepareForSyncOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult { idAllocator.findNextId() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/ProjectDataSyncOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/ProjectDataSyncOperation.kt index 05bfa7652..325fdb31f 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/ProjectDataSyncOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/ProjectDataSyncOperation.kt @@ -12,8 +12,6 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataConflict import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataConflictBroker import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.data.projectdata.differsOutsideDictionary -import com.darkrockstudios.apps.hammer.common.data.projectdata.mergeDictionaryWords import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.EntityConflictHandler import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.IdConflictResolutionState import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.OnSyncLog @@ -28,9 +26,6 @@ import io.github.aakira.napier.Napier /** * A non-conflict server error fails the whole sync — unlike writing-activity sync, * the data is user-authored and silent loss is unacceptable. - * - * A conflict confined to [ProjectData.dictionaryWords] is merged by union here and never - * reaches the resolver; any other conflicting field still goes through the broker. */ class ProjectDataSyncOperation( projectDef: ProjectDef, @@ -45,7 +40,7 @@ class ProjectDataSyncOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit, + onComplete: suspend () -> Unit, ): CResult { state as IdConflictResolutionState @@ -75,7 +70,7 @@ class ProjectDataSyncOperation( } serverDto.hash == localHash -> { if (lastSyncedHash != serverDto.hash) { - repository.updateFromSync(serverDto.data, serverDto.hash, snapshot = stored.data) + repository.updateFromSync(serverDto.data, serverDto.hash) } onLog(syncLogI("Project data already in sync", projectDef)) return CResult.success(state) @@ -86,7 +81,7 @@ class ProjectDataSyncOperation( // recording the server hash would make the stored copy look locally edited, and the // next sync would upload it — deleting the newer field server-side. With the stored // hash, an out-of-date device just keeps fast-forwarding harmlessly. - repository.updateFromSync(serverDto.data, ProjectDataHasher.hash(serverDto.data), snapshot = stored.data) + repository.updateFromSync(serverDto.data, ProjectDataHasher.hash(serverDto.data)) onLog(syncLogI("Project data updated from server", projectDef)) return CResult.success(state) } @@ -108,7 +103,7 @@ class ProjectDataSyncOperation( val result = api.uploadProjectData(userId, projectId, data, originalHash) val success = result.getOrNull() if (success != null) { - repository.updateFromSync(success.data, success.hash, snapshot = data) + repository.updateFromSync(success.data, success.hash) onLog(syncLogI("Project data synced", projectDef)) return success } @@ -121,21 +116,15 @@ class ProjectDataSyncOperation( return null } - val server = conflict.conflict.server - val resolved = if (data.differsOutsideDictionary(server)) { - onLog(syncLogW("Project data conflict detected", projectDef)) - broker.reportConflict( - ProjectDataConflict( - local = data, - server = server, - serverHash = conflict.conflict.serverHash, - ) + onLog(syncLogW("Project data conflict detected", projectDef)) + broker.reportConflict( + ProjectDataConflict( + local = data, + server = conflict.conflict.server, + serverHash = conflict.conflict.serverHash, ) - broker.awaitResolution() - } else { - onLog(syncLogI("Project data conflict: dictionary words merged", projectDef)) - data.copy(dictionaryWords = mergeDictionaryWords(data, server)) - } + ) + val resolved = broker.awaitResolution() val resolveResult = api.uploadProjectData( userId = userId, @@ -150,7 +139,7 @@ class ProjectDataSyncOperation( onLog(syncLogE("Project data conflict resolution failed: ${resolveError?.message}", projectDef)) return null } - repository.updateFromSync(resolvedDto.data, resolvedDto.hash, snapshot = data) + repository.updateFromSync(resolvedDto.data, resolvedDto.hash) onLog(syncLogI("Project data synced", projectDef)) return resolvedDto } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/SyncOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/SyncOperation.kt index c70c50f94..5a7eb4fce 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/SyncOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/SyncOperation.kt @@ -20,6 +20,6 @@ abstract class SyncOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit + onComplete: suspend () -> Unit ): CResult } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/WritingActivitySyncOperation.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/WritingActivitySyncOperation.kt index 5f9d0404e..cd82468aa 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/WritingActivitySyncOperation.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/operations/WritingActivitySyncOperation.kt @@ -46,7 +46,7 @@ class WritingActivitySyncOperation( onProgress: suspend (Float, SyncLogMessage?) -> Unit, onLog: OnSyncLog, onConflict: EntityConflictHandler, - onComplete: suspend (success: Boolean) -> Unit, + onComplete: suspend () -> Unit, ): CResult { state as EntityTransferState diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientEncyclopediaSynchronizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientEncyclopediaSynchronizer.kt index 9aaea6763..d6e585843 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientEncyclopediaSynchronizer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientEncyclopediaSynchronizer.kt @@ -69,7 +69,6 @@ class ClientEncyclopediaSynchronizer( tags = entity.tags, image = entity.image, aliases = entity.aliases, - excludeFromDictionary = entity.excludeFromDictionary, ) } @@ -98,7 +97,6 @@ class ClientEncyclopediaSynchronizer( tags = entry.tags, image = image, aliases = entry.aliases, - excludeFromDictionary = entry.excludeFromDictionary, ) } @@ -152,7 +150,6 @@ class ClientEncyclopediaSynchronizer( text = serverEntity.text, tags = serverEntity.tags, aliases = serverEntity.aliases, - excludeFromDictionary = serverEntity.excludeFromDictionary, ) } else { encyclopediaService.createEntry( @@ -163,7 +160,6 @@ class ClientEncyclopediaSynchronizer( imagePath = null, // Always pass null here, we wrote the image our selves forceId = serverEntity.id, aliases = serverEntity.aliases, - excludeFromDictionary = serverEntity.excludeFromDictionary, ) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientSceneSynchronizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientSceneSynchronizer.kt index 45f491bab..727703a0e 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientSceneSynchronizer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/sync/projectsync/synchronizers/ClientSceneSynchronizer.kt @@ -12,6 +12,7 @@ import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftRepository import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource +import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneContentRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.findById @@ -20,6 +21,7 @@ import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.* import com.darkrockstudios.apps.hammer.common.server.ServerProjectApi import com.darkrockstudios.apps.hammer.common.util.StrRes import io.github.aakira.napier.Napier +import kotlinx.coroutines.delay class ClientSceneSynchronizer( projectDef: ProjectDef, @@ -74,8 +76,9 @@ class ClientSceneSynchronizer( ) } - /** Unsaved buffers are left alone: whether they join the project is the user's call, not sync's. */ - override suspend fun prepareForSync() = Unit + override suspend fun prepareForSync() { + sceneEditorService.storeAllBuffers() + } override suspend fun ownsEntity(id: Int): Boolean { return sceneEditorRepository.getSceneItemFromId(id) != null @@ -180,7 +183,7 @@ class ClientSceneSynchronizer( val content = SceneContent(sceneItem, serverEntity.content) if (sceneEditorRepository.storeSceneMarkdownRaw(content, scenePath)) { val updatedMetadata = mergeServerMetadata(serverEntity) - sceneEditorService.storeMetadata(updatedMetadata, serverEntity.id, UpdateSource.Sync) + sceneEditorService.storeMetadata(updatedMetadata, serverEntity.id) // Finally, log our success, and update the running apps data onLog(syncLogI(strRes.get(Res.string.sync_scene_downloading, id), projectDef)) @@ -290,7 +293,7 @@ class ClientSceneSynchronizer( sceneEditorRepository.storeSceneMarkdownRaw(content, scenePath) val updatedMetadata = mergeServerMetadata(serverEntity) - sceneEditorService.storeMetadata(updatedMetadata, serverEntity.id, UpdateSource.Sync) + sceneEditorService.storeMetadata(updatedMetadata, serverEntity.id) } } else { // Scene doesn't exist locally at all - create it directly in archive @@ -323,12 +326,9 @@ class ClientSceneSynchronizer( // Those fields are hashed, so backfill them with the project's creation time: the resulting // hash divergence from the server drives the heal upload in [EntityTransferOperation] that // enriches the server's copy, converging both sides on a non-null value. - // The draft name is never synced, so the local one is carried over. - private suspend fun mergeServerMetadata(serverEntity: ApiProjectEntity.SceneEntity): SceneMetadata { + private fun mergeServerMetadata(serverEntity: ApiProjectEntity.SceneEntity): SceneMetadata { val projectCreated = projectMetadataDatasource.loadMetadata(projectDef).info.created - val local = sceneEditorService.loadSceneMetadata(serverEntity.id) return SceneMetadata( - currentDraftName = local.currentDraftName, notes = serverEntity.notes, outline = serverEntity.outline, confirmedReferences = serverEntity.confirmedReferences, @@ -353,7 +353,12 @@ class ClientSceneSynchronizer( override suspend fun finalizeSync() { sceneEditorRepository.rationalizeTree() sceneEditorRepository.cleanupSceneOrder() + + // Wait for buffers to propagate before we save them + delay(SceneContentRepository.BUFFER_COOL_DOWN * 0.25) + sceneEditorRepository.forceSceneListReload() + sceneEditorService.storeAllBuffers() } override fun getEntityType() = EntityType.Scene diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/AccountTagService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/AccountTagService.kt index 306b5e9b5..c72968d0b 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/AccountTagService.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/AccountTagService.kt @@ -64,7 +64,7 @@ class AccountTagService( exclude: Set = emptySet(), limit: Int = MAX_SUGGESTIONS, ): List { - val needle = normalizeTagNeedle(prefix) + val needle = prefix.trim().removePrefix("#") if (needle.isEmpty()) return emptyList() val merged = ideaTagCounts.value.toMutableMap() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/BuildTagIndexUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/BuildTagIndexUseCase.kt index bac36188e..fcde698f2 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/BuildTagIndexUseCase.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/BuildTagIndexUseCase.kt @@ -87,8 +87,6 @@ class BuildTagIndexUseCase( ) } - // Normalized on the way in rather than trusting every writer to have called cleanTags: a tag - // that reached disk decomposed would otherwise be a key no typed needle can ever match. private fun accumulate( tagToEntities: MutableMap>, countsByType: MutableMap>, @@ -96,10 +94,8 @@ class BuildTagIndexUseCase( tag: String, ref: TaggedEntityRef, ) { - val key = normalizeTagNeedle(tag) - if (key.isEmpty()) return - tagToEntities.getOrPut(key) { mutableSetOf() }.add(ref) + tagToEntities.getOrPut(tag) { mutableSetOf() }.add(ref) val perType = countsByType.getOrPut(type) { mutableMapOf() } - perType[key] = (perType[key] ?: 0) + 1 + perType[tag] = (perType[tag] ?: 0) + 1 } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagIndexService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagIndexService.kt index 920866877..c6f129173 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagIndexService.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagIndexService.kt @@ -78,7 +78,7 @@ class TagIndexService( _tagIndex.value.tagToEntities[tag].orEmpty() fun suggest(prefix: String, limit: Int = 10): List { - val needle = normalizeTagNeedle(prefix) + val needle = prefix.trim() if (needle.isEmpty()) return getRankedTags(limit) return _tagIndex.value.tagToEntities .filterKeys { it.startsWith(needle, ignoreCase = true) } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.kt index 5469ff5f9..b071110f1 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.kt @@ -1,116 +1,17 @@ package com.darkrockstudios.apps.hammer.common.data.tagindex -private const val ZERO_WIDTH_NON_JOINER = '\u200C' -private const val ZERO_WIDTH_JOINER = '\u200D' -private const val FULLWIDTH_NUMBER_SIGN = '\uFF03' -private const val FULLWIDTH_COMMA = '\uFF0C' -private const val IDEOGRAPHIC_COMMA = '\u3001' - -/** - * Canonically compose [text] (Unicode NFC) so the two spellings of an accented tag - precomposed - * `è`, and `e` plus a combining grave - are stored and indexed as one string. Tags are compared - * by exact equality everywhere downstream, so they have to agree on a single form. - */ -internal expect fun normalizeTagForm(text: String): String - -/** True when the supplementary-plane [codePoint] is a letter or a digit. */ -internal expect fun isSupplementaryLetterOrDigit(codePoint: Int): Boolean - -/** Opens a `#tag`, in ASCII or fullwidth form. */ -fun Char.isTagPrefix(): Boolean = this == '#' || this == FULLWIDTH_NUMBER_SIGN - -/** Separates one tag from the next in free-form input, in any script's punctuation. */ -fun Char.isTagSeparator(): Boolean = - isWhitespace() || - this == ',' || - this == FULLWIDTH_COMMA || - this == IDEOGRAPHIC_COMMA - -private fun Char.isTagChar(): Boolean = - isLetterOrDigit() || - category == CharCategory.NON_SPACING_MARK || - category == CharCategory.COMBINING_SPACING_MARK || - this == ZERO_WIDTH_NON_JOINER || - this == ZERO_WIDTH_JOINER || - this == '_' || - this == '-' - -/** - * A tag is a run of letters, digits, combining marks and word-joiners, plus `_` and `-`, and - * must carry at least one letter or digit so it has something to render. - */ -private fun isValidTag(tag: String): Boolean { - var hasLetterOrDigit = false - var i = 0 - while (i < tag.length) { - val char = tag[i] - val next = if (i + 1 < tag.length) tag[i + 1] else null - // Astral characters (rare kanji, Adlam, ...) are a surrogate pair, and neither half is a - // letter on its own, so they have to be tested as a whole code point. - if (char.isHighSurrogate() && next != null && next.isLowSurrogate()) { - if (!isSupplementaryLetterOrDigit(codePointOf(char, next))) return false - hasLetterOrDigit = true - i += 2 - } else { - if (!char.isTagChar()) return false - if (char.isLetterOrDigit()) hasLetterOrDigit = true - i++ - } - } - return hasLetterOrDigit -} - -private fun codePointOf(high: Char, low: Char): Int = - 0x10000 + ((high.code - 0xD800) shl 10) + (low.code - 0xDC00) - -private fun String.removeTagPrefix(): String = - if (isNotEmpty() && this[0].isTagPrefix()) substring(1) else this - -/** - * Put a tag the user typed into the form stored tags are held in, so searching and suggesting can - * compare the two: composed, trimmed, and without a leading `#`. - */ -fun normalizeTagNeedle(text: String): String = normalizeTagForm(text.trim()).removeTagPrefix() - -/** - * The tag the user is part-way through typing at the end of [input]: whatever follows the last - * separator, ready to match against stored tags. Splits on the same separators [parseTagInput] - * does, so the suggestions offered agree with the tags that would be saved. - */ -fun tagPrefixOf(input: String): String = - normalizeTagNeedle(input.takeLastWhile { !it.isTagSeparator() }) - -/** - * [input] with the tag being typed at its end swapped for [tag], leaving any earlier tags in the - * field untouched. Pairs with [tagPrefixOf]: what that offers a suggestion for, this replaces. - */ -fun replaceTagPrefix(input: String, tag: String): String = - input.dropLast(input.takeLastWhile { !it.isTagSeparator() }.length) + tag +private val TAG_PATTERN = Regex("""[\w-]+""") +private val TAG_INPUT_SPLIT = Regex("""[\s,]+""") fun cleanTags(tags: Set): Set = tags.asSequence() - .map(::normalizeTagNeedle) - .filter(::isValidTag) + .map { it.trim().removePrefix("#") } + .filter { it.isNotEmpty() && TAG_PATTERN.matches(it) } .toSet() /** * Parse free-form user tag input into a normalized set: split on whitespace + commas, - * strip a leading `#`, drop pieces that aren't valid tags. + * strip leading `#`, drop pieces that don't match [TAG_PATTERN]. */ -fun parseTagInput(input: String): Set { - val pieces = mutableListOf() - val piece = StringBuilder() - for (char in input) { - if (char.isTagSeparator()) { - if (piece.isNotEmpty()) { - pieces.add(piece.toString()) - piece.clear() - } - } else { - piece.append(char) - } - } - if (piece.isNotEmpty()) pieces.add(piece.toString()) - - return cleanTags(pieces.toSet()) -} +fun parseTagInput(input: String): Set = + cleanTags(input.split(TAG_INPUT_SPLIT).toSet()) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tree/SceneChapters.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tree/SceneChapters.kt deleted file mode 100644 index e684a0ea6..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tree/SceneChapters.kt +++ /dev/null @@ -1,16 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.tree - -import com.darkrockstudios.apps.hammer.common.data.SceneItem - -/** A top-level node of the scene tree and the scenes it contributes to the story, in story order. */ -data class ChapterScenes(val chapter: SceneItem, val scenes: List) - -/** A top-level scene is a one-scene chapter; a group is flattened depth-first to its descendant scenes. */ -fun ImmutableTree.collectChapters(): List = root.children.map { node -> - val scenes = if (node.value.type == SceneItem.Type.Scene) { - listOf(node.value) - } else { - node.filter { it.value.type == SceneItem.Type.Scene }.map { it.value } - } - ChapterScenes(chapter = node.value, scenes = scenes) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/ShouldNotifyOfUpdateUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/ShouldNotifyOfUpdateUseCase.kt new file mode 100644 index 000000000..4caa8cb60 --- /dev/null +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/ShouldNotifyOfUpdateUseCase.kt @@ -0,0 +1,19 @@ +package com.darkrockstudios.apps.hammer.common.data.versioncheck + +import com.darkrockstudios.apps.hammer.common.util.stripReleaseSuffix + +/** + * True when there's a new version the user hasn't already dismissed. + * Comparison is on bare semvers, so partial-release suffixes (`+google-play` + * etc.) don't fragment dismissals across stores. + */ +class ShouldNotifyOfUpdateUseCase { + operator fun invoke( + result: VersionCheckRepository.VersionCheckResult, + dismissed: String?, + ): Boolean { + if (!result.isNewVersionAvailable) return false + val release = result.latestRelease ?: return false + return stripReleaseSuffix(release.tagName) != dismissed?.let(::stripReleaseSuffix) + } +} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/VersionCheckRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/VersionCheckRepository.kt index 1b0e54c8b..bf153d177 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/VersionCheckRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/versioncheck/VersionCheckRepository.kt @@ -4,14 +4,14 @@ import com.darkrockstudios.apps.hammer.common.util.getAppVersionString import com.darkrockstudios.apps.hammer.common.util.isNewVersionAvailable import kotlinx.atomicfu.locks.reentrantLock import kotlinx.atomicfu.locks.withLock +import kotlinx.coroutines.channels.BufferOverflow +import kotlinx.coroutines.flow.MutableSharedFlow +import kotlinx.coroutines.flow.SharedFlow /** * App-scoped cache of the latest GitHub release. One HTTP request per session - * unless [checkForUpdate] is called with `force = true`. - * - * The protocol mismatch dialog is the only consumer, and it only appears once the user has - * already connected to a sync server. Nothing on the app-load path may use this — the in-app - * changelog is baked in at release time precisely so startup never calls GitHub. + * unless [checkForUpdate] is called with `force = true`. Subscribers receive + * the cached result immediately via the `replay = 1` flow. */ class VersionCheckRepository( private val dataSource: VersionCheckDataSource, @@ -19,6 +19,13 @@ class VersionCheckRepository( private val lock = reentrantLock() private var cached: VersionCheckResult? = null + private val _updates = MutableSharedFlow( + extraBufferCapacity = 1, + replay = 1, + onBufferOverflow = BufferOverflow.DROP_OLDEST, + ) + val updates: SharedFlow = _updates + suspend fun checkForUpdate(force: Boolean = false): VersionCheckResult { val existing = lock.withLock { cached } if (existing != null && !force) return existing @@ -30,9 +37,12 @@ class VersionCheckRepository( currentVersion = getAppVersionString(), ) lock.withLock { cached = result } + _updates.tryEmit(result) return result } + fun currentResult(): VersionCheckResult? = lock.withLock { cached } + data class VersionCheckResult( val latestRelease: GithubReleaseInfo?, val isNewVersionAvailable: Boolean, diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/writingactivity/WritingActivityDatasource.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/writingactivity/WritingActivityDatasource.kt index d58d409da..5fbe283db 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/writingactivity/WritingActivityDatasource.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/data/writingactivity/WritingActivityDatasource.kt @@ -34,7 +34,8 @@ class WritingActivityDatasource( override val projectScope = ProjectDefScope(projectDef) private val dispatcherIo by injectIoDispatcher() - fun getDirectory(): Path = activityDirectory(projectDef.path.toOkioPath()) + fun getDirectory(): Path = + projectDef.path.toOkioPath() / SceneDatasource.SCENE_DIRECTORY / ACTIVITY_DIRECTORY fun getDeviceLogPath(deviceId: String): Path = getDirectory() / "$deviceId$FILE_SUFFIX" @@ -61,7 +62,8 @@ class WritingActivityDatasource( } suspend fun saveDeviceLog(deviceId: String, log: DeviceLog): Unit = withContext(dispatcherIo) { - writeDeviceLog(projectDef.path.toOkioPath(), deviceId, log, fileSystem, toml) + fileSystem.createDirectories(getDirectory()) + fileSystem.writeToml(getDeviceLogPath(deviceId), toml, log) } companion object { @@ -69,24 +71,3 @@ class WritingActivityDatasource( const val FILE_SUFFIX = ".toml" } } - -/** The `.activity` directory under [projectRoot]; the single owner of the path convention. */ -fun activityDirectory(projectRoot: Path): Path = - projectRoot / SceneDatasource.SCENE_DIRECTORY / WritingActivityDatasource.ACTIVITY_DIRECTORY - -/** - * Blocking, scope-less write of a device's activity log under [projectRoot]; callers own - * their threading. [WritingActivityDatasource.saveDeviceLog] delegates here; the - * example-project installer uses it directly because the project isn't loaded. - */ -fun writeDeviceLog( - projectRoot: Path, - deviceId: String, - log: DeviceLog, - fileSystem: FileSystem, - toml: Toml, -) { - val dir = activityDirectory(projectRoot) - fileSystem.createDirectories(dir) - fileSystem.writeToml(dir / "$deviceId${WritingActivityDatasource.FILE_SUFFIX}", toml, log) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/Http.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/Http.kt index 8fb883232..69355ff95 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/Http.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/Http.kt @@ -18,16 +18,14 @@ import io.ktor.client.request.forms.* import io.ktor.http.* import io.ktor.serialization.kotlinx.json.* import io.ktor.util.* -import kotlinx.serialization.json.Json import okio.IOException private val GlobalSettingsKey = AttributeKey("GlobalSettings") fun createHttpClient( globalSettingsStore: GlobalSettingsStore, - networkJson: Json, ): HttpClient { - val tokenRefreshClient = createRefreshClient(networkJson) + val tokenRefreshClient = createRefreshClient() val client = HttpClient(getHttpPlatformEngine()) { install(Logging) { @@ -43,7 +41,7 @@ fun createHttpClient( } install(ContentNegotiation) { - json(networkJson) + json() } installCompression() @@ -84,7 +82,7 @@ private fun loadTokens(globalSettingsStore: GlobalSettingsStore): BearerTokens? } } -private fun createRefreshClient(networkJson: Json): HttpClient { +private fun createRefreshClient(): HttpClient { return HttpClient(getHttpPlatformEngine()) { install(Logging) { logger = NapierHttpLogger() @@ -92,7 +90,7 @@ private fun createRefreshClient(networkJson: Json): HttpClient { } install(ContentNegotiation) { - json(networkJson) + json() } } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/MigratorModule.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/MigratorModule.kt index e167df6dd..eac23ceac 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/MigratorModule.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/MigratorModule.kt @@ -5,7 +5,6 @@ import com.darkrockstudios.apps.hammer.common.data.migrator.MigrateInlineAuthTok import com.darkrockstudios.apps.hammer.common.data.migrator.MigrateInstallIdToGlobal import com.darkrockstudios.apps.hammer.common.data.migrator.Migration0_1 import com.darkrockstudios.apps.hammer.common.data.migrator.Migration1_2 -import com.darkrockstudios.apps.hammer.common.data.migrator.Migration2_3 import org.koin.dsl.module import org.koin.plugin.module.dsl.factory @@ -13,7 +12,6 @@ val migratorModule = module { factory() factory() factory() - factory() factory() factory() } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/mainModule.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/mainModule.kt index dce6d2da8..35cab0b64 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/mainModule.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/mainModule.kt @@ -1,17 +1,12 @@ package com.darkrockstudios.apps.hammer.common.dependencyinjection import com.darkrockstudios.apps.hammer.base.di.dispatcherModule -import com.darkrockstudios.apps.hammer.base.http.NetworkJsonQualifier import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer -import com.darkrockstudios.apps.hammer.base.http.createNetworkJsonSerializer import com.darkrockstudios.apps.hammer.common.components.projecthome.ExportStoryUseCase import com.darkrockstudios.apps.hammer.common.components.projecthome.ImportStoryUseCase import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.account.AccountReauthUseCase import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogDatasource -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogRepository -import com.darkrockstudios.apps.hammer.common.data.changelog.ResourceChangelogDatasource import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftRepository import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource @@ -35,6 +30,8 @@ import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeasDatasour import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeasRepository import com.darkrockstudios.apps.hammer.common.data.ideasrepository.PromoteIdeaUseCase import com.darkrockstudios.apps.hammer.common.data.ideasrepository.StoryIdeaCodec +import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.ClientIdeasSynchronizer +import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeasSyncDatasource import com.darkrockstudios.apps.hammer.common.data.importer.MarkdownStoryImporter import com.darkrockstudios.apps.hammer.common.data.importer.RtfStoryImporter import com.darkrockstudios.apps.hammer.common.data.importer.StoryImporterRegistry @@ -50,7 +47,6 @@ import com.darkrockstudios.apps.hammer.common.data.projectstatistics.ProjectStat import com.darkrockstudios.apps.hammer.common.data.projectstatistics.StatisticsDatasource import com.darkrockstudios.apps.hammer.common.data.projectstatistics.StatisticsRepository import com.darkrockstudios.apps.hammer.common.data.projectstatistics.StatisticsService -import com.darkrockstudios.apps.hammer.common.data.protocolmismatch.ProtocolMismatchRepository import com.darkrockstudios.apps.hammer.common.data.references.AutoConfirmReferencesUseCase import com.darkrockstudios.apps.hammer.common.data.references.BackfillEntryReferencesUseCase import com.darkrockstudios.apps.hammer.common.data.references.CleanupReferencesOnEntryDeleteUseCase @@ -70,9 +66,6 @@ import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMe import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ClientAccountSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountUseCase -import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.ClientIdeasSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeasSyncDatasource import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ClientProjectSynchronizer import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.EntitySynchronizers import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncDataDatasource @@ -100,7 +93,9 @@ import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndexService import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineDatasource import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository import com.darkrockstudios.apps.hammer.common.data.versioncheck.GithubVersionCheckDataSource +import com.darkrockstudios.apps.hammer.common.data.versioncheck.ShouldNotifyOfUpdateUseCase import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckDataSource +import com.darkrockstudios.apps.hammer.common.data.protocolmismatch.ProtocolMismatchRepository import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository import com.darkrockstudios.apps.hammer.common.data.writingactivity.WritingActivityDatasource import com.darkrockstudios.apps.hammer.common.data.writingactivity.WritingActivityRepository @@ -116,13 +111,10 @@ import com.darkrockstudios.apps.hammer.common.platformMainDispatcher import com.darkrockstudios.apps.hammer.common.server.ProjectDataApi import com.darkrockstudios.apps.hammer.common.server.ServerAccountApi import com.darkrockstudios.apps.hammer.common.server.ServerAdminApi -import com.darkrockstudios.apps.hammer.common.server.ServerIdeasApi import com.darkrockstudios.apps.hammer.common.server.ServerProjectApi +import com.darkrockstudios.apps.hammer.common.server.ServerIdeasApi import com.darkrockstudios.apps.hammer.common.server.ServerProjectsApi import com.darkrockstudios.apps.hammer.common.server.WritingActivityApi -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryService -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import com.russhwolf.settings.Settings import io.ktor.client.HttpClient @@ -134,10 +126,10 @@ import okio.Path.Companion.toPath import org.koin.core.qualifier.named import org.koin.dsl.bind import org.koin.dsl.module -import org.koin.plugin.module.dsl.create +import org.koin.plugin.module.dsl.single import org.koin.plugin.module.dsl.factory import org.koin.plugin.module.dsl.scoped -import org.koin.plugin.module.dsl.single +import org.koin.plugin.module.dsl.create import kotlin.time.Clock const val DISPATCHER_MAIN = "main-dispatcher" @@ -177,53 +169,25 @@ val mainModule = module { includes(platformModule) single() - single { createHttpClient(get(), get(NetworkJsonQualifier)) } bind HttpClient::class + single { create(::createHttpClient) } bind HttpClient::class single() - single { - ServerProjectApi( - httpClient = get(), - globalSettingsStore = get(), - json = get(NetworkJsonQualifier), - strRes = get(), - ) - } + single() single() single() - single { - ProjectDataApi( - httpClient = get(), - globalSettingsStore = get(), - json = get(NetworkJsonQualifier), - strRes = get(), - ) - } - single { - ServerIdeasApi( - httpClient = get(), - globalSettingsStore = get(), - json = get(NetworkJsonQualifier), - strRes = get(), - ) - } + single() + single() single() single() bind ServerSettingsDatasource::class single() single() - // Only the protocol mismatch dialog checks GitHub, and only once the user has already - // connected to a sync server. Nothing on the app-load path may use this. - single { - GithubVersionCheckDataSource(http = get(), json = get(NetworkJsonQualifier)) - } bind VersionCheckDataSource::class + single() bind VersionCheckDataSource::class single() - - single() bind ChangelogDatasource::class - single() + factory() factory() factory() - factory() single(named(RAW_FILESYSTEM)) { getPlatformFilesystem() } bind FileSystem::class @@ -246,7 +210,6 @@ val mainModule = module { single { create(::createTomlSerializer) } bind Toml::class single { create(::createJsonSerializer) } bind Json::class - single(NetworkJsonQualifier) { createNetworkJsonSerializer() } single() single() @@ -266,7 +229,7 @@ val mainModule = module { single { StoryImporterRegistry(listOf(MarkdownStoryImporter(), RtfStoryImporter())) } scope { - scoped { checkNotNull(getSource()).projectDef } + scoped { get().projectDef } scoped() scoped() @@ -318,9 +281,6 @@ val mainModule = module { scoped() scoped() scoped() - scoped() - scoped() - factory() scoped() scoped() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/Api.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/Api.kt index 6e7b8d858..7eaadf406 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/Api.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/Api.kt @@ -15,9 +15,7 @@ import com.darkrockstudios.apps.hammer.network_request_failure_parse_body import com.darkrockstudios.apps.hammer.server_error_connection_generic import com.darkrockstudios.apps.hammer.server_error_connection_timeout import com.darkrockstudios.apps.hammer.server_error_dns -import com.darkrockstudios.apps.hammer.server_error_network_unavailable import com.darkrockstudios.apps.hammer.server_error_timeout -import com.darkrockstudios.apps.hammer.server_error_tls import com.darkrockstudios.apps.hammer.sync_general_error import com.darkrockstudios.apps.hammer.sync_unauthorized import io.github.aakira.napier.Napier @@ -153,49 +151,7 @@ abstract class Api( ) ) } catch (e: IOException) { - ioFailure(e, server.url, path, outerResponse) - } catch (@Suppress("TooGenericExceptionCaught") e: RuntimeException) { - // Only an unchecked IO wrapper lands here, which means the platform could not build its - // HTTP client at all, so the request never left the device. - ioFailure(e.asIoFailure() ?: throw e, server.url, path, outerResponse, local = true) - } - } - - private suspend fun ioFailure( - e: IOException, - serverUrl: String, - path: String, - outerResponse: HttpResponse?, - local: Boolean = false, - ): Result = when { - e.isTlsFailure() -> { - Napier.e("TLS Error", e) - Result.failure( - HttpFailureException( - statusCode = outerResponse?.status ?: HttpStatusCode.BadGateway, - error = HttpResponseError( - error = e.message ?: "TLS Error", - displayMessage = strRes.get(Res.string.server_error_tls, serverUrl), - ) - ) - ) - } - - local -> { - Napier.e("Network Unavailable", e) - Result.failure( - HttpFailureException( - statusCode = outerResponse?.status ?: HttpStatusCode.ServiceUnavailable, - error = HttpResponseError( - error = e.message ?: "Network Unavailable", - displayMessage = strRes.get(Res.string.server_error_network_unavailable), - ) - ) - ) - } - - else -> { - // Generic network error (connection refused, etc.) + // Generic network error (connection refused, SSL errors, etc.) Napier.e("Network Error", e) Result.failure( HttpFailureException( @@ -369,28 +325,44 @@ class TermsOfServiceRequiredException( typealias FailureHandler = suspend (HttpResponse) -> Throwable -suspend fun defaultFailureHandler(response: HttpResponse, strRes: StrRes): Throwable { - val error = try { - response.body() - } catch (e: NoTransformationFoundException) { - null.also { Napier.w("Error response body unable to be parsed", e) } - } catch (e: ContentConvertException) { - null.also { Napier.w("Error response body unable to be parsed", e) } - } - - if (error != null) return HttpFailureException(statusCode = response.status, error = error) - - // Only when the server said nothing usable. A 401 carrying "invalid email or - // password" must reach the user as that, not as the generic sync message. +private suspend fun unparseableErrorBody( + status: HttpStatusCode, + strRes: StrRes, + cause: Throwable, +): HttpFailureException { + Napier.w("Error response body unable to be parsed", cause) return HttpFailureException( - statusCode = response.status, + statusCode = status, error = HttpResponseError( - error = if (response.status == HttpStatusCode.Unauthorized) "Unauthorized" else "Unhandled error body", - displayMessage = if (response.status == HttpStatusCode.Unauthorized) { - strRes.get(Res.string.sync_unauthorized) - } else { - strRes.get(Res.string.sync_general_error) - }, + error = "Unhandled error body", + displayMessage = strRes.get(Res.string.sync_general_error), ) ) +} + +suspend fun defaultFailureHandler(response: HttpResponse, strRes: StrRes): Throwable { + return when(response.status) { + HttpStatusCode.Unauthorized -> { + HttpFailureException( + statusCode = response.status, + error = HttpResponseError( + error = "Unauthorized", + displayMessage = strRes.get(Res.string.sync_unauthorized), + ) + ) + } + else -> { + try { + val error = response.body() + HttpFailureException( + statusCode = response.status, + error = error + ) + } catch (e: NoTransformationFoundException) { + unparseableErrorBody(response.status, strRes, e) + } catch (e: ContentConvertException) { + unparseableErrorBody(response.status, strRes, e) + } + } + } } \ No newline at end of file diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.kt deleted file mode 100644 index 3f913fe4a..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.kt +++ /dev/null @@ -1,9 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -import okio.IOException - -/** - * The [IOException] this throwable is, or the one a platform hides behind an unchecked wrapper, - * or null when it is not an IO failure. - */ -expect fun Throwable.asIoFailure(): IOException? diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/ServerAccountApi.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/ServerAccountApi.kt index c65d42b2c..d03c22f49 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/ServerAccountApi.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/ServerAccountApi.kt @@ -76,19 +76,6 @@ class ServerAccountApi( } } - /** Mints a session for another of this user's installs, authorized by this install's bearer. */ - suspend fun pairInstall(installId: String): Result { - return post("/api/account/pair_install/$userId", parse = { it.body() }) { - setBody( - FormDataContent( - Parameters.build { - append("installId", installId) - } - ) - ) - } - } - suspend fun testAuth(): Result { return get("/api/account/test_auth/$userId") } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.kt deleted file mode 100644 index 7d4978285..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.kt +++ /dev/null @@ -1,13 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -/** - * True when this throwable, or anything it wraps, is a TLS handshake or certificate failure. - * - * Clients only ever speak HTTPS, so this is what a server reachable only over plain HTTP looks - * like from the client side, and it needs a different message than a generic network error. - */ -expect fun Throwable.isTlsFailure(): Boolean - -/** Walks the `cause` chain, bounded so a self-referential or cyclic cause cannot spin forever. */ -internal fun Throwable.causeChain(): Sequence = - generateSequence(this) { throwable -> throwable.cause?.takeIf { it !== throwable } }.take(16) diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizer.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizer.kt deleted file mode 100644 index 6a6186298..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizer.kt +++ /dev/null @@ -1,19 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -private val WHITESPACE = Regex("""\s+""") - -/** - * Splits entry names and aliases into single dictionary candidate words. - * The spell checker matches trimmed, lowercased single tokens only, so - * multi-word phrases must be split or they would silently never match. - * Surrounding punctuation is stripped ("Mr." -> "mr") while inner - * apostrophes and hyphens are kept ("d'Artagnan", "Jean-Luc"). - * Blank and single-character tokens are dropped. - */ -fun tokenizeDictionaryWords(phrases: Iterable): Set = - phrases.asSequence() - .flatMap { phrase -> phrase.splitToSequence(WHITESPACE) } - .map { token -> token.trim { c -> !c.isLetterOrDigit() } } - .filter { token -> token.length > 1 } - .map { token -> token.lowercase() } - .toSet() diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/LanguageMatching.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/LanguageMatching.kt deleted file mode 100644 index f335f86c9..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/LanguageMatching.kt +++ /dev/null @@ -1,27 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import com.darkrockstudios.apps.hammer.common.util.Locale - -/** - * Lenient locale match: languages must be equal; regions are compared only when - * both sides have one. So "en" matches "en-US", but "en-US" does not match "en-GB". - * Scripts are ignored: spell-check dictionaries are keyed by language+region only, - * so a zh-Hant project must still match a zh dictionary. - */ -fun localesMatchLeniently(a: Locale, b: Locale): Boolean { - if (a.language == null || b.language == null) return false - if (a.language != b.language) return false - val aRegion = a.region - val bRegion = b.region - return aRegion == null || bRegion == null || aRegion == bRegion -} - -/** - * Whether spell checking may run for a project written in [projectLanguageTag] - * (BCP-47, null/blank = unset) given the user's [dictionary] locale. An unset - * project language never gates spell check. - */ -fun isSpellCheckAllowedForProject(projectLanguageTag: String?, dictionary: Locale): Boolean { - if (projectLanguageTag.isNullOrBlank()) return true - return localesMatchLeniently(Locale.forLanguageTag(projectLanguageTag), dictionary) -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryService.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryService.kt deleted file mode 100644 index 203b01339..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryService.kt +++ /dev/null @@ -1,119 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.ProjectScoped -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectDefaultDispatcher -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.FlowPreview -import kotlinx.coroutines.async -import kotlinx.coroutines.awaitAll -import kotlinx.coroutines.cancel -import kotlinx.coroutines.coroutineScope -import kotlinx.coroutines.currentCoroutineContext -import kotlinx.coroutines.flow.combine -import kotlinx.coroutines.flow.debounce -import kotlinx.coroutines.flow.mapLatest -import kotlinx.coroutines.flow.onStart -import kotlinx.coroutines.isActive -import kotlinx.coroutines.launch -import org.koin.core.component.KoinComponent -import org.koin.core.scope.Scope -import org.koin.core.scope.ScopeCallback -import kotlin.time.Duration.Companion.milliseconds - -/** - * Feeds the project's user dictionary words, plus its Encyclopedia entry names and - * aliases, to the spell checker as session words for the lifetime of the project - * scope. Gated on spell check being enabled; the encyclopedia half is further gated - * on the global feature setting and the project's own toggle, all live-reactive. - */ -@OptIn(FlowPreview::class, ExperimentalCoroutinesApi::class) -class ProjectDictionaryService( - private val projectDef: ProjectDef, - private val encyclopediaRepository: EncyclopediaRepository, - private val projectSpellCheckRepository: ProjectSpellCheckRepository, - private val spellCheckRepository: SpellCheckRepository, -) : ScopeCallback, ProjectScoped, KoinComponent { - - override val projectScope = ProjectDefScope(projectDef) - - private val dispatcherDefault by injectDefaultDispatcher() - private val serviceScope = CoroutineScope(dispatcherDefault) - - init { - projectScope.scope.registerCallback(this) - } - - /** Starts watching for words to load; called from initializeProjectScope on project open. */ - fun initialize() { - serviceScope.launch { - // Entries are only re-read when one changes or the feature toggles; a user word - // edit unions into the cached set without touching the encyclopedia on disk. - val encyclopediaWords = combine( - projectSpellCheckRepository.encyclopediaDictionaryEnabled, - encyclopediaRepository.entryContentChangedFlow.onStart { emit(Unit) }, - ) { enabled, _ -> enabled } - .debounce(REBUILD_DEBOUNCE) - .mapLatest { enabled -> if (enabled) loadEncyclopediaWords() else emptySet() } - - combine( - projectSpellCheckRepository.spellCheckEnabled, - encyclopediaWords, - projectSpellCheckRepository.userDictionaryWords, - ) { spellCheckOn, encyclopedia, userWords -> - // Both the exact spelling and the tokenized form go in: the tokenizer lowercases, - // which is what the encyclopedia path relies on, but a mixed-case word like - // "McKinley" must also be accepted as typed. - if (spellCheckOn) encyclopedia + userWords + tokenizeDictionaryWords(userWords) else null - } - .debounce(REBUILD_DEBOUNCE) - .collect { words -> - // Never push words after onScopeClose has cleared them: close cancels this - // scope first, so a collect that raced past its last suspension bails here. - if (!currentCoroutineContext().isActive) return@collect - if (words != null) { - spellCheckRepository.setSessionWords(projectDef, words) - } else { - spellCheckRepository.clearSessionWords(projectDef) - } - } - } - } - - @Suppress("TooGenericExceptionCaught") // A failed reload must not kill the collector - private suspend fun loadEncyclopediaWords(): Set { - try { - // entryListFlow's replay cache is not refreshed by entry writes, so force a - // reload before reading defs - renames change EntryDef.name. - val defs = encyclopediaRepository.loadEntriesImperative() - return coroutineScope { - defs.map { def -> - async { - val entry = encyclopediaRepository.loadEntry(def).entry - if (entry.excludeFromDictionary) emptySet() - else tokenizeDictionaryWords(listOf(entry.name) + entry.aliases) - } - }.awaitAll() - }.flatMapTo(mutableSetOf()) { it } - } catch (e: CancellationException) { - throw e - } catch (t: Throwable) { - Napier.e("ProjectDictionaryService encyclopedia reload failed", t) - return emptySet() - } - } - - override fun onScopeClose(scope: Scope) { - serviceScope.cancel("ProjectDictionaryService closed") - spellCheckRepository.clearSessionWords(projectDef) - } - - private companion object { - val REBUILD_DEBOUNCE = 150.milliseconds - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryUseCase.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryUseCase.kt deleted file mode 100644 index 60429ae68..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectDictionaryUseCase.kt +++ /dev/null @@ -1,21 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository - -/** Edits the project's user dictionary words; every writer goes through [normalizeDictionaryWord]. */ -class ProjectDictionaryUseCase( - private val projectDataRepository: ProjectDataRepository, -) { - /** Input that normalizes to nothing storable, or a word already present in any case, is ignored. */ - suspend fun addWord(raw: String) { - val word = normalizeDictionaryWord(raw) ?: return - projectDataRepository.updateData { data -> - if (data.dictionaryWords.any { it.equals(word, ignoreCase = true) }) data - else data.copy(dictionaryWords = data.dictionaryWords + word) - } - } - - suspend fun removeWord(word: String) { - projectDataRepository.updateData { it.copy(dictionaryWords = it.dictionaryWords - word) } - } -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectSpellCheckRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectSpellCheckRepository.kt deleted file mode 100644 index ea2827505..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/ProjectSpellCheckRepository.kt +++ /dev/null @@ -1,72 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.ProjectScoped -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.combine -import kotlinx.coroutines.flow.distinctUntilChanged -import kotlinx.coroutines.flow.map -import kotlinx.coroutines.flow.onStart - -/** - * Project-aware view of the global [SpellCheckRepository]: the dictionary is withheld - * (null) while the project's declared language doesn't leniently match the user's - * spell-check dictionary locale. An unset project language never gates. - */ -class ProjectSpellCheckRepository( - spellCheckRepository: SpellCheckRepository, - globalSettingsStore: GlobalSettingsStore, - private val projectDataRepository: ProjectDataRepository, - val projectDef: ProjectDef, -) : ProjectScoped { - - override val projectScope = ProjectDefScope(projectDef) - - /** True while the project language allows the current dictionary locale. */ - val spellCheckAllowed: Flow = combine( - globalSettingsStore.globalSettingsUpdates, - projectDataRepository.state, - ) { settings, stored -> - isSpellCheckAllowedForProject(stored?.data?.language, settings.spellCheckSettings.locale) - } - .onStart { projectDataRepository.load() } - .distinctUntilChanged() - - /** [SpellCheckRepository.dictionaryFlow] gated on [spellCheckAllowed]. */ - val dictionaryFlow: Flow = combine( - spellCheckRepository.dictionaryFlow, - spellCheckAllowed, - ) { checker, allowed -> - if (allowed) checker else null - }.distinctUntilChanged() - - /** The global spell-check master switch. */ - val spellCheckEnabled: Flow = globalSettingsStore.globalSettingsUpdates - .map { it.spellCheckSettings.enabled } - .distinctUntilChanged() - - /** - * True while encyclopedia names feed the spell-check session dictionary: - * the global setting AND this project's own toggle. Gates the feature's - * per-entry UI as well as the word loading itself. - */ - val encyclopediaDictionaryEnabled: Flow = combine( - globalSettingsStore.globalSettingsUpdates, - projectDataRepository.state, - ) { settings, stored -> - settings.spellCheckSettings.includeEncyclopediaNames && - (stored?.data?.encyclopediaDictionary ?: true) - } - .onStart { projectDataRepository.load() } - .distinctUntilChanged() - - /** The project's user-added dictionary words. Cleaned on read: the stored set may come from sync. */ - val userDictionaryWords: Flow> = projectDataRepository.state - .map { stored -> normalizeStoredDictionaryWords(stored?.data?.dictionaryWords ?: emptySet()) } - .onStart { projectDataRepository.load() } - .distinctUntilChanged() -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/SpellCheckRepository.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/SpellCheckRepository.kt index 52b055d56..c09d90481 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/SpellCheckRepository.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/SpellCheckRepository.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.common.spellcheck -import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.dependencyinjection.injectDefaultDispatcher import com.darkrockstudios.apps.hammer.common.util.Locale @@ -9,13 +8,10 @@ import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory import com.darkrockstudios.libs.platformspellchecker.SpLocale import io.github.aakira.napier.Napier import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.SupervisorJob import kotlinx.coroutines.channels.BufferOverflow import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.launch -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock import org.koin.core.component.KoinComponent class SpellCheckRepository( @@ -24,8 +20,7 @@ class SpellCheckRepository( ) : KoinComponent { private val dispatcherDefault by injectDefaultDispatcher() - // Supervisor so a failing platform-checker call can't kill the settings collector. - private val scope = CoroutineScope(dispatcherDefault + SupervisorJob()) + private val scope = CoroutineScope(dispatcherDefault) private val _dictionaryFlow = MutableSharedFlow( replay = 1, @@ -36,80 +31,18 @@ class SpellCheckRepository( private var currentLanguage: Locale? = null private var currentEnabled: Boolean? = null - private val mutex = Mutex() - private var sessionWords: Map> = emptyMap() - private var appliedCandidates: Set = emptySet() - - /** - * Replaces [owner]'s session words. Held in-memory only (DictionaryScope.AppLocal), - * unioned across owners, and re-applied whenever a new checker is created. - * Non-suspend so it is callable from ScopeCallback.onScopeClose. - */ - fun setSessionWords(owner: ProjectDef, words: Set) { - scope.launch { - mutex.withLock { - if (sessionWords[owner] == words) return@withLock - sessionWords = sessionWords + (owner to words) - recreateCheckerWithSessionWords() - } - } - } - - fun clearSessionWords(owner: ProjectDef) { - scope.launch { - mutex.withLock { - if (owner !in sessionWords) return@withLock - sessionWords = sessionWords - owner - recreateCheckerWithSessionWords() - } - } - } - - /** - * Downstream editors only re-run a full scan when the checker identity changes, - * so word-set changes emit a fresh instance rather than mutating the current one. - */ - private suspend fun recreateCheckerWithSessionWords() { - val language = currentLanguage ?: return - if (sessionWordUnion() == appliedCandidates) return - - try { - val checker = spellCheckFactory.createSpellChecker(language.toSpLocale()) - applySessionWords(checker) - _dictionaryFlow.tryEmit(checker) - } catch (e: Exception) { - Napier.e("Spell Check: failed to apply session words", e) - } - } - - private fun sessionWordUnion(): Set = - sessionWords.values.flatMapTo(mutableSetOf()) { it } - - // Words the base dictionary already accepts are filtered, so only unknown spellings are added. - // appliedCandidates is only recorded on success, so a failed apply retries on the next push. - private suspend fun applySessionWords(checker: PlatformSpellChecker) { - val union = sessionWordUnion() - val toAdd = union.filterNot { checker.isWordCorrect(it) } - if (toAdd.isNotEmpty()) { - checker.setUserDictionary(toAdd) - Napier.i("Spell Check: applied ${toAdd.size} session words") - } - appliedCandidates = union - } - - private suspend fun applySpellCheckSettings(enabled: Boolean, language: Locale) = mutex.withLock { + private suspend fun applySpellCheckSettings(enabled: Boolean, language: Locale) { if (!enabled) { if (currentEnabled != false) { currentEnabled = false currentLanguage = null - appliedCandidates = emptySet() _dictionaryFlow.tryEmit(null) Napier.i("Spell Check disabled: dictionary cleared") } - return@withLock + return } - if (currentEnabled == true && currentLanguage == language) return@withLock + if (currentEnabled == true && currentLanguage == language) return val spLocale = language.toSpLocale() if (spellCheckFactory.hasLanguage(spLocale).not()) { @@ -118,13 +51,6 @@ class SpellCheckRepository( val checker = spellCheckFactory.createSpellChecker(spLocale) currentLanguage = language currentEnabled = true - try { - applySessionWords(checker) - } catch (e: Exception) { - // The checker still ships without session words; the stale - // appliedCandidates means the next push retries the apply. - Napier.e("Spell Check: failed to apply session words", e) - } _dictionaryFlow.tryEmit(checker) Napier.i("Spell Checker loaded for: ${language.toLanguageTag()}") diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWords.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWords.kt deleted file mode 100644 index a28a9c2fb..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWords.kt +++ /dev/null @@ -1,25 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import com.darkrockstudios.apps.hammer.common.data.tagindex.normalizeTagForm - -const val MAX_DICTIONARY_WORD_LENGTH = 64 - -/** - * The single normalization rule for user dictionary words: NFC form, trimmed, one token, - * bounded length. Case is kept as typed. Returns null for input that must not be stored. - */ -fun normalizeDictionaryWord(raw: String): String? { - val word = normalizeTagForm(raw.trim()) - if (word.isEmpty()) return null - if (word.any { it.isWhitespace() }) return null - if (word.length > MAX_DICTIONARY_WORD_LENGTH) return null - return word -} - -/** - * Normalizes stored words for the spell checker. Only a blank entry is dropped: a word a peer - * stored under different rules than [normalizeDictionaryWord] is still handed to the checker, - * so what Project Settings lists and what the checker accepts stay the same set. - */ -fun normalizeStoredDictionaryWords(words: Iterable): Set = - words.mapNotNullTo(mutableSetOf()) { word -> normalizeTagForm(word.trim()).takeIf { it.isNotEmpty() } } diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt deleted file mode 100644 index 84da0ed29..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt +++ /dev/null @@ -1,6 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -/** Enumerates every locale the platform knows about, for pickers that need the full list. */ -expect class AvailableLocalesProvider { - fun allLocales(): List -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffers.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffers.kt deleted file mode 100644 index e5e9c24a2..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffers.kt +++ /dev/null @@ -1,100 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -import okio.BufferedSource - -private const val REPLACEMENT = '�' - -/** - * Supplies the scratch a text scan reads into. Lets a reader fill buffers the caller owns and - * reuses, instead of handing back a freshly allocated string for every file. - */ -interface ScanBuffers { - /** A char buffer of at least [minCapacity]. May be larger, and may be the one from last time. */ - fun charBuffer(minCapacity: Int): CharArray - - /** A byte buffer of at least [minCapacity]. May be larger, and may be the one from last time. */ - fun byteBuffer(minCapacity: Int): ByteArray -} - -/** - * Reads up to [byteCount] bytes, decodes them as UTF-8 into [buffers]' char buffer, and returns how - * many chars landed there. - * - * The bytes are pulled in bulk and decoded from an array rather than a byte at a time: reading one - * byte at a time off a source costs more than the decode itself. - */ -fun BufferedSource.readUtf8Into(buffers: ScanBuffers, byteCount: Int): Int { - if (byteCount <= 0) return 0 - val bytes = buffers.byteBuffer(byteCount) - var read = 0 - while (read < byteCount) { - val n = read(bytes, read, byteCount - read) - if (n == -1) break - read += n - } - // UTF-8 never decodes to more UTF-16 chars than it has bytes, so this always fits. - return decodeUtf8(bytes, read, buffers.charBuffer(read)) -} - -/** - * Decodes the first [length] bytes of [bytes] as UTF-8 into [sink], returning the char count. - * Malformed input decodes to U+FFFD rather than throwing, matching how the rest of the app treats a - * damaged file: degraded, not fatal. - */ -internal fun decodeUtf8(bytes: ByteArray, length: Int, sink: CharArray): Int { - var i = 0 - var out = 0 - while (i < length && out < sink.size) { - val b0 = bytes[i].toInt() and 0xFF - i++ - - if (b0 < 0x80) { - sink[out++] = b0.toChar() - continue - } - - val needed = when { - b0 and 0xE0 == 0xC0 -> 1 - b0 and 0xF0 == 0xE0 -> 2 - b0 and 0xF8 == 0xF0 -> 3 - else -> -1 - } - if (needed < 0 || i + needed > length) { - sink[out++] = REPLACEMENT - continue - } - - var codePoint = when (needed) { - 1 -> b0 and 0x1F - 2 -> b0 and 0x0F - else -> b0 and 0x07 - } - var malformed = false - for (k in 0 until needed) { - val b = bytes[i + k].toInt() and 0xFF - if (b and 0xC0 != 0x80) { - malformed = true - break - } - codePoint = (codePoint shl 6) or (b and 0x3F) - } - if (malformed) { - sink[out++] = REPLACEMENT - continue - } - i += needed - - if (codePoint > 0x10FFFF) { - sink[out++] = REPLACEMENT - } else if (codePoint < 0x10000) { - sink[out++] = codePoint.toChar() - } else { - // Astral planes need a surrogate pair, the one case where a sequence yields two chars. - if (out + 1 >= sink.size) break - val v = codePoint - 0x10000 - sink[out++] = (0xD800 + (v shr 10)).toChar() - sink[out++] = (0xDC00 + (v and 0x3FF)).toChar() - } - } - return out -} diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReader.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReader.kt deleted file mode 100644 index 4297a155c..000000000 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReader.kt +++ /dev/null @@ -1,66 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -import okio.FileSystem -import okio.IOException -import okio.Path - -/** A crash dump found in the logs directory. */ -data class CrashReport( - val fileName: String, - val content: String, -) - -/** Whether this is one of the `crash-.txt` dumps the platform crash handlers write. */ -fun Path.isCrashDump(): Boolean = name.startsWith(CRASH_PREFIX) && name.endsWith(CRASH_SUFFIX) - -/** The crash time encoded in a crash dump's file name, or null when the name doesn't parse. */ -fun crashDumpMillis(fileName: String): Long? = - fileName.removePrefix(CRASH_PREFIX).removeSuffix(CRASH_SUFFIX).toLongOrNull() - -/** - * Reads the most recent `crash-*.txt` dump from [logDir], or null when there are none - * (or the directory is unreadable). - * - * Crash files are named `crash-.txt`; the millis come straight from the clock - * at crash time, so ordering by the parsed timestamp is reliable and portable. Files whose - * name doesn't parse fall back to their filesystem modified time. - */ -fun readLatestCrash(fileSystem: FileSystem, logDir: Path): CrashReport? { - val newest = try { - if (!fileSystem.exists(logDir)) return null - fileSystem.list(logDir) - .filter { it.isCrashDump() } - .mapNotNull { path -> - try { - if (fileSystem.metadata(path).isRegularFile) path to crashSortKey(fileSystem, path) else null - } catch (_: IOException) { - null - } - } - .maxByOrNull { it.second } - ?.first - } catch (_: IOException) { - null - } ?: return null - - val content = try { - fileSystem.read(newest) { readUtf8() } - } catch (_: IOException) { - return null - } - - return CrashReport(fileName = newest.name, content = content) -} - -private fun crashSortKey(fileSystem: FileSystem, path: Path): Long { - crashDumpMillis(path.name)?.let { return it } - - return try { - fileSystem.metadata(path).lastModifiedAtMillis ?: 0L - } catch (_: IOException) { - 0L - } -} - -private const val CRASH_PREFIX = "crash-" -private const val CRASH_SUFFIX = ".txt" diff --git a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/Locale.kt b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/Locale.kt index 669bd05f8..7e89688f3 100644 --- a/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/Locale.kt +++ b/common/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/util/Locale.kt @@ -1,58 +1,46 @@ package com.darkrockstudios.apps.hammer.common.util /** - * Minimal locale value type: a language plus optional script and region. Replaces + * Minimal locale value type: a language plus an optional region. Replaces * io.fluidsonic.locale, which dropped its Kotlin/Native (iOS) targets in 0.14.0. - * Variant and extension subtags are ignored. The script matters for languages - * written in more than one (zh-Hans vs zh-Hant, sr-Latn vs sr-Cyrl): dropping it - * would collapse distinct platform locales into one tag. + * We only ever model language + region, so script/variant subtags are ignored. */ class Locale private constructor( val language: String?, - val script: String?, val region: String?, ) { - fun toLanguageTag(): String = listOfNotNull(language, script, region).joinToString("-") + fun toLanguageTag(): String = listOfNotNull(language, region).joinToString("-") override fun equals(other: Any?): Boolean = - other is Locale && other.language == language && other.script == script && other.region == region + other is Locale && other.language == language && other.region == region - override fun hashCode(): Int = - 31 * (31 * (language?.hashCode() ?: 0) + (script?.hashCode() ?: 0)) + (region?.hashCode() ?: 0) + override fun hashCode(): Int = 31 * (language?.hashCode() ?: 0) + (region?.hashCode() ?: 0) override fun toString(): String = toLanguageTag() companion object { - val root = Locale(null, null, null) + val root = Locale(null, null) - fun forLanguage(language: String?, region: String? = null, script: String? = null): Locale = + fun forLanguage(language: String?, region: String? = null): Locale = Locale( language = language?.lowercase()?.ifBlank { null }, - script = script?.normalizeScript(), region = region?.uppercase()?.ifBlank { null }, ) - // Subset BCP-47: split on '-'/'_', take the language; the first 4-alpha subtag - // is the script, the first 2-alpha or 3-digit subtag is the region. Variants - // are ignored. Scanning stops at a single-char subtag — the extension/private-use + // Subset BCP-47: split on '-'/'_', take the language; the first 2-alpha or + // 3-digit subtag is the region. Script (4-alpha) and variants are ignored. + // Scanning stops at a single-char subtag — the extension/private-use // singleton ('u', 't', 'x') — so e.g. "de-u-co-phonebk" yields no region. fun forLanguageTag(tag: String): Locale { val parts = tag.split('-', '_').filter { it.isNotBlank() } if (parts.isEmpty()) return root - val subtags = parts.drop(1).takeWhile { it.length > 1 } - val script = subtags - .firstOrNull { it.matches(SCRIPT_ALPHA) } - ?.normalizeScript() - val region = subtags + val region = parts.drop(1) + .takeWhile { it.length > 1 } .firstOrNull { it.matches(REGION_ALPHA) || it.matches(REGION_NUMERIC) } ?.uppercase() - return Locale(parts[0].lowercase(), script, region) + return Locale(parts[0].lowercase(), region) } - private fun String.normalizeScript(): String? = - lowercase().replaceFirstChar { it.uppercase() }.ifBlank { null } - - private val SCRIPT_ALPHA = Regex("[A-Za-z]{4}") private val REGION_ALPHA = Regex("[A-Za-z]{2}") private val REGION_NUMERIC = Regex("[0-9]{3}") } diff --git a/common/src/commonMain/resources/raw/alice_in_wonderland_zip b/common/src/commonMain/resources/raw/alice_in_wonderland_zip index 2652d6d06..7d12b879a 100644 Binary files a/common/src/commonMain/resources/raw/alice_in_wonderland_zip and b/common/src/commonMain/resources/raw/alice_in_wonderland_zip differ diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRendererTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRendererTest.kt index 3c781a588..3f60270f4 100644 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRendererTest.kt +++ b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/RtfStoryRendererTest.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.common.components.projecthome import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectTheme -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import com.darkrockstudios.apps.hammer.common.data.ImportOptions import com.darkrockstudios.apps.hammer.common.data.RtfSplitStrategy import com.darkrockstudios.apps.hammer.common.data.importer.PreviewItem @@ -19,7 +17,6 @@ class RtfStoryRendererTest { chapters: List, projectName: String = "Test Project", projectData: ProjectData = ProjectData(authorName = "Test Author"), - options: ExportOptions = ExportOptions(), ): String { val buffer = Buffer() val author = projectData.authorName?.takeIf { it.isNotBlank() } @@ -29,47 +26,10 @@ class RtfStoryRendererTest { projectData = projectData, chapters = chapters, strings = ExportStrings(contentsTitle = "Contents", authorByline = author?.let { "by $it" }), - options = options, ) return buffer.readByteArray().decodeToString() } - @Test - fun `every authored line becomes its own paragraph`() { - val rtf = render(listOf(StoryChapter("Alpha", "line one\nline two"))) - - // \fi360 opens a body paragraph; two lines means two of them. - assertEquals(2, Regex("""\\fi360""").findAll(rtf).count(), rtf) - assertTrue(rtf.contains("line one"), rtf) - assertTrue(rtf.contains("line two"), rtf) - } - - @Test - fun `lines that run on into each other lose the gaps between them`() { - val chapter = render(listOf(StoryChapter("Alpha", "line one\nline two\nline three"))) - // Isolate the chapter body: the front matter has paragraphs of its own. - val rtf = chapter.substring(chapter.indexOf("line one")) - - // Only the last line leaves prose behind and so earns a gap after it. - assertEquals( - 1, - Regex("""\\sa[1-9]""").findAll(rtf).count(), - "Prose that runs on into more prose must not push the next line down: $rtf", - ) - } - - @Test - fun `a blank line between passages becomes an empty paragraph`() { - val tight = render(listOf(StoryChapter("Alpha", "First passage.\nSecond passage."))) - val parted = render(listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage."))) - - assertEquals( - Regex("""\\fi360""").findAll(tight).count() + 1, - Regex("""\\fi360""").findAll(parted).count(), - "A blank line should add one empty body paragraph", - ) - } - /** Counts brace nesting, ignoring the backslash-escaped `\{` and `\}` that appear in body text. */ private fun braceBalance(rtf: String): Int { var depth = 0 @@ -120,13 +80,12 @@ class RtfStoryRendererTest { } @Test - fun `chapters are bookmarked for the contents links and numbered on request`() { + fun `chapters are numbered and bookmarked for the contents links`() { val rtf = render( listOf( StoryChapter("Alpha", "First."), StoryChapter("Beta", "Second."), - ), - options = ExportOptions(numberChapters = true), + ) ) assertTrue(rtf.contains("1. Alpha"), "First chapter should be numbered") @@ -135,42 +94,6 @@ class RtfStoryRendererTest { assertTrue(rtf.contains("HYPERLINK \\\\l \"chapter1\""), "Contents should link to chapter bookmarks") } - @Test - fun `chapters are unnumbered by default`() { - val rtf = render( - listOf( - StoryChapter("Prologue", "First."), - StoryChapter("Chapter 1", "Second."), - ), - ) - - assertTrue(rtf.contains("Prologue"), rtf) - assertTrue(!rtf.contains("1. Prologue"), "Chapter titles should not be numbered") - assertTrue(!rtf.contains("2. Chapter 1"), "Chapter titles should not be numbered") - } - - @Test - fun `the chosen font is the document font`() { - val rtf = render( - listOf(StoryChapter("Alpha", "Some text.")), - options = ExportOptions(font = ExportFont.CourierNew), - ) - - assertTrue(rtf.contains("Courier New"), rtf) - assertTrue(!rtf.contains("Georgia"), rtf) - } - - @Test - fun `blank lines between paragraphs can be skipped`() { - val chapters = listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage.")) - - val kept = render(chapters) - assertEquals(3, Regex("""\\fi360""").findAll(kept).count(), kept) - - val skipped = render(chapters, options = ExportOptions(keepBlankLines = false)) - assertEquals(2, Regex("""\\fi360""").findAll(skipped).count(), skipped) - } - @Test fun `markdown emphasis becomes RTF bold and italic`() { val rtf = render(listOf(StoryChapter("Alpha", "A **bold** and _italic_ word."))) diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommonTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommonTest.kt new file mode 100644 index 000000000..4b2d53953 --- /dev/null +++ b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/components/projecthome/StoryExportCommonTest.kt @@ -0,0 +1,39 @@ +package com.darkrockstudios.apps.hammer.common.components.projecthome + +import kotlin.test.Test +import kotlin.test.assertEquals + +class StoryExportCommonTest { + + @Test + fun `text without a backslash is returned unchanged`() { + val input = "Plain prose, no escapes." + assertEquals(input, unescapeMarkdown(input)) + } + + @Test + fun `backslash before ASCII punctuation resolves to the bare character`() { + assertEquals("*", unescapeMarkdown("\\*")) + assertEquals("_", unescapeMarkdown("\\_")) + assertEquals("#", unescapeMarkdown("\\#")) + assertEquals("\\", unescapeMarkdown("\\\\")) + assertEquals("[link]", unescapeMarkdown("\\[link\\]")) + } + + @Test + fun `emphasis markers are unescaped inside a sentence`() { + assertEquals("use *stars* and _unders_", unescapeMarkdown("use \\*stars\\* and \\_unders\\_")) + } + + @Test + fun `a backslash before a non-punctuation character is preserved`() { + // Only ASCII punctuation is a valid CommonMark escape; everything else keeps the backslash. + assertEquals("\\a", unescapeMarkdown("\\a")) + assertEquals("C:\\temp", unescapeMarkdown("C:\\temp")) + } + + @Test + fun `a trailing backslash is preserved`() { + assertEquals("end\\", unescapeMarkdown("end\\")) + } +} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporterTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporterTest.kt index 840fdb9b2..d10521de9 100644 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporterTest.kt +++ b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/MarkdownStoryImporterTest.kt @@ -1,8 +1,7 @@ package com.darkrockstudios.apps.hammer.common.data.importer -import com.darkrockstudios.apps.hammer.common.data.DEFAULT_CHAPTER_PATTERN +import com.darkrockstudios.apps.hammer.common.data.ChapterHeadingLevel import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy import kotlin.test.Test import kotlin.test.assertEquals import kotlin.test.assertTrue @@ -13,17 +12,15 @@ class MarkdownStoryImporterTest { private fun preview( content: String, - strategy: MarkdownSplitStrategy = MarkdownSplitStrategy.H1, + level: ChapterHeadingLevel = ChapterHeadingLevel.H1, groups: Boolean = false, sourceName: String = "story", - pattern: String = DEFAULT_CHAPTER_PATTERN, ) = importer.preview( sourceName = sourceName, content = content.encodeToByteArray(), options = ImportOptions( - markdownSplitStrategy = strategy, + chapterHeadingLevel = level, createChapterGroups = groups, - markdownChapterPattern = pattern, ), ) @@ -79,7 +76,7 @@ class MarkdownStoryImporterTest { ## Real Chapter Chapter body. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(1, result.items.size) val group = result.items[0] as PreviewItem.Group assertEquals("Outer Title", group.name) @@ -96,7 +93,7 @@ class MarkdownStoryImporterTest { ## Real Chapter Chapter body. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(1, result.items.size) val group = result.items[0] as PreviewItem.Group assertEquals("Outer Title", group.name) @@ -115,7 +112,7 @@ class MarkdownStoryImporterTest { ### A subsection More text. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(1, result.items.size) val scene = result.items[0] as PreviewItem.Scene assertEquals("Chapter One", scene.name) @@ -135,7 +132,7 @@ class MarkdownStoryImporterTest { ## Chapter C c body """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(2, result.items.size) val partOne = result.items[0] as PreviewItem.Group assertEquals("Part One", partOne.name) @@ -154,7 +151,7 @@ class MarkdownStoryImporterTest { ## Chapter B b body """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(2, result.items.size) val sceneA = result.items[0] as PreviewItem.Scene assertEquals("Chapter A", sceneA.name) @@ -171,7 +168,7 @@ class MarkdownStoryImporterTest { # Chapter Two b """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H1) + val result = preview(md, level = ChapterHeadingLevel.H1) assertEquals(2, result.items.size) assertTrue(result.items.all { it is PreviewItem.Scene }) assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) @@ -314,7 +311,7 @@ class MarkdownStoryImporterTest { Chapter two body. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) + val result = preview(md, level = ChapterHeadingLevel.H2) assertEquals(1, result.items.size) val group = result.items[0] as PreviewItem.Group assertEquals("My Novel", group.name) @@ -336,7 +333,7 @@ class MarkdownStoryImporterTest { ## Chapter Two Second. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) + val result = preview(md, level = ChapterHeadingLevel.Auto) assertEquals("My Novel", result.title) assertEquals(2, result.items.size) assertTrue(result.items.all { it is PreviewItem.Scene }) @@ -352,7 +349,7 @@ class MarkdownStoryImporterTest { # Chapter Two b """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) + val result = preview(md, level = ChapterHeadingLevel.Auto) assertEquals(null, result.title) assertEquals(2, result.items.size) assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) @@ -371,7 +368,7 @@ class MarkdownStoryImporterTest { ### Chapter C c """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) + val result = preview(md, level = ChapterHeadingLevel.Auto) assertEquals("My Novel", result.title) assertEquals(2, result.items.size) val partOne = result.items[0] as PreviewItem.Group @@ -388,349 +385,13 @@ class MarkdownStoryImporterTest { Just prose, no chapters. More prose. """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) + val result = preview(md, level = ChapterHeadingLevel.Auto) assertEquals("My Novel", result.title) assertEquals(1, result.items.size) val scene = result.items[0] as PreviewItem.Scene assertTrue(scene.markdown.contains("Just prose, no chapters.")) } - @Test - fun `Setext equals underline is an H1 chapter`() { - val md = """ - Chapter One - =========== - First. - - Chapter Two - === - Second. - """.trimIndent() - val result = preview(md) - assertEquals(2, result.items.size) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - assertEquals("First.", (result.items[0] as PreviewItem.Scene).markdown) - assertEquals("Second.", (result.items[1] as PreviewItem.Scene).markdown) - } - - @Test - fun `Setext dash underline is an H2 chapter`() { - val md = """ - Chapter One - ----------- - First. - - Chapter Two - ----------- - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.H2) - assertEquals(2, result.items.size) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Setext underline is dropped from the scene body`() { - val md = "Chapter One\n===\nFirst." - val result = preview(md) - val scene = result.items[0] as PreviewItem.Scene - assertEquals("First.", scene.markdown) - } - - @Test - fun `Dash rule with no paragraph above it is a thematic break not a heading`() { - val md = """ - Scene one ends. - - --- - - Scene two begins. - """.trimIndent() - val result = preview(md, sourceName = "story") - assertEquals(1, result.items.size) - val scene = result.items[0] as PreviewItem.Scene - assertEquals("story", scene.name) - assertTrue(scene.markdown.contains("---")) - } - - @Test - fun `Front matter fence is not a heading`() { - val md = """ - --- - title: My Novel - --- - - # Chapter One - First. - """.trimIndent() - val result = preview(md) - assertEquals(2, result.items.size) - assertEquals("Untitled", result.items[0].name) - assertTrue((result.items[0] as PreviewItem.Scene).markdown.contains("title: My Novel")) - assertEquals("Chapter One", result.items[1].name) - } - - @Test - fun `Auto treats a Setext equals title above Setext dash chapters as the story title`() { - val md = """ - My Novel - ======== - - Chapter One - ----------- - First. - - Chapter Two - ----------- - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals("My Novel", result.title) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Mixed Setext and ATX headings share the same level space`() { - val md = """ - # Chapter One - First. - Chapter Two - =========== - Second. - """.trimIndent() - val result = preview(md) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Setext CRLF line endings are normalized`() { - val md = "Chapter One\r\n===\r\nFirst.\r\n\r\nChapter Two\r\n===\r\nSecond.\r\n" - val result = preview(md) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - assertEquals("First.", (result.items[0] as PreviewItem.Scene).markdown) - } - - @Test - fun `A Setext title indented four spaces is not a heading`() { - val md = " Chapter One\n===\nFirst." - val result = preview(md, sourceName = "story") - assertEquals(1, result.items.size) - assertEquals("story", result.items[0].name) - } - - @Test - fun `Bold-only lines split a document that has no markdown headings`() { - val md = """ - **Chapter One** - - First. - - **Chapter Two** - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals(null, result.title) - assertEquals(2, result.items.size) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - assertEquals("First.", (result.items[0] as PreviewItem.Scene).markdown) - } - - @Test - fun `Underscore bold-only lines are chapters too`() { - val md = "__Chapter One__\nFirst.\n__Chapter Two__\nSecond." - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Bold chapters below a heading title keep the title out of the scenes`() { - val md = """ - # My Novel - - **Chapter One** - - First. - - **Chapter Two** - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals("My Novel", result.title) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Bold chapters can be wrapped in chapter groups`() { - val md = "**Chapter One**\nFirst.\n**Chapter Two**\nSecond." - val result = preview(md, strategy = MarkdownSplitStrategy.Auto, groups = true) - assertEquals(2, result.items.size) - val group = result.items[0] as PreviewItem.Group - assertEquals("Chapter One", group.name) - assertEquals(listOf("Chapter One"), group.scenes.map { it.name }) - } - - @Test - fun `Bold text with prose on the same line is not a chapter`() { - val md = """ - **Chapter One** - - **She** ran, and the world went quiet. - - **Chapter Two** - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals(2, result.items.size) - val scene = result.items[0] as PreviewItem.Scene - assertEquals("Chapter One", scene.name) - assertTrue(scene.markdown.contains("**She** ran")) - } - - @Test - fun `A long bold-only line is prose not a chapter`() { - val md = """ - **Chapter One** - - **And then she said all of the many things she had been holding back for years and years.** - - **Chapter Two** - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals(2, result.items.size) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - assertTrue((result.items[0] as PreviewItem.Scene).markdown.contains("**And then she said")) - } - - @Test - fun `A lone bold-only line is prose not a chapter`() { - val md = """ - # Chapter One - First. - - **A bolded aside** - - More. - - # Chapter Two - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - assertEquals(2, result.items.size) - val scene = result.items[0] as PreviewItem.Scene - assertEquals("Chapter One", scene.name) - assertTrue(scene.markdown.contains("**A bolded aside**")) - } - - @Test - fun `Explicitly choosing H1 does not fall back to bold lines`() { - val md = "**Chapter One**\nFirst.\n**Chapter Two**\nSecond." - val result = preview(md, strategy = MarkdownSplitStrategy.H1, sourceName = "story") - assertEquals(1, result.items.size) - assertEquals("story", result.items[0].name) - } - - @Test - fun `Pattern strategy splits on lines matching the user regex`() { - val md = """ - Chapter One - - First. - - Chapter Two - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern) - assertEquals(2, result.items.size) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - assertEquals("First.", (result.items[0] as PreviewItem.Scene).markdown) - } - - @Test - fun `Pattern strategy sees through bold and heading markers`() { - val md = """ - **Chapter One** - - First. - - ## Chapter Two - - Second. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern) - assertEquals(listOf("Chapter One", "Chapter Two"), result.items.map { it.name }) - } - - @Test - fun `Pattern strategy ignores lines the regex does not match`() { - val md = """ - Scene Break - - First. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern, sourceName = "story") - assertEquals(1, result.items.size) - assertEquals("story", result.items[0].name) - } - - @Test - fun `Pattern strategy with an invalid regex falls back to a single scene`() { - val md = "Chapter One\n\nFirst." - val result = preview( - md, - strategy = MarkdownSplitStrategy.Pattern, - pattern = "[", - sourceName = "story", - ) - assertEquals(1, result.items.size) - assertEquals("story", result.items[0].name) - } - - @Test - fun `Pattern strategy keeps a Setext underline out of the scene body`() { - val md = """ - Chapter One - =========== - First. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern) - assertEquals(1, result.items.size) - assertEquals("Chapter One", result.items[0].name) - assertEquals("First.", (result.items[0] as PreviewItem.Scene).markdown) - } - - @Test - fun `Pattern strategy with a blank pattern falls back to a single scene`() { - val md = "Chapter One\n\nFirst." - val result = preview( - md, - strategy = MarkdownSplitStrategy.Pattern, - pattern = "", - sourceName = "story", - ) - assertEquals(1, result.items.size) - assertEquals("story", result.items[0].name) - } - - @Test - fun `Pattern strategy overrides markdown headings`() { - val md = """ - # Foreword - Front matter prose. - # Chapter One - First. - """.trimIndent() - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern) - assertEquals(2, result.items.size) - assertEquals("Untitled", result.items[0].name) - assertEquals("Chapter One", result.items[1].name) - } - @Test fun `totalScenes counts scenes across mixed groups and scenes`() { val md = """ diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/OversizedSceneWarningTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/OversizedSceneWarningTest.kt deleted file mode 100644 index 3d8b5eba4..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/OversizedSceneWarningTest.kt +++ /dev/null @@ -1,147 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.importer - -import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy -import kotlinx.serialization.json.Json -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class OversizedSceneWarningTest { - - private val importer = MarkdownStoryImporter() - - private fun words(count: Int): String = "word ".repeat(count) - - private fun preview( - content: String, - groups: Boolean = false, - strategy: MarkdownSplitStrategy = MarkdownSplitStrategy.H1, - ) = importer.preview( - sourceName = "story", - content = content.encodeToByteArray(), - options = ImportOptions(markdownSplitStrategy = strategy, createChapterGroups = groups), - ) - - @Test - fun `A whole manuscript collapsed into one scene is flagged`() { - val result = preview(words(LARGE_SCENE_WORD_COUNT + 500)) - - assertEquals(1, result.totalScenes) - val flagged = result.oversizedScenes.single() - assertEquals(LARGE_SCENE_WORD_COUNT + 500, flagged.wordCount) - } - - @Test - fun `Chapters that split correctly are not flagged`() { - val md = (1..5).joinToString("\n") { "# Chapter $it\n${words(2_000)}" } - - val result = preview(md) - - assertEquals(5, result.totalScenes) - assertTrue(result.oversizedScenes.isEmpty()) - } - - @Test - fun `A scene exactly at the threshold is flagged`() { - val result = preview(words(LARGE_SCENE_WORD_COUNT)) - - assertEquals(LARGE_SCENE_WORD_COUNT, result.oversizedScenes.single().wordCount) - } - - @Test - fun `A scene one word under the threshold is not flagged`() { - val result = preview(words(LARGE_SCENE_WORD_COUNT - 1)) - - assertTrue(result.oversizedScenes.isEmpty()) - } - - @Test - fun `Only the oversized chapter of a mixed import is flagged`() { - val md = buildString { - appendLine("# Chapter One") - appendLine(words(500)) - appendLine("# Chapter Two") - appendLine(words(LARGE_SCENE_WORD_COUNT + 1)) - appendLine("# Chapter Three") - appendLine(words(500)) - } - - val result = preview(md) - - assertEquals(3, result.totalScenes) - assertEquals(listOf("Chapter Two"), result.oversizedScenes.map { it.name }) - } - - @Test - fun `An oversized scene nested in a chapter group is flagged`() { - val md = "# Chapter One\n${words(LARGE_SCENE_WORD_COUNT + 1)}" - - val result = preview(md, groups = true) - - assertTrue(result.items.single() is PreviewItem.Group) - assertEquals(listOf("Chapter One"), result.oversizedScenes.map { it.name }) - } - - @Test - fun `An empty preview flags nothing`() { - assertTrue(preview("").oversizedScenes.isEmpty()) - } - - @Test - fun `Scenes split by Setext headings carry their word count`() { - val md = """ - Chapter One - =========== - - ${words(500)} - - Chapter Two - =========== - - ${words(LARGE_SCENE_WORD_COUNT + 1)} - """.trimIndent() - - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - - assertEquals(2, result.totalScenes) - assertEquals(listOf("Chapter Two"), result.oversizedScenes.map { it.name }) - } - - @Test - fun `A Setext title with no chapters collapses to one flagged scene`() { - val md = "The Long Walk Home\n==================\n\n${words(LARGE_SCENE_WORD_COUNT + 1)}" - - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - - assertEquals(LARGE_SCENE_WORD_COUNT + 1, result.oversizedScenes.single().wordCount) - } - - @Test - fun `Scenes split by a bold chapter title carry their word count`() { - val md = (1..4).joinToString("\n") { "**Chapter $it**\n${words(3_000)}" } + - "\n**Chapter Five**\n${words(LARGE_SCENE_WORD_COUNT + 1)}" - - val result = preview(md, strategy = MarkdownSplitStrategy.Auto) - - assertEquals(listOf("Chapter Five"), result.oversizedScenes.map { it.name }) - } - - @Test - fun `Scenes split by the chapter pattern carry their word count`() { - val md = "Chapter One\n${words(500)}\nChapter Two\n${words(LARGE_SCENE_WORD_COUNT + 1)}" - - val result = preview(md, strategy = MarkdownSplitStrategy.Pattern) - - assertEquals(listOf("Chapter Two"), result.oversizedScenes.map { it.name }) - } - - @Test - fun `Word count is derived on decode rather than carried in the serialized form`() { - val decoded = Json.decodeFromString( - """{"name":"Chapter One","markdown":"one two three"}""", - ) - - assertEquals(3, decoded.wordCount) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporterTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporterTest.kt index 8ce960c2c..dbfc3aaac 100644 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporterTest.kt +++ b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/importer/RtfStoryImporterTest.kt @@ -2,9 +2,6 @@ package com.darkrockstudios.apps.hammer.common.data.importer import com.darkrockstudios.apps.hammer.common.data.ImportOptions import com.darkrockstudios.apps.hammer.common.data.RtfSplitStrategy -import org.intellij.markdown.flavours.gfm.GFMFlavourDescriptor -import org.intellij.markdown.html.HtmlGenerator -import org.intellij.markdown.parser.MarkdownParser import kotlin.test.Test import kotlin.test.assertEquals import kotlin.test.assertFalse @@ -32,16 +29,6 @@ class RtfStoryImporterTest { ), ) - /** Imports [body] as one unsplit scene, so assertions see the paragraph Markdown verbatim. */ - private fun singleScene(body: String): PreviewItem.Scene = - preview(body, strategy = RtfSplitStrategy.SingleScene).items[0] as PreviewItem.Scene - - private fun renderHtml(markdown: String): String { - val flavour = GFMFlavourDescriptor() - val parsed = MarkdownParser(flavour).buildMarkdownTreeFromString(markdown) - return HtmlGenerator(markdown, parsed, flavour).generateHtml() - } - @Test fun `Formatting splits chapters by outline level into groups and scenes`() { val body = """ @@ -124,106 +111,6 @@ class RtfStoryImporterTest { assertTrue(scene.markdown.contains("**strong**"), "Expected bold markdown, was: ${scene.markdown}") } - @Test - fun `Bold run whose whitespace is inside the run keeps the delimiters tight`() { - val scene = singleScene("""\fs24 A\b strong \b0 word.\par""") - - assertEquals("A **strong** word.", scene.markdown) - } - - @Test - fun `Bold run with trailing space before the paragraph end keeps the delimiters tight`() { - val scene = singleScene("""\fs24 She said \b run \b0\par""") - - assertEquals("She said **run**", scene.markdown) - } - - @Test - fun `Emphasis run of only whitespace emits no delimiters`() { - val scene = singleScene("""\fs24 word\b \b0 next.\par""") - - assertEquals("word next.", scene.markdown) - } - - @Test - fun `Bold spanning a tab keeps the delimiters against the text`() { - val scene = singleScene("""\fs24 A\b strong\tab\tab\b0 word.\par""") - - assertEquals("A **strong**\t\tword.", scene.markdown) - } - - @Test - fun `Bold ended by a group close keeps the delimiters tight`() { - val scene = singleScene("""\fs24 A {\b strong }word.\par""") - - assertEquals("A **strong** word.", scene.markdown) - } - - @Test - fun `Emphasis is closed at a hard line break`() { - val scene = singleScene("""\fs24 \b first\line second \b0 last.\par""") - - assertEquals("**first** \n**second** last.", scene.markdown) - } - - @Test - fun `Overlapping bold and italic runs stay balanced`() { - val scene = singleScene("""\fs24 \i one \b two \i0 three \b0 four.\par""") - - assertEquals("*one **two*** **three** four.", scene.markdown) - } - - @Test - fun `Italic uses asterisks so intra-word emphasis renders`() { - val scene = singleScene("""\fs24 foo\i bar\i0 baz.\par""") - - assertEquals("foo*bar*baz.", scene.markdown) - } - - @Test - fun `Nested bold and italic close inside the trailing whitespace`() { - val scene = singleScene("""\fs24 A \b\i very loud \i0\b0 word.\par""") - - assertEquals("A ***very loud*** word.", scene.markdown) - } - - @Test - fun `Emphasis that ends with the paragraph is still closed`() { - val scene = singleScene("""\fs24 He was \i gone\par""") - - assertEquals("He was *gone*", scene.markdown) - } - - @Test - fun `A paragraph starting with a dash is escaped instead of importing as a list`() { - val scene = singleScene("""\fs24 - a spoken line.\par""") - - assertEquals("\\- a spoken line.", scene.markdown) - } - - @Test - fun `A paragraph starting with a number is escaped instead of importing as a list`() { - val scene = singleScene("""\fs24 1. Never speak of it.\par""") - - assertEquals("1\\. Never speak of it.", scene.markdown) - } - - @Test - fun `Markdown special characters in prose are escaped`() { - val scene = singleScene("""\fs24 Wait! (really) 1+1 a|b\par""") - - assertEquals("Wait\\! \\(really\\) 1\\+1 a\\|b", scene.markdown) - } - - @Test - fun `Emphasis with whitespace inside the run renders as emphasis`() { - val scene = singleScene("""\fs24 She said \b run \b0 and\i then\i0 fled.\par""") - - val html = renderHtml(scene.markdown) - assertTrue(html.contains("run"), "Expected bold to render, was: $html") - assertTrue(html.contains("then"), "Expected italics to render, was: $html") - } - @Test fun `createChapterGroups wraps single-tier scenes in groups`() { val body = """ diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMergeTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMergeTest.kt deleted file mode 100644 index cb4546bdd..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectdata/ProjectDataMergeTest.kt +++ /dev/null @@ -1,60 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.projectdata - -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class ProjectDataMergeTest { - - @Test - fun `merged dictionary words are the union of both sides`() { - val local = ProjectData(dictionaryWords = setOf("Kvothe")) - val server = ProjectData(dictionaryWords = setOf("Denna", "Imre")) - - assertEquals(setOf("Kvothe", "Denna", "Imre"), mergeDictionaryWords(local, server)) - } - - @Test - fun `merging keeps a word this build would not accept as input`() { - // The merged set is uploaded, so stripping it here would delete a newer build's word - // server-side for every other device. - val local = ProjectData(dictionaryWords = setOf("Kvothe")) - val server = ProjectData(dictionaryWords = setOf("Chandrian sign")) - - assertEquals(setOf("Kvothe", "Chandrian sign"), mergeDictionaryWords(local, server)) - } - - @Test - fun `differsOutsideDictionary ignores the dictionary and nothing else`() { - val base = ProjectData(authorName = "Pat", dictionaryWords = setOf("a")) - - assertFalse(base.differsOutsideDictionary(base.copy(dictionaryWords = setOf("b")))) - assertTrue(base.differsOutsideDictionary(base.copy(authorName = "Sam"))) - } - - @Test - fun `reapplyLocalEdits keeps changed fields and takes the rest from incoming`() { - val base = ProjectData(authorName = "Pat", language = "en") - val local = base.copy(authorName = "Edited") - val incoming = ProjectData(authorName = "Server", language = "fr") - - assertEquals( - ProjectData(authorName = "Edited", language = "fr"), - reapplyLocalEdits(base, local, incoming), - ) - } - - @Test - fun `reapplyLocalEdits carries dictionary additions and removals as a delta`() { - val base = ProjectData(dictionaryWords = setOf("keep", "drop")) - val local = base.copy(dictionaryWords = setOf("keep", "added")) - val incoming = ProjectData(dictionaryWords = setOf("keep", "drop", "server")) - - assertEquals( - setOf("keep", "server", "added"), - reapplyLocalEdits(base, local, incoming).dictionaryWords, - ) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownContainsTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownContainsTest.kt deleted file mode 100644 index a15f98212..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownContainsTest.kt +++ /dev/null @@ -1,50 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import kotlin.test.Test -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class MarkdownContainsTest { - - @Test - fun `a query matches text stored with escapes`() { - assertTrue(markdownContains("A well\\-known secret", "well-known")) - assertTrue(markdownContains("Alice \\(the elder\\) waited", "Alice (the elder)")) - } - - @Test - fun `a phrase spanning an escape matches`() { - assertTrue(markdownContains("the well\\-known road home", "known road")) - } - - @Test - fun `matching is case insensitive`() { - assertTrue(markdownContains("A Well\\-Known secret", "well-known")) - } - - @Test - fun `the query is taken literally rather than as markdown`() { - // Searching the storage form is deliberately unsupported: readers type what they see. - assertFalse(markdownContains("A well\\-known secret", "well\\-known")) - } - - @Test - fun `markers that survive the projection are matched where they sit`() { - assertTrue(markdownContains("The cost is 5*4 today", "5*4")) - assertTrue(markdownContains("the user_name field", "user_name")) - } - - @Test - fun `markers the projection removes are not findable by typing them`() { - // The query is literal text matched against the prose on screen, which has no asterisks in it. - assertFalse(markdownContains("a **Chapter** heading", "**Chapter**")) - assertFalse(markdownContains("a `code` span", "`code`")) - assertTrue(markdownContains("a **Chapter** heading", "Chapter heading")) - } - - @Test - fun `text that is absent does not match`() { - assertFalse(markdownContains("A well\\-known secret", "unrelated")) - assertFalse(markdownContains("", "anything")) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapesTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapesTest.kt deleted file mode 100644 index cc52528d1..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownEscapesTest.kt +++ /dev/null @@ -1,65 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import kotlin.test.Test -import kotlin.test.assertEquals - -class MarkdownEscapesTest { - - @Test - fun `text without a backslash is returned unchanged`() { - val input = "Plain prose, no escapes." - assertEquals(input, unescapeMarkdown(input)) - } - - @Test - fun `empty input is returned unchanged`() { - assertEquals("", unescapeMarkdown("")) - } - - @Test - fun `backslash before ASCII punctuation resolves to the bare character`() { - assertEquals("*", unescapeMarkdown("\\*")) - assertEquals("_", unescapeMarkdown("\\_")) - assertEquals("#", unescapeMarkdown("\\#")) - assertEquals("\\", unescapeMarkdown("\\\\")) - assertEquals("[link]", unescapeMarkdown("\\[link\\]")) - } - - @Test - fun `escapes resolve inside a sentence`() { - assertEquals("use *stars* and _unders_", unescapeMarkdown("use \\*stars\\* and \\_unders\\_")) - assertEquals("well-known", unescapeMarkdown("well\\-known")) - assertEquals("the garden!", unescapeMarkdown("the garden\\!")) - assertEquals("mock(turtle)", unescapeMarkdown("mock\\(turtle\\)")) - assertEquals("1. not a list", unescapeMarkdown("1\\. not a list")) - } - - @Test - fun `a backslash before a non-punctuation character is preserved`() { - // Only ASCII punctuation is a valid CommonMark escape; everything else keeps the backslash. - assertEquals("\\a", unescapeMarkdown("\\a")) - assertEquals("C:\\temp", unescapeMarkdown("C:\\temp")) - assertEquals("\\d{4}", unescapeMarkdown("\\d{4}")) - } - - @Test - fun `a trailing backslash is preserved`() { - assertEquals("end\\", unescapeMarkdown("end\\")) - } - - @Test - fun `unescaped markup is left exactly as stored`() { - assertEquals("**Chapter** One", unescapeMarkdown("**Chapter** One")) - assertEquals("user_name", unescapeMarkdown("user_name")) - assertEquals("* * *", unescapeMarkdown("* * *")) - assertEquals("***", unescapeMarkdown("***")) - assertEquals("# Chapter One", unescapeMarkdown("# Chapter One")) - assertEquals("run `build` now", unescapeMarkdown("run `build` now")) - assertEquals("The cost is 5*4", unescapeMarkdown("The cost is 5*4")) - } - - @Test - fun `line structure is preserved`() { - assertEquals("a-b\n\nc-d", unescapeMarkdown("a\\-b\n\nc\\-d")) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectionTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectionTest.kt deleted file mode 100644 index 1ba6be91b..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectionTest.kt +++ /dev/null @@ -1,168 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertSame - -class MarkdownProjectionTest { - - @Test - fun `plain prose is returned unchanged and unallocated`() { - val input = "Alice went down the rabbit hole." - assertSame(input, projectMarkdownToPlainText(input)) - } - - @Test - fun `empty input is returned unchanged`() { - assertEquals("", projectMarkdownToPlainText("")) - } - - @Test - fun `backslash escapes resolve to their literal character`() { - assertEquals("well-known", projectMarkdownToPlainText("well\\-known")) - assertEquals("1. not a list", projectMarkdownToPlainText("1\\. not a list")) - assertEquals("[brackets]", projectMarkdownToPlainText("\\[brackets\\]")) - } - - @Test - fun `escaped backslash collapses to one backslash`() { - assertEquals("C:\\path", projectMarkdownToPlainText("C:\\\\path")) - } - - @Test - fun `a backslash before a non-punctuation character is kept`() { - assertEquals("\\a", projectMarkdownToPlainText("\\a")) - } - - @Test - fun `a trailing backslash is kept`() { - assertEquals("end\\", projectMarkdownToPlainText("end\\")) - } - - @Test - fun `paired emphasis markers are dropped so phrases join up`() { - assertEquals("Chapter One", projectMarkdownToPlainText("**Chapter** One")) - assertEquals("quick brown", projectMarkdownToPlainText("_quick_ brown")) - assertEquals("run build now", projectMarkdownToPlainText("run `build` now")) - } - - @Test - fun `nested emphasis is unwrapped`() { - assertEquals("very loud indeed", projectMarkdownToPlainText("**very _loud_ indeed**")) - assertEquals("shout", projectMarkdownToPlainText("***shout***")) - } - - @Test - fun `escaped markers survive as literal characters`() { - assertEquals("_shape_", projectMarkdownToPlainText("\\_shape\\_")) - assertEquals("2 * 3", projectMarkdownToPlainText("2 \\* 3")) - } - - @Test - fun `escaping is resolved before markers are dropped`() { - assertEquals("a_b and c", projectMarkdownToPlainText("a\\_b and _c_")) - } - - @Test - fun `underscores inside a word are literal`() { - assertEquals("user_name", projectMarkdownToPlainText("user_name")) - assertEquals("my_table_name", projectMarkdownToPlainText("my_table_name")) - assertEquals("snake_case and emphasis", projectMarkdownToPlainText("snake_case and _emphasis_")) - } - - @Test - fun `markers that cannot pair off are literal`() { - assertEquals("2 * 3 = 6", projectMarkdownToPlainText("2 * 3 = 6")) - assertEquals("***", projectMarkdownToPlainText("***")) - assertEquals("an *unclosed aside", projectMarkdownToPlainText("an *unclosed aside")) - assertEquals("a ` stray tick", projectMarkdownToPlainText("a ` stray tick")) - } - - @Test - fun `emphasis markers inside a code span are literal`() { - assertEquals("call my_func now", projectMarkdownToPlainText("call `my_func` now")) - } - - @Test - fun `leading block markers are stripped from each line`() { - assertEquals("Chapter One", projectMarkdownToPlainText("# Chapter One")) - assertEquals("a quote", projectMarkdownToPlainText("> a quote")) - assertEquals("a bullet", projectMarkdownToPlainText("- a bullet")) - assertEquals("Chapter One\n\nThe body", projectMarkdownToPlainText("# Chapter One\n\nThe body")) - } - - @Test - fun `ordered list markers are left alone so years survive`() { - assertEquals("1984. The year everything changed", projectMarkdownToPlainText("1984. The year everything changed")) - assertEquals("3) Meet at the docks", projectMarkdownToPlainText("3) Meet at the docks")) - } - - @Test - fun `a marker that is not followed by a space is prose`() { - assertEquals("-15 degrees", projectMarkdownToPlainText("-15 degrees")) - assertEquals("#hashtag here", projectMarkdownToPlainText("#hashtag here")) - } - - @Test - fun `code delimiters do not pair across a paragraph break`() { - assertEquals( - "It`s here.\n\nThe Chapter One part.\n\nDon`t stop.", - projectMarkdownToPlainText("It`s here.\n\nThe **Chapter** One part.\n\nDon`t stop."), - ) - } - - @Test - fun `emphasis does not pair across a paragraph break`() { - assertEquals( - "See note *below\n\nThe rate is 5* higher", - projectMarkdownToPlainText("See note *below\n\nThe rate is 5* higher"), - ) - } - - @Test - fun `emphasis still pairs across a soft line break`() { - assertEquals("The long\ntitle here", projectMarkdownToPlainText("The **long\ntitle** here")) - } - - @Test - fun `a document with escapes but no emphasis still resolves them`() { - assertEquals( - "The well-known garden! (and its gate)", - projectMarkdownToPlainText("The well\\-known garden\\! \\(and its gate\\)"), - ) - } - - @Test - fun `title line strips block markers and inline markup`() { - assertEquals("Chapter One", markdownTitleLine("# **Chapter** One\n\nbody")) - assertEquals("A quoted thought", markdownTitleLine("> A quoted thought")) - assertEquals("First item", markdownTitleLine("- First item\n- Second")) - } - - @Test - fun `title line keeps a leading number`() { - assertEquals("1984. The year everything changed", markdownTitleLine("1984. The year everything changed")) - } - - @Test - fun `title line pairs emphasis that closes on the next line`() { - assertEquals("The long", markdownTitleLine("The **long\ntitle** here")) - } - - @Test - fun `title line skips leading blank lines`() { - assertEquals("Actual title", markdownTitleLine("\n \nActual title\nmore")) - assertEquals("", markdownTitleLine(" \n\n")) - } - - @Test - fun `a title line of pure markup falls back to the raw line`() { - assertEquals("***", markdownTitleLine("***\nbody")) - assertEquals("#", markdownTitleLine("#\nbody")) - } - - @Test - fun `an emphasized title keeps its words`() { - assertEquals("Once upon a time", markdownTitleLine("*Once upon a time*")) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorTest.kt deleted file mode 100644 index 379aa72f1..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/data/search/MarkdownProjectorTest.kt +++ /dev/null @@ -1,132 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.search - -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class MarkdownProjectorTest { - - private val projector = MarkdownProjector() - - @Test - fun `a reused projector gives the same answer as a fresh one`() { - val documents = listOf( - "The **big** dog barked.", - "a much longer document ".repeat(200) + "with *emphasis* at the end", - "short", - "# Heading\n\nBody text.", - ) - documents.forEach { document -> - projector.project(document) - assertEquals(MarkdownProjector().also { it.project(document) }.projected(), projector.projected()) - } - } - - @Test - fun `a long document followed by a short one does not leak the tail of the long one`() { - projector.project("the quick brown fox ".repeat(100)) - projector.project("short") - assertEquals("short", projector.projected()) - } - - @Test - fun `indexOf finds a phrase that spans dropped emphasis`() { - projector.project("the **big** dog") - assertEquals("the big dog", projector.projected()) - assertEquals(4, projector.indexOf("big dog")) - } - - @Test - fun `indexOf is case insensitive by default and reports a miss as -1`() { - projector.project("The Harbour At Dawn") - assertEquals(4, projector.indexOf("harbour")) - assertEquals(-1, projector.indexOf("mountain")) - } - - @Test - fun `indexOf respects case when asked`() { - projector.project("The Harbour") - assertEquals(-1, projector.indexOf("harbour", ignoreCase = false)) - assertEquals(4, projector.indexOf("Harbour", ignoreCase = false)) - } - - @Test - fun `an empty query never matches`() { - projector.project("anything") - assertEquals(-1, projector.indexOf("")) - } - - @Test - fun `a query longer than the document never matches`() { - projector.project("hi") - assertEquals(-1, projector.indexOf("hello there")) - } - - @Test - fun `substring returns the projected prose rather than the source`() { - projector.project("the **big** dog") - assertEquals("big", projector.substring(4, 7)) - } - - @Test - fun `firstNonBlankLine skips blank lines and strips markers`() { - projector.project("\n\n# **Chapter** One\n\nBody") - assertEquals("Chapter One", projector.firstNonBlankLine()) - } - - @Test - fun `firstNonBlankLine is empty when every line is blank`() { - projector.project("\n \n\t\n") - assertEquals("", projector.firstNonBlankLine()) - } - - @Test - fun `collapsedPreview flattens whitespace runs`() { - projector.project("the quick\n\nbrown\tfox") - assertEquals("the quick brown fox", projector.collapsedPreview(100)) - } - - @Test - fun `collapsedPreview truncates with an ellipsis and stays within the cap`() { - projector.project("word ".repeat(100)) - val preview = projector.collapsedPreview(20) - assertTrue(preview.endsWith("…"), "expected an ellipsis, got: $preview") - // The cap bounds the prose; trimming a trailing space before the ellipsis can leave it shorter. - assertTrue(preview.length <= 21, "expected at most 21 chars, got ${preview.length}: $preview") - assertEquals("word word word word…", preview) - } - - @Test - fun `collapsedPreview does not add an ellipsis when the whole text fits`() { - projector.project("just this") - assertEquals("just this", projector.collapsedPreview(50)) - } - - @Test - fun `trailing whitespace does not count as more text to preview`() { - projector.project("just this \n\n ") - assertEquals("just this", projector.collapsedPreview(50)) - } - - @Test - fun `filling the source buffer directly projects the same as passing a string`() { - val document = "the **big** dog barked at the well\\-known man" - projector.project(document) - val viaString = projector.projected() - - val buffer = projector.sourceBuffer(document.length) - document.forEachIndexed { i, c -> buffer[i] = c } - projector.projectSource(document.length) - - assertEquals(viaString, projector.projected()) - } - - @Test - fun `the source buffer survives being grown for a longer document`() { - val long = "a *lot* of text ".repeat(50) - val buffer = projector.sourceBuffer(long.length) - long.forEachIndexed { i, c -> buffer[i] = c } - projector.projectSource(long.length) - assertEquals(projectMarkdownToPlainText(long), projector.projected()) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizerTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizerTest.kt deleted file mode 100644 index 98886e53b..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/DictionaryTokenizerTest.kt +++ /dev/null @@ -1,60 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import kotlin.test.Test -import kotlin.test.assertEquals - -class DictionaryTokenizerTest { - - @Test - fun `multi-word names are split into single tokens`() { - assertEquals( - setOf("bob", "roberts"), - tokenizeDictionaryWords(listOf("Bob Roberts")), - ) - } - - @Test - fun `tokens are lowercased`() { - assertEquals( - setOf("zaltharion"), - tokenizeDictionaryWords(listOf("ZALTHARION")), - ) - } - - @Test - fun `surrounding punctuation is stripped`() { - assertEquals( - setOf("mr", "smith"), - tokenizeDictionaryWords(listOf("Mr. Smith")), - ) - } - - @Test - fun `inner apostrophes and hyphens are kept`() { - assertEquals( - setOf("d'artagnan", "jean-luc"), - tokenizeDictionaryWords(listOf("d'Artagnan", "Jean-Luc")), - ) - } - - @Test - fun `blank and single-character tokens are dropped`() { - assertEquals( - setOf("initial"), - tokenizeDictionaryWords(listOf("A Initial", " ", "-", "x")), - ) - } - - @Test - fun `duplicate tokens across phrases are deduped case-insensitively`() { - assertEquals( - setOf("kastle", "rock"), - tokenizeDictionaryWords(listOf("Kastle Rock", "kastle", "KASTLE")), - ) - } - - @Test - fun `empty input produces empty output`() { - assertEquals(emptySet(), tokenizeDictionaryWords(emptyList())) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWordsTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWordsTest.kt deleted file mode 100644 index 6ca043fdb..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/spellcheck/UserDictionaryWordsTest.kt +++ /dev/null @@ -1,57 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.spellcheck - -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class UserDictionaryWordsTest { - - @Test - fun `surrounding whitespace is trimmed`() { - assertEquals("Kvothe", normalizeDictionaryWord(" Kvothe\t")) - } - - @Test - fun `case is preserved`() { - assertEquals("McKinley", normalizeDictionaryWord("McKinley")) - } - - @Test - fun `decomposed characters are composed`() { - assertEquals("\u00e8", normalizeDictionaryWord("e\u0300")) - } - - @Test - fun `blank input is rejected`() { - assertNull(normalizeDictionaryWord(" ")) - } - - @Test - fun `multi-word input is rejected`() { - assertNull(normalizeDictionaryWord("two words")) - } - - @Test - fun `overlong input is rejected`() { - assertNull(normalizeDictionaryWord("a".repeat(MAX_DICTIONARY_WORD_LENGTH + 1))) - assertEquals("a".repeat(MAX_DICTIONARY_WORD_LENGTH), normalizeDictionaryWord("a".repeat(MAX_DICTIONARY_WORD_LENGTH))) - } - - @Test - fun `stored words are normalized and deduped`() { - assertEquals( - setOf("alpha", "beta", "\u00e8"), - normalizeStoredDictionaryWords(listOf(" alpha ", "", " ", "beta", "alpha", "e\u0300")), - ) - } - - @Test - fun `stored words a peer wrote under laxer rules are kept`() { - val overlong = "a".repeat(MAX_DICTIONARY_WORD_LENGTH + 1) - - assertEquals( - setOf("two words", overlong), - normalizeStoredDictionaryWords(listOf("two words", overlong)), - ) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffersTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffersTest.kt deleted file mode 100644 index fa1e4b83e..000000000 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CharBuffersTest.kt +++ /dev/null @@ -1,91 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -import okio.Buffer -import kotlin.test.Test -import kotlin.test.assertEquals - -class CharBuffersTest { - - /** A fixed-size workspace, so a test can pin what happens when the sink runs out. */ - private class FixedBuffers(sinkSize: Int) : ScanBuffers { - val chars = CharArray(sinkSize) - private var bytes = ByteArray(0) - override fun charBuffer(minCapacity: Int) = chars - override fun byteBuffer(minCapacity: Int): ByteArray { - if (bytes.size < minCapacity) bytes = ByteArray(minCapacity) - return bytes - } - } - - private fun decode(text: String, sinkSize: Int = 256): String { - val source = Buffer().writeUtf8(text) - val byteCount = source.size.toInt() - val buffers = FixedBuffers(sinkSize) - val count = source.readUtf8Into(buffers, byteCount) - return buffers.chars.concatToString(0, count) - } - - private fun decodeBytes(bytes: ByteArray, byteCount: Int = bytes.size, sinkSize: Int = 16): String { - val source = Buffer().write(bytes) - val buffers = FixedBuffers(sinkSize) - val count = source.readUtf8Into(buffers, byteCount) - return buffers.chars.concatToString(0, count) - } - - @Test - fun `ascii decodes unchanged`() { - assertEquals("The quick brown fox", decode("The quick brown fox")) - } - - @Test - fun `two byte sequences decode`() { - assertEquals("café naïve", decode("café naïve")) - } - - @Test - fun `three byte sequences decode`() { - assertEquals("日本語のテキスト", decode("日本語のテキスト")) - } - - @Test - fun `four byte sequences decode to a surrogate pair`() { - val emoji = "😀" - val decoded = decode("a${emoji}b") - assertEquals("a${emoji}b", decoded) - assertEquals(4, decoded.length) - } - - @Test - fun `an empty source decodes to nothing`() { - assertEquals("", decode("")) - } - - @Test - fun `decoding stops when the sink is full`() { - assertEquals("The q", decode("The quick brown fox", sinkSize = 5)) - } - - @Test - fun `a surrogate pair is not split across the end of the sink`() { - // Room for "a" plus one char: the pair needs two, so it is left out rather than half-written. - assertEquals("a", decode("a😀", sinkSize = 2)) - } - - @Test - fun `a truncated sequence decodes to the replacement character`() { - assertEquals("a�", decodeBytes(byteArrayOf(0x61, 0xC3.toByte()))) - } - - @Test - fun `a stray continuation byte decodes to the replacement character`() { - assertEquals("a�b", decodeBytes(byteArrayOf(0x61, 0x80.toByte(), 0x62))) - } - - @Test - fun `reading fewer bytes than the source holds stops at the limit`() { - val source = Buffer().writeUtf8("abcdef") - val buffers = FixedBuffers(16) - val count = source.readUtf8Into(buffers, 3) - assertEquals("abc", buffers.chars.concatToString(0, count)) - } -} diff --git a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/LocaleTest.kt b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/LocaleTest.kt index e3969d752..9e0641e11 100644 --- a/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/LocaleTest.kt +++ b/common/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/common/util/LocaleTest.kt @@ -36,30 +36,10 @@ class LocaleTest { } @Test - fun forLanguageTag_retainsScriptSubtag() { + fun forLanguageTag_skipsScriptSubtag() { val locale = Locale.forLanguageTag("zh-Hant-TW") assertEquals("zh", locale.language) - assertEquals("Hant", locale.script) assertEquals("TW", locale.region) - assertEquals("zh-Hant-TW", locale.toLanguageTag()) - } - - @Test - fun forLanguageTag_normalizesScriptCase() { - assertEquals("Hans", Locale.forLanguageTag("zh-hans").script) - assertEquals("Hans", Locale.forLanguageTag("zh-HANS").script) - } - - @Test - fun forLanguageTag_scriptDistinguishesLocales() { - assertTrue(Locale.forLanguageTag("zh-Hans-HK") != Locale.forLanguageTag("zh-Hant-HK")) - } - - @Test - fun forLanguageTag_underscoreScriptSeparator() { - // iOS availableLocaleIdentifiers uses underscores: "zh_Hant_HK". - val locale = Locale.forLanguageTag("zh_Hant_HK") - assertEquals("zh-Hant-HK", locale.toLanguageTag()) } @Test diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/MsixPaths.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/MsixPaths.kt deleted file mode 100644 index c506222fd..000000000 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/MsixPaths.kt +++ /dev/null @@ -1,45 +0,0 @@ -package com.darkrockstudios.apps.hammer.common - -import com.darkrockstudios.apps.hammer.base.DistributionChannel - -/** - * Package family name of the Microsoft Store build: `Identity/@Name` from `msix/AppxManifest.xml` - * plus the hash Windows derives from the publisher ID. The hash is not in the manifest and cannot - * be computed from it, so it is hardcoded; it only changes if the Store identity does. - */ -private const val PACKAGE_FAMILY_NAME = "DarkRockStudios.HammerEditor_eee5gzg80tyea" - -private const val PACKAGES = "Packages" -private const val LOCAL_CACHE = "LocalCache\\Local" - -/** - * Rewrites a path so the Windows shell can find it. - * - * MSIX filesystem redirection is asymmetric: the app's writes under `%LOCALAPPDATA%` land inside - * the package container, but reads fall through, so `File.exists()` is true from inside the - * container and the app is satisfied. Explorer runs outside the container and correctly reports - * nothing at the literal path, which is what the "location is not available" dialog on the - * open-logs button was. - * - * A no-op on every other channel and platform, and on a path that is already un-redirected. - */ -fun shellPath(path: String): String = - if (DistributionChannel.current == DistributionChannel.MICROSOFT_STORE && hostOs == HostOs.Windows) { - unredirectMsixPath(path, System.getenv("LOCALAPPDATA")) - } else { - path - } - -/** The rewrite itself, with `%LOCALAPPDATA%` passed in so it can be tested off Windows. */ -internal fun unredirectMsixPath(path: String, localAppData: String?): String { - if (localAppData.isNullOrBlank()) return path - - val base = localAppData.trimEnd('\\') - val prefix = "$base\\" - if (!path.startsWith(prefix, ignoreCase = true)) return path - - val relative = path.substring(prefix.length) - if (relative.startsWith("$PACKAGES\\", ignoreCase = true)) return path - - return "$base\\$PACKAGES\\$PACKAGE_FAMILY_NAME\\$LOCAL_CACHE\\$relative" -} diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.desktop.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.desktop.kt index b8a5ff62b..713708ed5 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.desktop.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/StartupBanner.desktop.kt @@ -1,18 +1,11 @@ package com.darkrockstudios.apps.hammer.common -actual fun platformStartupInfo(): String = - desktopStartupInfo(hostOs, System::getProperty, System::getenv) - -internal fun desktopStartupInfo( - os: HostOs, - property: (String) -> String?, - environment: (String) -> String?, -): String { - fun env(name: String) = environment(name) ?: "n/a" - fun prop(name: String) = property(name) ?: "n/a" +actual fun platformStartupInfo(): String { + fun env(name: String) = System.getenv(name) ?: "n/a" + fun prop(name: String) = System.getProperty(name) ?: "n/a" return "OS: ${prop("os.name")} ${prop("os.version")} (${prop("os.arch")})" + " | JVM: ${prop("java.vendor")} ${prop("java.runtime.version")}" + // Display server + desktop environment: prime suspects for Compose/Skia startup stalls on Linux. - (if (os == HostOs.Linux) " | session: ${env("XDG_SESSION_TYPE")}/${env("XDG_CURRENT_DESKTOP")}" else "") + - " | renderApi: ${property("skiko.renderApi") ?: "default"}" + " | session: ${env("XDG_SESSION_TYPE")}/${env("XDG_CURRENT_DESKTOP")}" + + " | renderApi: ${System.getProperty("skiko.renderApi", "default")}" } diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/DesktopPlatformSettings.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/DesktopPlatformSettings.kt index 61f04d41b..211c07c56 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/DesktopPlatformSettings.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/DesktopPlatformSettings.kt @@ -8,13 +8,9 @@ interface DesktopPlatformSettings : PlatformSettings { val state: Value fun setProjectsDir(path: String) - fun setAutomaticUpdateChecks(value: Boolean) @Serializable data class PlatformState( val projectsDir: HPath, - /** False on builds that cannot update themselves, which then show no update setting. */ - val updateChecksSupported: Boolean = false, - val automaticUpdateChecks: Boolean = true, ) } diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/PlatformSettingsComponent.desktop.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/PlatformSettingsComponent.desktop.kt index ec4e146b6..b83437391 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/PlatformSettingsComponent.desktop.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/components/projectselection/accountsettings/PlatformSettingsComponent.desktop.kt @@ -5,8 +5,6 @@ import com.arkivanov.decompose.value.Value import com.arkivanov.decompose.value.getAndUpdate import com.darkrockstudios.apps.hammer.common.components.SavableComponent import com.darkrockstudios.apps.hammer.common.components.savableState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.migrator.DataMigrator import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository @@ -29,13 +27,10 @@ class DesktopPlatformSettingsComponent(componentContext: ComponentContext) : Des private val globalSettingsStore: GlobalSettingsStore by inject() private val projectsRepository: ProjectsRepository by inject() private val sandboxFileAccess: SandboxFileAccess by inject() - private val appUpdater: AppUpdater by inject() private val _state by savableState { DesktopPlatformSettings.PlatformState( projectsDir = projectsRepository.getProjectsDirectory(), - updateChecksSupported = appUpdater.state.value !is AppUpdateState.Unsupported, - automaticUpdateChecks = globalSettingsStore.globalSettings.automaticUpdateChecks, ) } @@ -55,7 +50,6 @@ class DesktopPlatformSettingsComponent(componentContext: ComponentContext) : Des val projectsPath = settings.projectsDirectory.toPath().toHPath() it.copy( projectsDir = projectsPath, - automaticUpdateChecks = settings.automaticUpdateChecks, ) } } @@ -93,10 +87,4 @@ class DesktopPlatformSettingsComponent(componentContext: ComponentContext) : Des } } } - - override fun setAutomaticUpdateChecks(value: Boolean) { - scope.launch { - globalSettingsStore.updateSettings { it.copy(automaticUpdateChecks = value) } - } - } } diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt deleted file mode 100644 index a8120eb00..000000000 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt +++ /dev/null @@ -1,9 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -import com.darkrockstudios.apps.hammer.base.DistributionChannel - -actual val supportsInAppChangelog: Boolean = supportsInAppChangelog(DistributionChannel.current) - -// Only the Mac App Store flavor faces review; direct downloads keep the dialog. -internal fun supportsInAppChangelog(channel: DistributionChannel): Boolean = - channel != DistributionChannel.MAC_APP_STORE diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/getHttpPlatformEngine.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/getHttpPlatformEngine.kt index c44978301..84378e3cd 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/getHttpPlatformEngine.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/getHttpPlatformEngine.kt @@ -3,9 +3,8 @@ package com.darkrockstudios.apps.hammer.common.dependencyinjection import com.darkrockstudios.apps.hammer.common.getInDevelopmentMode import io.ktor.client.* import io.ktor.client.engine.* -import io.ktor.client.engine.okhttp.* +import io.ktor.client.engine.java.* import io.ktor.client.plugins.compression.* -import okhttp3.OkHttpClient import java.net.InetAddress import java.net.Socket import java.security.KeyStore @@ -16,14 +15,8 @@ import javax.net.ssl.SSLEngine import javax.net.ssl.TrustManagerFactory import javax.net.ssl.X509ExtendedTrustManager -/** - * OkHttp, not the `java` engine: `java.net.http.HttpClient`'s constructor opens an NIO - * [java.nio.channels.Selector], whose Windows wakeup pipe is an AF_UNIX socket that the MSIX - * sandbox rejects with EINVAL, so every Store build hard-crashes on the first network call - * (JDK-8312215). OkHttp uses blocking socket IO and survives the sandbox. - */ actual fun getHttpPlatformEngine(): HttpClientEngineFactory<*> = - if (getInDevelopmentMode()) DevLoopbackTrustOkHttp else OkHttp + if (getInDevelopmentMode()) DevLoopbackTrustJava else Java actual fun HttpClientConfig.installCompression() { install(ContentEncoding) { @@ -37,28 +30,21 @@ actual fun HttpClientConfig.installCompression() * client can reach a `--dev` server's auto-generated cert on localhost. Connections to any * non-loopback host still go through the platform's full certificate and hostname validation, so a * `--dev` build pointed at a real remote server is not exposed to a man-in-the-middle. Selected only - * when [getInDevelopmentMode] is true; release builds always use plain [OkHttp]. + * when [getInDevelopmentMode] is true; release builds always use plain [Java]. */ -private object DevLoopbackTrustOkHttp : HttpClientEngineFactory { - override fun create(block: OkHttpConfig.() -> Unit): HttpClientEngine = - OkHttp.create { +private object DevLoopbackTrustJava : HttpClientEngineFactory { + override fun create(block: JavaHttpConfig.() -> Unit): HttpClientEngine = + Java.create { block() - val trustManager = loopbackTrustManager() - val defaultVerifier = OkHttpClient.Builder().build().hostnameVerifier config { - sslSocketFactory(loopbackTrustingSslContext(trustManager).socketFactory, trustManager) - // OkHttp verifies the hostname itself rather than through the trust manager's - // endpoint identification, so loopback has to be waived here too. - hostnameVerifier { hostname, session -> - isLoopbackHost(hostname) || defaultVerifier.verify(hostname, session) - } + sslContext(loopbackTrustingSslContext()) } } } -private fun loopbackTrustManager(): X509ExtendedTrustManager { +private fun loopbackTrustingSslContext(): SSLContext { val default = platformTrustManager() - return object : X509ExtendedTrustManager() { + val trustManager = object : X509ExtendedTrustManager() { override fun checkServerTrusted(chain: Array?, authType: String?, socket: Socket?) { if (socket?.inetAddress?.isLoopbackAddress == true) return default.checkServerTrusted(chain, authType, socket) @@ -85,12 +71,10 @@ private fun loopbackTrustManager(): X509ExtendedTrustManager { override fun getAcceptedIssuers(): Array = default.acceptedIssuers } -} - -private fun loopbackTrustingSslContext(trustManager: X509ExtendedTrustManager): SSLContext = - SSLContext.getInstance("TLSv1.3").apply { + return SSLContext.getInstance("TLSv1.3").apply { init(null, arrayOf(trustManager), SecureRandom()) } +} private fun isLoopbackHost(host: String?): Boolean { if (host.isNullOrBlank()) return false diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt index 4e58047f6..37b45e4a6 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt @@ -18,7 +18,6 @@ actual val platformModule = module { single() single() bind StrRes::class single() - single() single() bind UrlLauncher::class single() factory { params -> DesktopPlatformSettingsComponent(componentContext = params.get()) } bind PlatformSettings::class diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/platform.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/platform.kt index 8fcf99910..723cd486b 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/platform.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/platform.kt @@ -10,6 +10,15 @@ import kotlin.coroutines.CoroutineContext var appDirs: AppDirs = AppDirsFactory.getInstance() +/** + * True when the desktop build is the Mac App Store flavor. Set via + * `-Dhammer.app.store=true` JVM arg (wired through Gradle when + * `-PmacOsAppStoreRelease=true` is passed). Sandbox-only code paths + * (e.g. fixed projects directory) gate on this. + */ +val IS_APP_STORE: Boolean = + System.getProperty("hammer.app.store", "false").toBoolean() + actual fun getPlatformName(): String { return "Desktop" } diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt deleted file mode 100644 index 648861890..000000000 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt +++ /dev/null @@ -1,11 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -actual class AvailableLocalesProvider { - actual fun allLocales(): List = - java.util.Locale.getAvailableLocales() - // Parse the full tag rather than language+country so script-distinct - // locales (zh-Hans vs zh-Hant) stay separate entries. - .map { Locale.forLanguageTag(it.toLanguageTag()) } - .filter { it.language != null } - .distinctBy { it.toLanguageTag() } -} diff --git a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt index 23b43987d..d73964c15 100644 --- a/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt +++ b/common/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/util/DateTimeUtils.kt @@ -1,11 +1,7 @@ package com.darkrockstudios.apps.hammer.common.util -import kotlinx.datetime.LocalDateTime -import kotlinx.datetime.TimeZone -import kotlinx.datetime.toJavaLocalDateTime -import kotlinx.datetime.toLocalDateTime +import kotlinx.datetime.* import java.time.format.DateTimeFormatter -import kotlin.time.Instant actual fun Instant.formatLocal(format: String): String = toLocalDateTime(TimeZone.currentSystemDefault()).format(format) diff --git a/common/src/desktopTest/kotlin/architecture/PersistedFormatOwnershipTest.kt b/common/src/desktopTest/kotlin/architecture/PersistedFormatOwnershipTest.kt deleted file mode 100644 index e86cd0052..000000000 --- a/common/src/desktopTest/kotlin/architecture/PersistedFormatOwnershipTest.kt +++ /dev/null @@ -1,49 +0,0 @@ -package architecture - -import org.junit.jupiter.api.Test -import java.io.File -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -/** - * Structural guard for the "one owner per persisted format" rule (ARCHITECTURE.md, - * hard constraint 7): raw TOML file I/O may only appear inside a format's Data Source - * file. A second inline writer forks the on-disk format and clobbers sibling fields on - * write (a language-seed write and a tags write to `project_data.toml` once destroyed - * each other exactly this way). Code that cannot reach a datasource instance must use - * or add a scope-less helper in the datasource's own file, like - * `loadStoredProjectData`/`saveStoredProjectData` in `ProjectDataDatasource.kt`. - * - * The only exemption is the migrator package: migrations transform historical on-disk - * layouts that predate the current datasources, so raw access to old formats is their job. - */ -class PersistedFormatOwnershipTest { - - private val tomlIo = Regex("""\.(writeToml|readToml|readTomlOrNull)\s*[<(]""") - - @Test - fun `raw TOML file IO stays inside datasource files`() { - val root = File("src/commonMain/kotlin") - assertTrue( - root.isDirectory, - "Expected the test working directory to be the :common module (got ${File("").absolutePath})", - ) - - val offenders = root.walkTopDown() - .filter { it.isFile && it.extension == "kt" } - .filter { tomlIo.containsMatchIn(it.readText()) } - .map { it.relativeTo(root).invariantSeparatorsPath } - .filterNot { it.substringAfterLast('/').contains("Datasource") } - .filterNot { it.startsWith("com/darkrockstudios/apps/hammer/common/data/migrator/") } - .sorted() - .toList() - - assertEquals( - emptyList(), - offenders, - "These files serialize a persisted format outside its owning Data Source. " + - "Route through the datasource, or add a scope-less helper in the datasource's " + - "file (see loadStoredProjectData/saveStoredProjectData).", - ) - } -} diff --git a/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepositoryTest.kt b/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepositoryTest.kt index 92d42ef79..5f429c533 100644 --- a/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/data/projectbackup/ProjectBackupRepositoryTest.kt @@ -14,7 +14,6 @@ import okio.FileSystem import okio.IOException import okio.Path import okio.Path.Companion.toPath -import okio.ForwardingFileSystem import okio.fakefilesystem.FakeFileSystem import org.junit.jupiter.api.Test import kotlin.test.assertEquals @@ -378,100 +377,6 @@ class ProjectBackupRepositoryTest { assertEquals("once upon a time", fileSystem.read(restoredScene) { readUtf8() }) } - @Test - fun `restoreBackup puts the project files back at the root of the project directory`() = runTest { - every { clock.now() } returns Instant.parse("2025-12-28T16:29:00Z") - every { projectsRepository.getProjectsDirectory() } returns "/projects".toPath().toHPath() - every { projectsRepository.getProjectDirectory("Test Project") } returns - "/projects/Test Project".toPath().toHPath() - every { globalSettingsStore.globalSettings } returns - GlobalSettings(projectsDirectory = "/projects", maxBackups = 5) - - val projectDir = "/projects/Test Project".toPath() - fileSystem.createDirectories(projectDir / "scenes") - fileSystem.write(projectDir / "project.toml") { writeUtf8("original") } - fileSystem.write(projectDir / "scenes" / "scene.md") { writeUtf8("once upon a time") } - - val repo = realRepo() - val projectDef = ProjectDef("Test Project", projectDir.toHPath()) - val backupDef = repo.createBackup(projectDef) - assertNotNull(backupDef) - - fileSystem.write(projectDir / "project.toml") { writeUtf8("changed") } - - assertTrue(repo.restoreBackup(backupDef, projectDef.path)) - - assertEquals("original", fileSystem.read(projectDir / "project.toml") { readUtf8() }) - assertEquals("once upon a time", fileSystem.read(projectDir / "scenes" / "scene.md") { readUtf8() }) - assertFalse(fileSystem.exists(projectDir / "Test Project"), "Project must not be nested inside itself") - } - - @Test - fun `getBackedUpProjects includes projects that no longer exist`() { - every { projectsRepository.getProjectsDirectory() } returns "/projects".toPath().toHPath() - - val kept = ProjectDef("Kept", "/projects/Kept".toPath().toHPath()) - val noBackups = ProjectDef("No Backups", "/projects/No Backups".toPath().toHPath()) - val deleted = ProjectDef("Deleted", "/projects/Deleted".toPath().toHPath()) - every { projectsRepository.getProjects(any()) } returns listOf(kept, noBackups) - every { projectsRepository.getProjectDefinition("Deleted") } returns deleted - - writeBackupFile("Kept", Instant.parse("2025-12-26T10:00:00Z")) - writeBackupFile("Deleted", Instant.parse("2025-12-26T10:00:00Z")) - writeBackupFile("Deleted", Instant.parse("2025-12-27T10:00:00Z")) - - assertEquals(listOf(kept, deleted), realRepo().getBackedUpProjects()) - } - - @Test - fun `getBackedUpProjects lists a missing project once when it has legacy and current backups`() { - every { projectsRepository.getProjectsDirectory() } returns "/projects".toPath().toHPath() - - val deleted = ProjectDef("My Story", "/projects/My Story".toPath().toHPath()) - every { projectsRepository.getProjects(any()) } returns emptyList() - every { projectsRepository.getProjectDefinition("My Story") } returns deleted - - val legacy = writeBackupFile("My Story", Instant.parse("2025-12-26T10:00:00Z")) - fileSystem.write(legacy.parent!! / "My Story-2025-12-27T100000Z.zip") { writeUtf8("zip") } - - assertEquals(listOf(deleted), realRepo().getBackedUpProjects()) - } - - @Test - fun `restoreBackup leaves the project untouched when it cannot be replaced`() = runTest { - every { clock.now() } returns Instant.parse("2025-12-28T16:29:00Z") - every { projectsRepository.getProjectsDirectory() } returns "/projects".toPath().toHPath() - every { projectsRepository.getProjectDirectory("Test Project") } returns - "/projects/Test Project".toPath().toHPath() - every { globalSettingsStore.globalSettings } returns - GlobalSettings(projectsDirectory = "/projects", maxBackups = 5) - - val projectDir = "/projects/Test Project".toPath() - fileSystem.createDirectories(projectDir) - fileSystem.write(projectDir / "project.toml") { writeUtf8("original") } - - val repo = realRepo() - val projectDef = ProjectDef("Test Project", projectDir.toHPath()) - val backupDef = repo.createBackup(projectDef) - assertNotNull(backupDef) - - fileSystem.write(projectDir / "project.toml") { writeUtf8("changed") } - fileSystem.write(projectDir / "notes.md") { writeUtf8("newer work") } - - val failingSwap = object : ForwardingFileSystem(fileSystem) { - override fun atomicMove(source: Path, target: Path) { - if (target == projectDir && "new" in source.segments) throw IOException("locked") - super.atomicMove(source, target) - } - } - val failingRepo = ProjectBackupRepository(failingSwap, projectsRepository, globalSettingsStore, clock) - - assertFalse(failingRepo.restoreBackup(backupDef, projectDef.path)) - - assertEquals("changed", fileSystem.read(projectDir / "project.toml") { readUtf8() }) - assertEquals("newer work", fileSystem.read(projectDir / "notes.md") { readUtf8() }) - } - @Test fun `restoreBackup returns false when the backup file is missing`() = runTest { every { projectsRepository.getProjectsDirectory() } returns "/projects".toPath().toHPath() diff --git a/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReaderTest.kt b/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReaderTest.kt deleted file mode 100644 index 720749408..000000000 --- a/common/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/util/CrashLogReaderTest.kt +++ /dev/null @@ -1,56 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class CrashLogReaderTest { - - private val fileSystem = FakeFileSystem() - private val logDir = "/logs".toPath() - - private fun write(name: String, content: String) { - fileSystem.createDirectories(logDir) - fileSystem.write(logDir / name) { writeUtf8(content) } - } - - @Test - fun returnsNullWhenDirectoryMissing() { - assertNull(readLatestCrash(fileSystem, logDir)) - } - - @Test - fun returnsNullWhenNoCrashFiles() { - write("2026-01-01T00.txt", "just a log") - assertNull(readLatestCrash(fileSystem, logDir)) - } - - @Test - fun readsTheOnlyCrash() { - write("crash-1000.txt", "stack trace here") - val crash = readLatestCrash(fileSystem, logDir) - assertEquals("crash-1000.txt", crash?.fileName) - assertEquals("stack trace here", crash?.content) - } - - @Test - fun picksNewestCrashByTimestamp() { - // Filenames intentionally out of write order to prove ordering is by parsed millis, not mtime. - write("crash-3000.txt", "newest") - write("crash-1000.txt", "oldest") - write("crash-2000.txt", "middle") - val crash = readLatestCrash(fileSystem, logDir) - assertEquals("crash-3000.txt", crash?.fileName) - assertEquals("newest", crash?.content) - } - - @Test - fun ignoresNonCrashFilesWhenPicking() { - write("crash-1000.txt", "the crash") - write("2026-07-15T12.txt", "a much newer plain log") - val crash = readLatestCrash(fileSystem, logDir) - assertEquals("crash-1000.txt", crash?.fileName) - } -} diff --git a/common/src/desktopTest/kotlin/components/encyclopedia/EncyclopediaComponentTest.kt b/common/src/desktopTest/kotlin/components/encyclopedia/EncyclopediaComponentTest.kt index cf0ec01da..662c8b91e 100644 --- a/common/src/desktopTest/kotlin/components/encyclopedia/EncyclopediaComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/encyclopedia/EncyclopediaComponentTest.kt @@ -18,7 +18,6 @@ import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScop import io.mockk.every import io.mockk.mockk import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.emptyFlow import kotlinx.coroutines.test.advanceUntilIdle @@ -58,7 +57,6 @@ class EncyclopediaComponentTest : ComponentTest() { encyclopediaService = mockk(relaxed = true) every { encyclopediaService.entryListFlow } returns MutableStateFlow(emptyList()) - every { encyclopediaService.entryChangedFlow } returns MutableSharedFlow() every { encyclopediaService.loadEntry(any()) } returns EntryContainer(entryContent) every { encyclopediaService.findEntryImagePath(any()) } returns null every { encyclopediaService.findEntryImageExtension(any()) } returns null @@ -221,37 +219,4 @@ class EncyclopediaComponentTest : ComponentTest() { assertEquals(entryDef, destination.component.state.value.entryDef) assertEquals(3, comp.stack.value.items.size) } - - @Test - fun `discardUnsaved ends an in-progress entry edit`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showViewEntry(entryDef) - advanceUntilIdle() - - val destination = assertIs(comp.stack.value.active.instance) - destination.component.startNameEdit() - destination.component.startTextEdit() - assertEquals(setOf(CloseConfirm.Encyclopedia), comp.shouldConfirmClose()) - - comp.discardUnsaved(CloseConfirm.Encyclopedia) - - assertEquals(emptySet(), comp.shouldConfirmClose()) - } - - @Test - fun `discardUnsaved pops an open create entry screen`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showCreateEntry() - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Encyclopedia) - advanceUntilIdle() - - assertIs(comp.stack.value.active.instance) - assertEquals(emptySet(), comp.shouldConfirmClose()) - } } diff --git a/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentExternalChangeTest.kt b/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentExternalChangeTest.kt deleted file mode 100644 index 8df54974c..000000000 --- a/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentExternalChangeTest.kt +++ /dev/null @@ -1,141 +0,0 @@ -package components.encyclopedia - -import com.darkrockstudios.apps.hammer.common.components.encyclopedia.ViewEntryComponent -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaService -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryContainer -import com.darkrockstudios.apps.hammer.common.data.references.BackfillEntryReferencesUseCase -import com.darkrockstudios.apps.hammer.common.data.references.CleanupReferencesOnEntryDeleteUseCase -import com.darkrockstudios.apps.hammer.common.data.references.ReferenceIndexService -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import io.mockk.every -import io.mockk.mockk -import io.mockk.verify -import okio.IOException -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.flow.emptyFlow -import kotlinx.coroutines.test.advanceUntilIdle -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import repositories.encyclopedia.fakeEntry -import utils.ComponentTest -import kotlin.test.assertEquals - -@OptIn(ExperimentalCoroutinesApi::class) -class ViewEntryComponentExternalChangeTest : ComponentTest() { - - private lateinit var encyclopediaService: EncyclopediaService - private lateinit var entryChangedFlow: MutableSharedFlow - - @BeforeEach - override fun setup() { - super.setup() - - entryChangedFlow = MutableSharedFlow(extraBufferCapacity = 8) - encyclopediaService = mockk(relaxed = true) - every { encyclopediaService.entryChangedFlow } returns entryChangedFlow - every { encyclopediaService.findEntryImagePath(any()) } returns null - every { encyclopediaService.findEntryImageExtension(any()) } returns null - - val referenceIndexService = mockk(relaxed = true) - every { referenceIndexService.flowForEntry(any()) } returns emptyFlow() - - setupComponentKoin(module { - single { encyclopediaService } - single { referenceIndexService } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - }) - } - - @Test - fun `An entry renamed and edited elsewhere refreshes the open view`() = runTest(mainTestDispatcher) { - val original = fakeEntry() - val originalDef = original.toDef(projectDef) - every { encyclopediaService.loadEntry(originalDef) } returns EntryContainer(original) - - val comp = ViewEntryComponent( - componentContext = context, - entryDef = originalDef, - addMenu = {}, - removeMenu = {}, - closeEntry = {}, - showScene = {}, - onShowGlobalSearchForTag = {}, - ) - context.resume() - advanceUntilIdle() - assertEquals(original, comp.state.value.content) - - val synced = original.copy(name = "Server Name", text = "Server text") - val syncedDef = synced.toDef(projectDef) - every { encyclopediaService.findEntryDef(original.id) } returns syncedDef - every { encyclopediaService.loadEntry(syncedDef) } returns EntryContainer(synced) - - entryChangedFlow.emit(original.id) - advanceUntilIdle() - - assertEquals(syncedDef, comp.state.value.entryDef) - assertEquals(synced, comp.state.value.content) - } - - @Test - fun `A failed refresh does not stop later refreshes`() = runTest(mainTestDispatcher) { - val original = fakeEntry() - val originalDef = original.toDef(projectDef) - every { encyclopediaService.loadEntry(originalDef) } returns EntryContainer(original) - every { encyclopediaService.findEntryDef(original.id) } returns originalDef - - val comp = ViewEntryComponent( - componentContext = context, - entryDef = originalDef, - addMenu = {}, - removeMenu = {}, - closeEntry = {}, - showScene = {}, - onShowGlobalSearchForTag = {}, - ) - context.resume() - advanceUntilIdle() - - every { encyclopediaService.loadEntry(originalDef) } throws IOException("mid-move") - entryChangedFlow.emit(original.id) - advanceUntilIdle() - assertEquals(original, comp.state.value.content) - - val synced = original.copy(text = "Server text") - every { encyclopediaService.loadEntry(originalDef) } returns EntryContainer(synced) - entryChangedFlow.emit(original.id) - advanceUntilIdle() - - assertEquals(synced, comp.state.value.content) - } - - @Test - fun `A change to another entry does not reload this one`() = runTest(mainTestDispatcher) { - val original = fakeEntry() - val originalDef = original.toDef(projectDef) - every { encyclopediaService.loadEntry(originalDef) } returns EntryContainer(original) - - ViewEntryComponent( - componentContext = context, - entryDef = originalDef, - addMenu = {}, - removeMenu = {}, - closeEntry = {}, - showScene = {}, - onShowGlobalSearchForTag = {}, - ) - context.resume() - advanceUntilIdle() - - entryChangedFlow.emit(original.id + 1) - advanceUntilIdle() - - verify(exactly = 0) { encyclopediaService.findEntryDef(any()) } - verify(exactly = 1) { encyclopediaService.loadEntry(originalDef) } - } -} diff --git a/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentTest.kt b/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentTest.kt index 3deda4784..4dba545ef 100644 --- a/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/encyclopedia/ViewEntryComponentTest.kt @@ -25,7 +25,6 @@ import org.koin.dsl.module import repositories.encyclopedia.fakeEntry import utils.BaseTest import kotlin.test.assertEquals -import kotlin.test.assertFalse import kotlin.test.assertNull @OptIn(ExperimentalCoroutinesApi::class) @@ -91,8 +90,7 @@ class ViewEntryComponentTest : BaseTest() { oldEntryDef = origDef, name = newName, text = oldEntry.text, - tags = oldEntry.tags, - excludeFromDictionary = false, + tags = oldEntry.tags ) } returns EntryResult(newContainer, EntryError.NONE) @@ -138,8 +136,7 @@ class ViewEntryComponentTest : BaseTest() { oldEntryDef = origDef, name = newName, text = oldEntry.text, - tags = oldEntry.tags, - excludeFromDictionary = false, + tags = oldEntry.tags ) } returns EntryResult(newContainer, EntryError.NAME_INVALID_CHARACTERS) @@ -165,37 +162,4 @@ class ViewEntryComponentTest : BaseTest() { assertNull(comp.state.value.content) coVerify(exactly = 0) { backfillEntryReferences(any()) } } - - @Test - fun `Discard edit leaves every edit mode without saving`() = runTest { - val proj = getProject1Def() - val entry = fakeEntry() - every { encyclopediaService.findEntryImagePath(any()) } returns null - every { encyclopediaService.findEntryImageExtension(any()) } returns null - coEvery { encyclopediaService.calculateEntryImageHash(any(), any()) } returns null - coEvery { encyclopediaService.loadEntry(entryDef = any()) } returns EntryContainer(entry) - - val comp = ViewEntryComponent( - componentContext = context, - entryDef = entry.toDef(proj), - addMenu = {}, - removeMenu = {}, - closeEntry = {}, - showScene = {}, - onShowGlobalSearchForTag = {}, - ) - comp.startNameEdit() - comp.startTextEdit() - comp.confirmClose() - - comp.discardEdit() - advanceUntilIdle() - - assertFalse(comp.state.value.editName) - assertFalse(comp.state.value.editText) - assertFalse(comp.state.value.confirmClose) - coVerify(exactly = 0) { - encyclopediaService.updateEntry(any(), any(), any(), any(), any(), any()) - } - } -} +} \ No newline at end of file diff --git a/common/src/desktopTest/kotlin/components/notes/NotesComponentTest.kt b/common/src/desktopTest/kotlin/components/notes/NotesComponentTest.kt index 5cf4fc3cb..15522664c 100644 --- a/common/src/desktopTest/kotlin/components/notes/NotesComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/notes/NotesComponentTest.kt @@ -9,12 +9,10 @@ import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteCont import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndex import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndexService import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository import io.mockk.every import io.mockk.mockk import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.flow.MutableStateFlow -import kotlinx.coroutines.flow.emptyFlow import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest import org.junit.jupiter.api.BeforeEach @@ -47,7 +45,7 @@ class NotesComponentTest : ComponentTest() { super.setup() notesRepository = mockk(relaxed = true) - every { notesRepository.notesListFlow } returns MutableStateFlow(listOf(NoteContainer(note))) + every { notesRepository.notesListFlow } returns MutableStateFlow(emptyList()) every { notesRepository.findNoteForId(any()) } returns note tagIndexService = mockk(relaxed = true) @@ -58,11 +56,6 @@ class NotesComponentTest : ComponentTest() { scoped { notesRepository } scoped { tagIndexService } } - single { - mockk(relaxed = true) { - every { spellCheckAllowed } returns emptyFlow() - } - } }) shouldCloseUpdates = 0 @@ -190,75 +183,4 @@ class NotesComponentTest : ComponentTest() { assertTrue(shouldCloseUpdates > baseline) } - - @Test - fun `discardUnsaved reverts a dirty note edit`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showViewNote(1) - advanceUntilIdle() - - val destination = assertIs(comp.stack.value.active.instance) - destination.component.beginEdit() - destination.component.onContentChanged("changed body") - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Notes) - advanceUntilIdle() - - assertEquals(emptySet(), comp.shouldConfirmClose()) - assertEquals(note.content, destination.component.noteText.value) - } - - @Test - fun `discardUnsaved pops an open create note screen`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showCreateNote() - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Notes) - advanceUntilIdle() - - assertIs(comp.stack.value.active.instance) - assertEquals(emptySet(), comp.shouldConfirmClose()) - } - - @Test - fun `discardUnsaved clears a dirty note edit beneath a create screen`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showViewNote(1) - advanceUntilIdle() - val view = assertIs(comp.stack.value.active.instance) - view.component.beginEdit() - view.component.onContentChanged("changed body") - comp.showCreateNote() - advanceUntilIdle() - assertEquals(setOf(CloseConfirm.Notes), comp.shouldConfirmClose()) - - comp.discardUnsaved(CloseConfirm.Notes) - advanceUntilIdle() - - assertIs(comp.stack.value.active.instance) - assertFalse(view.component.state.value.isEditing) - assertEquals(emptySet(), comp.shouldConfirmClose()) - } - - @Test - fun `discardUnsaved ignores other confirmation types`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showCreateNote() - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Scenes) - advanceUntilIdle() - - assertIs(comp.stack.value.active.instance) - } } diff --git a/common/src/desktopTest/kotlin/components/notes/ViewNoteComponentTest.kt b/common/src/desktopTest/kotlin/components/notes/ViewNoteComponentTest.kt index 7b47737d9..7c6a5fc25 100644 --- a/common/src/desktopTest/kotlin/components/notes/ViewNoteComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/notes/ViewNoteComponentTest.kt @@ -3,7 +3,6 @@ package components.notes import com.darkrockstudios.apps.hammer.common.components.notes.ViewNoteComponent import com.darkrockstudios.apps.hammer.common.data.MenuDescriptor import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesRepository -import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContainer import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_DEFAULT import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_MAIN @@ -12,11 +11,8 @@ import io.mockk.every import io.mockk.mockk import io.mockk.verify import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.asCoroutineDispatcher -import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.runBlocking -import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Test @@ -33,11 +29,9 @@ import kotlin.test.assertFalse import kotlin.test.assertTrue import kotlin.time.Instant -@OptIn(ExperimentalCoroutinesApi::class) class ViewNoteComponentTest : ComponentTest() { private lateinit var notesRepository: NotesRepository - private lateinit var notesListFlow: MutableSharedFlow> private var dismissViewCount = 0 private var searchedTag: String? = null @@ -49,8 +43,6 @@ class ViewNoteComponentTest : ComponentTest() { super.setup() notesRepository = mockk(relaxed = true) - notesListFlow = MutableSharedFlow(replay = 1) - every { notesRepository.notesListFlow } returns notesListFlow setupComponentKoin(module { single { notesRepository } bind NotesRepository::class }) @@ -108,96 +100,6 @@ class ViewNoteComponentTest : ComponentTest() { assertEquals(note(content = "late"), comp.state.value.note) } - @Test - fun `a note changed elsewhere refreshes the open view`() = runTest(mainTestDispatcher) { - val comp = startWith(note(content = "orig", tags = setOf("a"))) - advanceUntilIdle() - - val synced = note(content = "from server", tags = setOf("b")) - notesListFlow.emit(listOf(NoteContainer(synced))) - advanceUntilIdle() - - assertEquals(synced, comp.state.value.note) - assertEquals("from server", comp.noteText.value) - assertEquals(setOf("b"), comp.state.value.tags) - } - - @Test - fun `a note changed elsewhere while editing keeps the draft and moves the baseline`() = - runTest(mainTestDispatcher) { - val comp = startWith(note(content = "orig", tags = setOf("a"))) - comp.beginEdit() - comp.onContentChanged("my draft") - comp.onTagsChanged(setOf("wip")) - advanceUntilIdle() - - val synced = note(content = "from server", tags = setOf("b")) - notesListFlow.emit(listOf(NoteContainer(synced))) - advanceUntilIdle() - - assertTrue(comp.state.value.isEditing) - assertEquals("my draft", comp.noteText.value) - assertEquals(setOf("wip"), comp.state.value.tags) - assertEquals(synced, comp.state.value.note) - - comp.discardEdit() - assertEquals("from server", comp.noteText.value) - assertEquals(setOf("b"), comp.state.value.tags) - } - - @Test - fun `a note changed elsewhere replaces an untouched edit`() = runTest(mainTestDispatcher) { - val comp = startWith(note(content = "orig", tags = setOf("a"))) - comp.beginEdit() - advanceUntilIdle() - - val synced = note(content = "from server", tags = setOf("b")) - notesListFlow.emit(listOf(NoteContainer(synced))) - advanceUntilIdle() - - assertTrue(comp.state.value.isEditing) - assertEquals("from server", comp.noteText.value) - assertEquals(setOf("b"), comp.state.value.tags) - assertFalse(comp.isEditingAndDirty()) - } - - @Test - fun `a note deleted elsewhere closes the view`() = runTest(mainTestDispatcher) { - startWith(note()) - advanceUntilIdle() - - notesListFlow.emit(emptyList()) - advanceUntilIdle() - - assertEquals(1, dismissViewCount) - } - - @Test - fun `a note deleted elsewhere while a dirty edit is open stays open`() = runTest(mainTestDispatcher) { - val comp = startWith(note(content = "orig")) - comp.beginEdit() - comp.onContentChanged("my draft") - advanceUntilIdle() - - notesListFlow.emit(emptyList()) - advanceUntilIdle() - - assertEquals(0, dismissViewCount) - assertEquals("my draft", comp.noteText.value) - } - - @Test - fun `deleting the open note dismisses only once`() = runTest(mainTestDispatcher) { - val comp = startWith(note()) - advanceUntilIdle() - - comp.deleteNote(1) - notesListFlow.emit(emptyList()) - advanceUntilIdle() - - assertEquals(1, dismissViewCount) - } - @Test fun `deleteNote invokes dismissView on the main dispatcher`() { // dismissView drives Decompose navigation, which must run on the main thread. diff --git a/common/src/desktopTest/kotlin/components/projecthome/DocxStoryRendererTest.kt b/common/src/desktopTest/kotlin/components/projecthome/DocxStoryRendererTest.kt index 1896ff373..a0f55b2df 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/DocxStoryRendererTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/DocxStoryRendererTest.kt @@ -5,8 +5,6 @@ import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectTheme import com.darkrockstudios.apps.hammer.common.components.projecthome.StoryChapter import com.darkrockstudios.apps.hammer.common.components.projecthome.ExportStrings import com.darkrockstudios.apps.hammer.common.components.projecthome.writeStoryAsDocx -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import okio.Buffer import org.apache.poi.xwpf.usermodel.XWPFDocument import org.apache.poi.xwpf.usermodel.XWPFHyperlinkRun @@ -24,7 +22,6 @@ class DocxStoryRendererTest { chapters: List, projectName: String = "Test Project", projectData: ProjectData = ProjectData(authorName = "Test Author"), - options: ExportOptions = ExportOptions(), ): XWPFDocument { val buffer = Buffer() val author = projectData.authorName?.takeIf { it.isNotBlank() } @@ -34,7 +31,6 @@ class DocxStoryRendererTest { projectData = projectData, chapters = chapters, strings = ExportStrings(contentsTitle = "Contents", authorByline = author?.let { "by $it" }), - options = options, ) return XWPFDocument(ByteArrayInputStream(buffer.readByteArray())) } @@ -108,8 +104,7 @@ class DocxStoryRendererTest { listOf( StoryChapter("Alpha", "First."), StoryChapter("Beta", "Second."), - ), - options = ExportOptions(numberChapters = true), + ) ) val headings = doc.paragraphs.filter { it.style == "Heading1" } @@ -117,46 +112,6 @@ class DocxStoryRendererTest { assertTrue(headings.all { it.isPageBreak }, "Chapter headings should start on a new page") } - @Test - fun `chapters are unnumbered by default in headings and contents`() { - val doc = render( - listOf( - StoryChapter("Prologue", "First."), - StoryChapter("Chapter 1", "Second."), - ), - ) - - val headings = doc.paragraphs.filter { it.style == "Heading1" } - assertEquals(listOf("Prologue", "Chapter 1"), headings.map { it.text }) - - val contents = doc.paragraphs.filter { it.ctp.hyperlinkList.any { link -> link.anchor != null } } - assertEquals(listOf("Prologue", "Chapter 1"), contents.map { it.text }) - } - - @Test - fun `the chosen font becomes the document default`() { - val doc = render( - listOf(StoryChapter("Alpha", "Some text.")), - options = ExportOptions(font = ExportFont.TimesNewRoman), - ) - - val fonts = doc.styles.ctStyles.docDefaults.rPrDefault.rPr.rFontsList.single() - assertEquals("Times New Roman", fonts.ascii) - assertEquals("Times New Roman", fonts.hAnsi) - } - - @Test - fun `blank lines between paragraphs become empty paragraphs only when kept`() { - val chapters = listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage.")) - - val kept = render(chapters).bodyParagraphs().map { it.text } - assertEquals(listOf("First passage.", "", "Second passage."), kept) - - val skipped = render(chapters, options = ExportOptions(keepBlankLines = false)) - .bodyParagraphs().map { it.text } - assertEquals(listOf("First passage.", "Second passage."), skipped) - } - @Test fun `bold and italic markdown become formatted runs`() { val doc = @@ -329,7 +284,7 @@ class DocxStoryRendererTest { assertEquals("Tom & Jerry's ", doc.paragraphs.first().text) val heading = doc.paragraphs.first { it.style == "Heading1" } - assertEquals("Q & A ", heading.text) + assertEquals("1. Q & A ", heading.text) val texts = doc.paragraphTexts() assertTrue( @@ -379,36 +334,13 @@ class DocxStoryRendererTest { } @Test - fun `every authored line becomes its own paragraph`() { + fun `soft line breaks within a paragraph stay in one paragraph`() { val doc = render(listOf(StoryChapter("Alpha", "line one\nline two"))) val texts = doc.bodyParagraphs().map { it.text } assertTrue( - texts.contains("line one") && texts.contains("line two"), - "Authored lines should each stand alone, got $texts", + texts.any { it.contains("line one") && it.contains("line two") }, + "Soft-wrapped lines should join into a single paragraph, got $texts", ) } - - @Test - fun `a line that runs on into another loses the gap between them`() { - val doc = render(listOf(StoryChapter("Alpha", "line one\nline two"))) - - val first = doc.bodyParagraphs().first { it.text == "line one" } - assertEquals( - 0, - (first.ctp.pPr?.spacing?.after as? java.math.BigInteger)?.toInt(), - "A line followed by more prose must not push the next line down", - ) - } - - @Test - fun `a blank line between passages becomes an empty paragraph`() { - val doc = render(listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage."))) - - val texts = doc.bodyParagraphs().map { it.text } - val first = texts.indexOf("First passage.") - val second = texts.indexOf("Second passage.") - assertEquals(first + 2, second, "Expected one empty paragraph between the passages, got $texts") - assertEquals("", texts[first + 1]) - } } diff --git a/common/src/desktopTest/kotlin/components/projecthome/EpubStoryRendererTest.kt b/common/src/desktopTest/kotlin/components/projecthome/EpubStoryRendererTest.kt index 6679f78f1..1d488b089 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/EpubStoryRendererTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/EpubStoryRendererTest.kt @@ -5,8 +5,6 @@ import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectTheme import com.darkrockstudios.apps.hammer.common.components.projecthome.ExportStrings import com.darkrockstudios.apps.hammer.common.components.projecthome.StoryChapter import com.darkrockstudios.apps.hammer.common.components.projecthome.writeStoryAsEpub -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import okio.Buffer import java.io.ByteArrayInputStream import java.util.zip.ZipInputStream @@ -20,7 +18,6 @@ class EpubStoryRendererTest { chapters: List, projectName: String = "Test Project", projectData: ProjectData = ProjectData(authorName = "Jane Doe"), - options: ExportOptions = ExportOptions(), ): String { val buffer = Buffer() val author = projectData.authorName?.takeIf { it.isNotBlank() } @@ -31,7 +28,6 @@ class EpubStoryRendererTest { chapters = chapters, language = "en", strings = ExportStrings(contentsTitle = "Contents", authorByline = author?.let { "by $it" }), - options = options, ) val sb = StringBuilder() @@ -45,73 +41,6 @@ class EpubStoryRendererTest { return sb.toString() } - @Test - fun `blank lines between passages can be skipped`() { - val content = render( - listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage.")), - options = ExportOptions(keepBlankLines = false), - ) - - assertTrue("

First passage.

Second passage.

" in content, content) - } - - @Test - fun `a run of blank lines leaves one break when blank lines are skipped`() { - val content = render( - listOf(StoryChapter("Alpha", "First passage.\n\n\n\nNew scene.")), - options = ExportOptions(keepBlankLines = false), - ) - - assertTrue("

First passage.


New scene.

" in content, content) - } - - @Test - fun `chapter titles are numbered only on request`() { - val chapters = listOf(StoryChapter("Prologue", "First."), StoryChapter("Chapter 1", "Second.")) - - val plain = render(chapters) - assertTrue("

Chapter 1

" in plain, plain) - assertTrue("2. Chapter 1" !in plain, plain) - - val numbered = render(chapters, options = ExportOptions(numberChapters = true)) - assertTrue("

2. Chapter 1

" in numbered, numbered) - assertTrue("2. Chapter 1" in numbered, numbered) - } - - @Test - fun `the chosen font overrides the stylesheet body font`() { - val content = render( - listOf(StoryChapter("Alpha", "Some text.")), - options = ExportOptions(font = ExportFont.Arial), - ) - - assertTrue("body { font-family: Arial, Helvetica, sans-serif; }" in content, content) - } - - @Test - fun `every authored line becomes its own paragraph`() { - val content = render(listOf(StoryChapter("Alpha", "line one\nline two"))) - - assertTrue("

line one

line two

" in content, "Authored lines should each stand alone") - } - - @Test - fun `a blank line between passages survives as a break`() { - val content = render(listOf(StoryChapter("Alpha", "First passage.\n\nSecond passage."))) - - assertTrue( - "

First passage.


Second passage.

" in content, - "The author's blank line should reach the reader", - ) - } - - @Test - fun `paragraphs carry no margin so the indent parts the lines`() { - val content = render(listOf(StoryChapter("Alpha", "Body."))) - - assertTrue("p { margin: 0; }" in content, "Prose lines must not be gapped by a paragraph margin") - } - @Test fun `contents page carries the localized title`() { val content = render(listOf(StoryChapter("Alpha", "Body."))) diff --git a/common/src/desktopTest/kotlin/components/projecthome/ExportStoryUseCaseTest.kt b/common/src/desktopTest/kotlin/components/projecthome/ExportStoryUseCaseTest.kt index 6776c7c09..cabbe6311 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/ExportStoryUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/ExportStoryUseCaseTest.kt @@ -56,7 +56,7 @@ class ExportStoryUseCaseTest : BaseIntegrationTest() { ) @Test - fun `markdown export renders project title, chapters, and group children`() = runTest { + fun `markdown export renders project title, numbered chapters, and group children`() = runTest { initRepo() val exportPath = useCase().execute( @@ -69,24 +69,6 @@ class ExportStoryUseCaseTest : BaseIntegrationTest() { assertEquals(EXPECTED_PROJECT_1_MARKDOWN.trim(), text.trim()) } - @Test - fun `export includes unsaved scene edits`() = runTest { - initRepo() - val tempBuffer = sceneDatasource.getSceneBufferDirectory().toOkioPath() / "1.md" - ffs.write(tempBuffer) { writeUtf8("Unsaved edit of scene id 1") } - sceneContentRepository.initialize() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions(format = ExportFormat.Markdown, treatTopLevelAsChapters = true), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertTrue("Unsaved edit of scene id 1" in text, "Export should carry the unsaved buffer, got: $text") - assertTrue("Content of scene id 1" !in text, "Export should not carry the stale on-disk scene, got: $text") - assertTrue("Content of scene id 3" in text, "Scenes without a buffer still come from disk, got: $text") - } - @Test fun `epub export produces a valid zip file with PK magic bytes`() = runTest { initRepo() @@ -219,51 +201,6 @@ class ExportStoryUseCaseTest : BaseIntegrationTest() { assertTrue(bytes.size > 100, "Single-chapter PDF should still produce a real file") } - @Test - fun `epub export uses the project language when set`() = runTest { - initRepo() - storedProjectData = StoredProjectData(data = ProjectData(language = "fr")) - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions(format = ExportFormat.Epub, treatTopLevelAsChapters = true), - ) - - val bytes = ffs.read(exportPath.toOkioPath()) { readByteArray() } - assertTrue( - zipEntryText(bytes, ".opf").contains(">fr<"), - "EPUB metadata should carry the project language, not the device locale", - ) - } - - @Test - fun `epub export falls back to the device locale when the project language is unset`() = runTest { - initRepo() - storedProjectData = StoredProjectData(data = ProjectData()) - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions(format = ExportFormat.Epub, treatTopLevelAsChapters = true), - ) - - val bytes = ffs.read(exportPath.toOkioPath()) { readByteArray() } - assertTrue( - zipEntryText(bytes, ".opf").contains(">en<"), - "EPUB metadata should fall back to the device locale's language", - ) - } - - private fun zipEntryText(bytes: ByteArray, nameSuffix: String): String { - java.util.zip.ZipInputStream(bytes.inputStream()).use { zin -> - var entry = zin.nextEntry - while (entry != null) { - if (entry.name.endsWith(nameSuffix)) return zin.readBytes().decodeToString() - entry = zin.nextEntry - } - } - error("No zip entry ending with $nameSuffix") - } - @Test fun `epub export still produces a valid file when treatTopLevelAsChapters is false`() = runTest { initRepo() @@ -277,190 +214,16 @@ class ExportStoryUseCaseTest : BaseIntegrationTest() { assertTrue(bytes.size > 100, "Single-chapter EPUB should still produce a real file") } - @Test - fun `scene filter keeps only selected scenes and renumbers chapters`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = true, - sceneIds = setOf(1, 4), - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertEquals(EXPECTED_FILTERED_MARKDOWN.trim(), text.trim()) - } - - @Test - fun `markdown chapter headings are numbered on request`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = true, - numberChapters = true, - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertTrue("## 1. Scene ID 1" in text, text) - assertTrue("## 2. Chapter ID 2" in text, text) - } - - @Test - fun `scene breaks survive when blank lines are skipped`() = runTest { - initRepo() - storedProjectData = StoredProjectData(data = ProjectData(authorName = "Test Author")) - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Rtf, - keepBlankLines = false, - sceneIds = setOf(3, 4), - ), - ) - - val rtf = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - // \fi360 opens a body paragraph: the two scenes and the break between them. - assertEquals(3, Regex("""\\fi360""").findAll(rtf).count(), rtf) - } - - @Test - fun `scene filter drops chapters with no selected scenes`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = true, - sceneIds = setOf(6), - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - val expected = """ - # Test Project 1 - - - ## Scene ID 6 - - Content of scene id 6 - """.trimIndent() - assertEquals(expected, text.trim()) - } - - @Test - fun `scene filter applies when top-level scenes are not chapters`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = false, - sceneIds = setOf(3, 6), - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertEquals( - "# Test Project 1\n\nContent of scene id 3\n\n\nContent of scene id 6", - text.trim(), - ) - } - - @Test - fun `scene ids missing from the tree are silently ignored`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = true, - sceneIds = setOf(1, 4, 999), - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertEquals(EXPECTED_FILTERED_MARKDOWN.trim(), text.trim()) - } - - @Test - fun `an empty scene filter fails closed instead of exporting the whole story`() = runTest { - initRepo() - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Markdown, - treatTopLevelAsChapters = true, - sceneIds = emptySet(), - ), - ) - - val text = ffs.read(exportPath.toOkioPath()) { readByteArray() }.decodeToString() - assertEquals("# Test Project 1", text.trim()) - } - - @Test - fun `epub export honors the scene filter`() = runTest { - initRepo() - storedProjectData = StoredProjectData(data = ProjectData(authorName = "Test Author")) - - val exportPath = useCase().execute( - exportDir = projectPath, - options = ExportOptions( - format = ExportFormat.Epub, - treatTopLevelAsChapters = true, - sceneIds = setOf(4), - ), - ) - - val bytes = ffs.read(exportPath.toOkioPath()) { readByteArray() } - assertEquals('P'.code.toByte(), bytes[0]) - assertEquals('K'.code.toByte(), bytes[1]) - val chapterText = zipEntryText(bytes, "ch1.xhtml") - assertTrue( - "Content of scene id 4" in chapterText, - "Filtered EPUB chapter should contain the selected scene, got: $chapterText", - ) - assertTrue( - "Content of scene id 3" !in chapterText, - "Filtered EPUB chapter should not contain unselected scenes, got: $chapterText", - ) - } - companion object { - private val EXPECTED_FILTERED_MARKDOWN = """ - # Test Project 1 - - - ## Scene ID 1 - - Content of scene id 1 - - ## Chapter ID 2 - - Content of scene id 4 - """.trimIndent() - private val EXPECTED_PROJECT_1_MARKDOWN = """ # Test Project 1 - ## Scene ID 1 + ## 1. Scene ID 1 Content of scene id 1 - ## Chapter ID 2 + ## 2. Chapter ID 2 Content of scene id 3 @@ -468,11 +231,11 @@ class ExportStoryUseCaseTest : BaseIntegrationTest() { Content of scene id 5 - ## Scene ID 6 + ## 3. Scene ID 6 Content of scene id 6 - ## Scene ID 7 + ## 4. Scene ID 7 Content of scene id 7 """.trimIndent() diff --git a/common/src/desktopTest/kotlin/components/projecthome/PdfProseMarkdownTest.kt b/common/src/desktopTest/kotlin/components/projecthome/PdfProseMarkdownTest.kt index ab8e6eb30..a32382218 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/PdfProseMarkdownTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/PdfProseMarkdownTest.kt @@ -23,67 +23,12 @@ class PdfProseMarkdownTest { } @Test - fun `every authored line becomes its own paragraph`() { - val blocks = parseProseMarkdown("First line.\nSecond line.\nThird line.") - - assertEquals(3, blocks.size) - assertEquals("First line.", paragraph(blocks[0]).spans.plain()) - assertEquals("Second line.", paragraph(blocks[1]).spans.plain()) - assertEquals("Third line.", paragraph(blocks[2]).spans.plain()) - } - - @Test - fun `a blank line between passages survives as a blank block`() { - val blocks = parseProseMarkdown("First passage.\n\nSecond passage.") - - assertEquals(3, blocks.size) - assertEquals("First passage.", paragraph(blocks[0]).spans.plain()) - assertIs(blocks[1]) - assertEquals("Second passage.", paragraph(blocks[2]).spans.plain()) - } - - @Test - fun `a lone blank line is dropped when not kept`() { - val blocks = parseProseMarkdown("First passage.\n\nSecond passage.", keepBlankLines = false) + fun `paragraphs are split on blank lines and soft wraps become spaces`() { + val blocks = parseProseMarkdown("First line\ncontinues here.\n\nSecond paragraph.") assertEquals(2, blocks.size) - assertEquals("First passage.", paragraph(blocks[0]).spans.plain()) - assertEquals("Second passage.", paragraph(blocks[1]).spans.plain()) - } - - @Test - fun `a run of blank lines leaves one break when not kept`() { - val blocks = parseProseMarkdown( - "First.\n\nSecond.\n\n\n\n\nNew scene.", - keepBlankLines = false, - ) - - assertEquals(4, blocks.size) - assertEquals("Second.", paragraph(blocks[1]).spans.plain()) - assertIs(blocks[2]) - assertEquals("New scene.", paragraph(blocks[3]).spans.plain()) - } - - @Test - fun `each blank line of a run counts`() { - val blocks = parseProseMarkdown("First passage.\n\n\n\nSecond passage.") - - assertEquals(3, blocks.count { it is ProseBlock.Blank }) - } - - @Test - fun `a blank line beside a heading is left to the heading's own spacing`() { - val blocks = parseProseMarkdown("## Chapter One\n\nThe prose.\n\n\n## Chapter Two") - - assertEquals(0, blocks.count { it is ProseBlock.Blank }) - } - - @Test - fun `Windows line endings lay out like any other`() { - val unix = parseProseMarkdown("First line.\nSecond line.\n\nAfter a blank line.") - val windows = parseProseMarkdown("First line.\r\nSecond line.\r\n\r\nAfter a blank line.") - - assertEquals(unix, windows) + assertEquals("First line continues here.", paragraph(blocks[0]).spans.plain()) + assertEquals("Second paragraph.", paragraph(blocks[1]).spans.plain()) } @Test @@ -207,22 +152,10 @@ class PdfProseMarkdownTest { } @Test - fun `hard line break parts the lines just as a plain newline does`() { + fun `hard line break becomes a newline within the paragraph`() { val blocks = parseProseMarkdown("line one \nline two") - assertEquals(2, blocks.size) - assertEquals("line one", paragraph(blocks[0]).spans.plain()) - assertEquals("line two", paragraph(blocks[1]).spans.plain()) - } - - @Test - fun `a quoted passage keeps its lines`() { - val blocks = parseProseMarkdown("> quote line one\n> quote line two") - - val quote = assertIs(blocks.single()) - assertEquals(2, quote.paragraphs.size) - assertEquals("quote line one", quote.paragraphs[0].plain()) - assertEquals("quote line two", quote.paragraphs[1].plain()) + assertEquals("line one\nline two", paragraph(blocks.single()).spans.plain()) } @Test diff --git a/common/src/desktopTest/kotlin/components/projecthome/PdfProseVisualCheck.kt b/common/src/desktopTest/kotlin/components/projecthome/PdfProseVisualCheck.kt index c461ee1e8..8cbed3bc1 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/PdfProseVisualCheck.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/PdfProseVisualCheck.kt @@ -17,27 +17,17 @@ class PdfProseVisualCheck { @EnabledIfEnvironmentVariable(named = "PDF_VISUAL_CHECK", matches = "1") fun `render sample pdf`() { val markdown = """ - The opening paragraph of a chapter carries a first-line indent, as does every other. It runs long enough to wrap across several lines so the wrapping behaviour around the indent can be seen clearly on the page. + The opening paragraph of a chapter sits flush against the margin, as is the convention in book typesetting. It runs long enough to wrap across several lines so the wrapping behaviour around the indent can be seen clearly on the page. - The second paragraph sits one blank line below, because that is the blank line the author typed. It also runs long enough to wrap, which shows that only the first line is indented and continuation lines return to the margin. + The second paragraph begins with a first-line indent, marking the paragraph break without a blank line. It also runs long enough to wrap, which shows that only the first line is indented and continuation lines return to the margin. - A third paragraph continues the prose with **bold**, *italic*, and ~~struck~~ words along the way to confirm inline styling still works. - - – Good evening, madame. I did not mean to disturb you. - – Think nothing of it, she said. I am only doing my work. - – Then perhaps you can tell me where the old medicines are kept, said the visitor, whose question ran on long enough to wrap onto a second line. - - These lines of dialogue each stand on their own, exactly as they do in the editor. - - - Two blank lines above this one open a wider gap, the way the author asked for it. + A third paragraph continues the prose with the same indent, with **bold**, *italic*, and ~~struck~~ words along the way to confirm inline styling still works. --- - After a scene break the prose continues. + After a scene break the next paragraph is flush again, signalling a fresh section to the reader. - > A quoted passage keeps its lines, - > one under the next. + And the one after it is indented once more. ## A Secondary Heading diff --git a/common/src/desktopTest/kotlin/components/projecthome/PdfStoryRendererTest.kt b/common/src/desktopTest/kotlin/components/projecthome/PdfStoryRendererTest.kt deleted file mode 100644 index 840c48bd0..000000000 --- a/common/src/desktopTest/kotlin/components/projecthome/PdfStoryRendererTest.kt +++ /dev/null @@ -1,109 +0,0 @@ -package components.projecthome - -import com.conamobile.pdfkmp.PdfDocument -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import com.darkrockstudios.apps.hammer.common.components.projecthome.ExportStrings -import com.darkrockstudios.apps.hammer.common.components.projecthome.STORY_PAGE_PADDING -import com.darkrockstudios.apps.hammer.common.components.projecthome.STORY_PAGE_SIZE -import com.darkrockstudios.apps.hammer.common.components.projecthome.StoryChapter -import com.darkrockstudios.apps.hammer.common.components.projecthome.buildStoryPdf -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class PdfStoryRendererTest { - - private fun render(markdown: String): PdfDocument = buildStoryPdf( - projectName = "Story", - projectData = ProjectData(authorName = "Author"), - chapters = listOf(StoryChapter("Chapter", markdown)), - strings = ExportStrings(contentsTitle = "Contents", authorByline = "by Author"), - ) - - private fun assertInsideMargins(document: PdfDocument) { - val top = STORY_PAGE_PADDING.top.value - val bottom = STORY_PAGE_SIZE.height.value - STORY_PAGE_PADDING.bottom.value - val right = STORY_PAGE_SIZE.width.value - STORY_PAGE_PADDING.right.value - for (run in document.textRuns) { - assertTrue(run.yPoints >= top - 0.5f, "run above the top margin: $run") - assertTrue(run.yPoints + run.heightPoints <= bottom + 0.5f, "run below the bottom margin: $run") - assertTrue(run.xPoints + run.widthPoints <= right + 0.5f, "run past the right margin: $run") - } - } - - private fun sentences(count: Int): String = - (1..count).joinToString(" ") { "Sentence number $it has some **bold** and *italic* words in it." } - - @Test - fun `a paragraph taller than a page flows onto the next page`() { - val document = render(sentences(400) + " THE-END") - - assertInsideMargins(document) - val chapterPages = document.textRuns.map { it.pageIndex }.distinct().count { it >= 2 } - assertTrue(chapterPages >= 3, "expected the paragraph to span pages, got $chapterPages") - assertTrue(document.textRuns.last().text.contains("THE-END")) - } - - @Test - fun `a paragraph that crosses a page boundary fills the page before breaking`() { - val filler = (1..30).joinToString("\n") { "Short line $it." } - val document = render(filler + "\n" + sentences(60)) - - assertInsideMargins(document) - val firstChapterPage = document.textRuns.filter { it.pageIndex == 2 } - val bottom = STORY_PAGE_SIZE.height.value - STORY_PAGE_PADDING.bottom.value - val lowest = firstChapterPage.maxOf { it.yPoints + it.heightPoints } - assertTrue(bottom - lowest < 40f, "page left ${bottom - lowest}pt empty before the break") - } - - private fun assertSpansPages(document: PdfDocument) { - assertInsideMargins(document) - val chapterPages = document.textRuns.map { it.pageIndex }.distinct().count { it >= 2 } - assertTrue(chapterPages >= 2, "expected the block to span pages, got $chapterPages") - assertTrue(document.textRuns.any { it.text.contains("THE-END") }) - } - - @Test - fun `a quote taller than a page flows onto the next page`() { - assertSpansPages(render("> " + sentences(300) + " THE-END")) - } - - @Test - fun `a list item taller than a page flows onto the next page`() { - assertSpansPages(render("- short item\n- " + sentences(300) + " THE-END")) - } - - @Test - fun `a code block taller than a page flows onto the next page`() { - val code = (1..120).joinToString("\n") { "line $it" } - assertSpansPages(render("```\n$code\nTHE-END\n```")) - } - - @Test - fun `a table row taller than a page continues in further rows`() { - assertSpansPages(render("| a | b |\n|---|---|\n| short | " + sentences(200) + " THE-END |")) - } - - @Test - fun `every line of a right-to-left paragraph keeps the paragraph direction`() { - val words = (1..240).joinToString(" ") { if (it % 3 == 0) "Alpha" else "שלום" } - val document = render(words) - - val right = STORY_PAGE_SIZE.width.value - STORY_PAGE_PADDING.right.value - val rows = document.textRuns.filter { it.pageIndex == 2 }.drop(1).groupBy { it.yPoints } - assertTrue(rows.size > 5) - for ((y, runs) in rows) { - val edge = runs.maxOf { it.xPoints + it.widthPoints } - assertTrue(right - edge < 8f, "line at y=$y ends ${right - edge}pt short of the right margin") - } - } - - @Test - fun `pre-wrapped lines are not wrapped again`() { - val document = render(sentences(40)) - - val rows = document.textRuns.filter { it.pageIndex == 2 }.map { it.yPoints }.distinct().sorted() - val gaps = rows.drop(1).zipWithNext { a, b -> b - a }.map { Math.round(it * 10) }.distinct() - assertEquals(1, gaps.size, "uneven line spacing: $gaps") - } -} diff --git a/common/src/desktopTest/kotlin/components/projecthome/ProjectHomeComponentTest.kt b/common/src/desktopTest/kotlin/components/projecthome/ProjectHomeComponentTest.kt index 3e82f0760..670d2a520 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/ProjectHomeComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/ProjectHomeComponentTest.kt @@ -10,11 +10,7 @@ import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.In import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata import com.darkrockstudios.apps.hammer.common.data.ExportFormat import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree -import com.darkrockstudios.apps.hammer.common.data.tree.Tree -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaService import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType @@ -115,7 +111,6 @@ class ProjectHomeComponentTest : ComponentTest() { coEvery { sceneEditor.getMetadata() } returns ProjectMetadata( Info(created = Instant.parse("2024-01-15T12:00:00Z")) ) - every { sceneEditor.getSceneTree() } returns buildSceneTree() exportStoryUseCase = mockk() encyclopediaService = mockk() @@ -165,7 +160,7 @@ class ProjectHomeComponentTest : ComponentTest() { private fun newComponent() = ProjectHomeComponent( componentContext = context, projectDef = projectDef, - requestProjectSync = { syncShown = true }, + showProjectSync = { syncShown = true }, onShowGlobalSearch = { globalSearchShown = true }, onShowGlobalSearchForTag = { searchedTag = it }, onShowScene = { shownScene = it }, @@ -173,26 +168,6 @@ class ProjectHomeComponentTest : ComponentTest() { onCloseProject = { projectClosed = true }, ) - private fun scene(id: Int, name: String, type: SceneItem.Type = SceneItem.Type.Scene) = - SceneItem(projectDef = projectDef, type = type, id = id, name = name, order = id) - - // Scene 1, Group 2 [Scene 3, Scene 4, Group 5 [Scene 6]], Scene 7 - private fun buildSceneTree(): ImmutableTree { - val tree = Tree() - val root = TreeNode(scene(0, "", SceneItem.Type.Root)) - root.addChild(TreeNode(scene(1, "Scene 1"))) - val group = TreeNode(scene(2, "Group 2", SceneItem.Type.Group)) - group.addChild(TreeNode(scene(3, "Scene 3"))) - group.addChild(TreeNode(scene(4, "Scene 4"))) - val nested = TreeNode(scene(5, "Group 5", SceneItem.Type.Group)) - nested.addChild(TreeNode(scene(6, "Scene 6"))) - group.addChild(nested) - root.addChild(group) - root.addChild(TreeNode(scene(7, "Scene 7"))) - tree.setRoot(root) - return tree.toImmutableTree() - } - private fun stats() = ProjectStatistics( numberOfScenes = 4, totalWords = 1200, @@ -271,111 +246,6 @@ class ProjectHomeComponentTest : ComponentTest() { assertFalse(comp.state.value.showExportDialog) } - @Test - fun `beginProjectExport flattens the scene tree into exportable scenes`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - comp.beginProjectExport() - advanceUntilIdle() - - val expected = listOf( - ExportableScene(id = 1, name = "Scene 1", isGroup = false, depth = 0), - ExportableScene(id = 2, name = "Group 2", isGroup = true, depth = 0), - ExportableScene(id = 3, name = "Scene 3", isGroup = false, depth = 1), - ExportableScene(id = 4, name = "Scene 4", isGroup = false, depth = 1), - ExportableScene(id = 5, name = "Group 5", isGroup = true, depth = 1), - ExportableScene(id = 6, name = "Scene 6", isGroup = false, depth = 2), - ExportableScene(id = 7, name = "Scene 7", isGroup = false, depth = 0), - ) - assertEquals(expected, comp.state.value.exportableScenes) - } - - @Test - fun `beginProjectExport resets a scene limit left over from a previous export`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - comp.beginProjectExport() - comp.updateExportOptions(ExportOptions(sceneIds = setOf(3))) - comp.confirmExportDialog(comp.state.value.exportOptions) - comp.endProjectExport() - - comp.beginProjectExport() - assertNull(comp.state.value.exportOptions.sceneIds) - } - - @Test - fun `updateExportOptions persists in-dialog edits in component state`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - comp.beginProjectExport() - val edited = ExportOptions( - treatTopLevelAsChapters = false, - format = ExportFormat.Pdf, - sceneIds = setOf(3, 4), - ) - comp.updateExportOptions(edited) - - // The dialog composition holds no option state, so surviving here is surviving rotation. - assertEquals(edited, comp.state.value.exportOptions) - } - - @Test - fun `confirmExportDialog carries the scene filter through to the use case`() = runTest(mainTestDispatcher) { - val options = ExportOptions(format = ExportFormat.Markdown, sceneIds = setOf(3, 6)) - val exported = HPath("/out/Test.md", "Test.md", true) - coEvery { exportStoryUseCase.execute(any(), any()) } returns exported - - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.beginProjectExport() - comp.confirmExportDialog(options) - assertEquals(options, comp.state.value.exportOptions) - - comp.exportProject("/out", options) - advanceUntilIdle() - - coVerify { exportStoryUseCase.execute(any(), match { it.sceneIds == setOf(3, 6) }) } - } - - @Test - fun `dismissal after cancel discards in-dialog edits and drops the scenes snapshot`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - val defaults = comp.state.value.exportOptions - comp.beginProjectExport() - advanceUntilIdle() - assertTrue(comp.state.value.exportableScenes.isNotEmpty()) - - comp.updateExportOptions(ExportOptions(treatTopLevelAsChapters = false, format = ExportFormat.Pdf)) - comp.cancelExportDialog() - // The snapshot survives until the close animation finishes, no mid-animation flash. - assertTrue(comp.state.value.exportableScenes.isNotEmpty()) - - comp.exportDialogDismissed() - assertEquals(defaults.copy(sceneIds = null), comp.state.value.exportOptions) - assertTrue(comp.state.value.exportableScenes.isEmpty()) - } - - @Test - fun `dismissal after confirm keeps the confirmed options`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - comp.beginProjectExport() - val confirmed = ExportOptions(format = ExportFormat.Rtf, sceneIds = setOf(3)) - comp.updateExportOptions(confirmed) - comp.confirmExportDialog(confirmed) - comp.endProjectExport() - comp.exportDialogDismissed() - - assertEquals(confirmed, comp.state.value.exportOptions) - } - @Test fun `exportProject delegates to the use case and resets export state`() = runTest(mainTestDispatcher) { val options = ExportOptions(format = ExportFormat.Markdown) diff --git a/common/src/desktopTest/kotlin/components/projecthome/ProjectSettingsComponentTest.kt b/common/src/desktopTest/kotlin/components/projecthome/ProjectSettingsComponentTest.kt index b62a89a54..9bc025c91 100644 --- a/common/src/desktopTest/kotlin/components/projecthome/ProjectSettingsComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projecthome/ProjectSettingsComponentTest.kt @@ -18,9 +18,6 @@ import com.darkrockstudios.apps.hammer.common.data.tagindex.AccountTagService import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.util.AvailableLocalesProvider -import com.darkrockstudios.apps.hammer.common.util.Locale import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory import io.mockk.every import io.mockk.mockk @@ -73,17 +70,8 @@ class ProjectSettingsComponentTest : ComponentTest() { single { mockk { every { availableLocales() } returns emptyList() } } - single { - mockk { - every { allLocales() } returns listOf( - Locale.forLanguage("fr", "FR"), - Locale.forLanguage("en", "US"), - ) - } - } scope { scoped { ProjectDataRepository(datasource, projectDef) } - scoped { ProjectDictionaryUseCase(get()) } scoped { mockk(relaxed = true) } } }) @@ -187,59 +175,6 @@ class ProjectSettingsComponentTest : ComponentTest() { assertEquals(goal, datasource.load().data.wordCountGoal) } - @Test - fun `addDictionaryWord normalizes and persists`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.addDictionaryWord(" Kvothe ") - advanceUntilIdle() - - assertEquals(setOf("Kvothe"), comp.projectInfoState.value.data.dictionaryWords) - assertEquals(setOf("Kvothe"), datasource.load().data.dictionaryWords) - } - - @Test - fun `addDictionaryWord ignores input that is not a single word`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.addDictionaryWord("two words") - comp.addDictionaryWord(" ") - advanceUntilIdle() - - assertEquals(emptySet(), comp.projectInfoState.value.data.dictionaryWords) - } - - @Test - fun `addDictionaryWord ignores a word already present in another case`() = runTest(mainTestDispatcher) { - datasource.save(StoredProjectData(data = ProjectData(dictionaryWords = setOf("Kvothe")))) - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.addDictionaryWord("kvothe") - advanceUntilIdle() - - assertEquals(setOf("Kvothe"), datasource.load().data.dictionaryWords) - } - - @Test - fun `removeDictionaryWord persists the removal`() = runTest(mainTestDispatcher) { - datasource.save(StoredProjectData(data = ProjectData(dictionaryWords = setOf("Kvothe", "Denna")))) - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.removeDictionaryWord("Kvothe") - advanceUntilIdle() - - assertEquals(setOf("Denna"), comp.projectInfoState.value.data.dictionaryWords) - assertEquals(setOf("Denna"), datasource.load().data.dictionaryWords) - } - @Test fun `setTags normalizes tags before persisting`() = runTest(mainTestDispatcher) { val comp = newComponent() @@ -253,45 +188,6 @@ class ProjectSettingsComponentTest : ComponentTest() { assertEquals(setOf("gothic", "haunted"), datasource.load().data.tags) } - @Test - fun `setProjectLanguage persists a normalized tag`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.setProjectLanguage("EN-us") - advanceUntilIdle() - - assertEquals("en-US", comp.projectInfoState.value.data.language) - assertEquals("en-US", datasource.load().data.language) - } - - @Test - fun `setProjectLanguage with null or blank clears the language`() = runTest(mainTestDispatcher) { - datasource.save(StoredProjectData(data = ProjectData(language = "fr"))) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.setProjectLanguage(" ") - advanceUntilIdle() - - assertNull(comp.projectInfoState.value.data.language) - assertNull(datasource.load().data.language) - } - - @Test - fun `availableLanguages are sorted by display name`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - val names = comp.availableLanguages.map { it.displayName } - assertEquals(names.sortedBy { it.lowercase() }, names) - assertEquals(setOf("fr-FR", "en-US"), comp.availableLanguages.map { it.tag }.toSet()) - } - @Test fun `Project tag suggestions come from the account tag vocabulary`() = runTest(mainTestDispatcher) { ideasFlow.value = listOf(idea("gothic", "ghost"), idea("gothic")) diff --git a/common/src/desktopTest/kotlin/components/projectroot/ProjectRootComponentTest.kt b/common/src/desktopTest/kotlin/components/projectroot/ProjectRootComponentTest.kt index f49512098..a12add5af 100644 --- a/common/src/desktopTest/kotlin/components/projectroot/ProjectRootComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectroot/ProjectRootComponentTest.kt @@ -37,7 +37,6 @@ import io.mockk.coVerify import io.mockk.every import io.mockk.mockk import io.mockk.slot -import io.mockk.verify import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.channels.Channel @@ -282,113 +281,6 @@ class ProjectRootComponentTest : ComponentTest() { assertTrue(comp.isAtRoot()) } - @Test - fun `startProjectSync with nothing unsaved requests only the sync`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns true - every { sceneEditor.hasDirtyBuffers() } returns false - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.startProjectSync() - advanceUntilIdle() - - assertEquals(setOf(CloseConfirm.Sync), comp.closeRequestHandlers.value) - } - - @Test - fun `startProjectSync gates on unsaved scenes before the sync`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns true - every { sceneEditor.hasDirtyBuffers() } returns true - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.startProjectSync() - advanceUntilIdle() - - assertEquals(listOf(CloseConfirm.Scenes, CloseConfirm.Sync), comp.closeRequestHandlers.value.toList()) - - comp.closeRequestDealtWith(CloseConfirm.Scenes) - assertEquals(setOf(CloseConfirm.Sync), comp.closeRequestHandlers.value) - } - - @Test - fun `startProjectSync does nothing for local-only projects`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns false - every { sceneEditor.hasDirtyBuffers() } returns true - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.startProjectSync() - advanceUntilIdle() - - assertTrue(comp.closeRequestHandlers.value.isEmpty()) - assertIs(comp.modalRouterState.value.child?.instance) - } - - @Test - fun `Home sync action goes through the gate`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns true - every { sceneEditor.hasDirtyBuffers() } returns true - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - val home = assertIs(comp.routerState.value.active.instance) - home.component.startProjectSync() - advanceUntilIdle() - - assertEquals(listOf(CloseConfirm.Scenes, CloseConfirm.Sync), comp.closeRequestHandlers.value.toList()) - assertIs(comp.modalRouterState.value.child?.instance) - } - - @Test - fun `startProjectSync leaves a pending close request alone`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns true - every { sceneEditor.hasDirtyBuffers() } returns true - coEvery { syncJournal.shouldAutoSync() } returns false - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.requestClose() - advanceUntilIdle() - val pending = comp.closeRequestHandlers.value - - comp.startProjectSync() - advanceUntilIdle() - - assertEquals(pending, comp.closeRequestHandlers.value) - assertTrue(CloseConfirm.Complete in comp.closeRequestHandlers.value) - } - - @Test - fun `Sync dialog closing clears a pending sync request`() = runTest(mainTestDispatcher) { - every { syncJournal.isServerSynchronized() } returns true - every { sceneEditor.hasDirtyBuffers() } returns false - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.startProjectSync() - comp.showProjectSync() - advanceUntilIdle() - assertEquals(setOf(CloseConfirm.Sync), comp.closeRequestHandlers.value) - - comp.dismissProjectSync() - advanceUntilIdle() - - assertTrue(comp.closeRequestHandlers.value.isEmpty()) - } - @Test fun `Global search modal opens and dismisses`() = runTest(mainTestDispatcher) { val comp = newComponent() @@ -548,32 +440,8 @@ class ProjectRootComponentTest : ComponentTest() { advanceUntilIdle() assertTrue(comp.hasUnsavedBuffers()) - assertTrue(comp.unsavedBuffers.value) comp.storeDirtyBuffers() coVerify { sceneEditor.storeAllBuffers() } } - - @Test - fun `Discarding unsaved scenes reverts the editor buffers`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Scenes) - - verify { sceneEditor.discardAllBuffers() } - } - - @Test - fun `Discarding sync or completion touches nothing`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.discardUnsaved(CloseConfirm.Sync) - comp.discardUnsaved(CloseConfirm.Complete) - - verify(exactly = 0) { sceneEditor.discardAllBuffers() } - } } diff --git a/common/src/desktopTest/kotlin/components/projectselection/AccountSettingsComponentTest.kt b/common/src/desktopTest/kotlin/components/projectselection/AccountSettingsComponentTest.kt index 5dabeeeec..f8ae24eff 100644 --- a/common/src/desktopTest/kotlin/components/projectselection/AccountSettingsComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectselection/AccountSettingsComponentTest.kt @@ -3,24 +3,18 @@ package components.projectselection import com.arkivanov.decompose.DefaultComponentContext import com.arkivanov.essenty.lifecycle.LifecycleRegistry import com.arkivanov.essenty.lifecycle.resume -import com.darkrockstudios.apps.hammer.base.ProjectId import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettingsComponent import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.PlatformSettings -import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata import com.darkrockstudios.apps.hammer.common.data.ExampleProjectRepository +import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase import com.darkrockstudios.apps.hammer.common.data.account.ServerSetupResult import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.NewUserExperience import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.getDefaultRootDocumentDirectory import com.darkrockstudios.apps.hammer.common.util.StrRes import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory import io.mockk.coEvery @@ -33,23 +27,16 @@ import kotlin.test.assertNotNull import kotlin.test.assertNull import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.flow.MutableSharedFlow +import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest -import net.peanuuutz.tomlkt.Toml -import okio.FileSystem -import okio.ForwardingFileSystem -import okio.Path -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem import org.junit.jupiter.api.Assertions.assertFalse import org.junit.jupiter.api.Assertions.assertTrue import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Test import org.koin.dsl.bind import org.koin.dsl.module -import org.koin.test.get import utils.BaseTest -import kotlin.time.Clock @OptIn(ExperimentalCoroutinesApi::class) class AccountSettingsComponentTest : BaseTest() { @@ -57,27 +44,18 @@ class AccountSettingsComponentTest : BaseTest() { private lateinit var lifecycle: LifecycleRegistry private lateinit var context: DefaultComponentContext - private lateinit var ffs: FakeFileSystem - private lateinit var toml: Toml private lateinit var globalSettingsStore: GlobalSettingsStore private lateinit var globalSettingsUpdates: MutableSharedFlow - private lateinit var serverSettingsUpdates: MutableSharedFlow + private lateinit var serverSettingsUpdates: SharedFlow private lateinit var accountUseCase: AccountUseCase private lateinit var projectsRepository: ProjectsRepository - /** Set by a test to interleave an action with the post-success wipe. */ - private var onFirstDelete: (() -> Unit)? = null - - private val projectsDir: Path = - getDefaultRootDocumentDirectory().toPath() / GlobalSettingsStore.DEFAULT_PROJECTS_DIR - private var globalSettings = GlobalSettings( - projectsDirectory = projectsDir.toString(), + projectsDirectory = "", spellCheckSettings = SpellCheckerSettings(locale = mockk()), automaticSyncing = true, autoCloseSyncDialog = true, automaticBackups = true, - nux = NewUserExperience(exampleProjectCreated = true), ) @BeforeEach @@ -87,13 +65,6 @@ class AccountSettingsComponentTest : BaseTest() { lifecycle = LifecycleRegistry() context = DefaultComponentContext(lifecycle = lifecycle) - ffs = FakeFileSystem() - ffs.createDirectories(projectsDir) - toml = createTomlSerializer() - - onFirstDelete = null - val hookedFs = DeleteHookFileSystem(ffs) { onFirstDelete?.invoke() } - globalSettingsStore = mockk(relaxed = true) globalSettingsUpdates = MutableSharedFlow(replay = 1) every { globalSettingsStore.globalSettingsUpdates } returns globalSettingsUpdates @@ -106,107 +77,23 @@ class AccountSettingsComponentTest : BaseTest() { every { spellCheckerFactory.availableLocales() } returns emptyList() accountUseCase = mockk(relaxed = true) + projectsRepository = mockk(relaxed = true) val testModule = module { - single { hookedFs } - single { toml } single { globalSettingsStore } bind GlobalSettingsStore::class - single { Clock.System } - single { - ProjectsRepository( - fileSystem = hookedFs, - globalSettingsStore = globalSettingsStore, - projectsMetadataDatasource = ProjectMetadataDatasource(hookedFs, toml), - toml = toml, - json = createJsonSerializer(), - deviceLocaleResolver = mockk(relaxed = true), - ) - } bind ProjectsRepository::class - single { - FakeExampleProjectRepository(globalSettingsStore, hookedFs, toml, get()) - } bind ExampleProjectRepository::class + single { mockk(relaxed = true) } bind ExampleProjectRepository::class single { accountUseCase } bind AccountUseCase::class + single { projectsRepository } bind ProjectsRepository::class single { mockk(relaxed = true) } bind StrRes::class single { spellCheckerFactory } factory { mockk(relaxed = true) } bind PlatformSettings::class } setupKoin(testModule) - projectsRepository = get() lifecycle.resume() } private fun newComponent() = AccountSettingsComponent(componentContext = context) - private fun seedProject(name: String) { - val dir = projectsDir / name - ffs.createDirectories(dir) - ffs.write(dir / ProjectMetadata.FILENAME) { writeUtf8("") } - } - - private fun localProjectNames(): List = - ffs.list(projectsDir).map { it.name }.sorted() - - private fun setupSucceeds() { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any(), any()) } returns - ServerSetupResult.Success - } - - private fun AccountSettingsComponent.logIn( - url: String = "example.com", - email: String = "writer@example.com", - replaceLocalContent: Boolean = false, - ) = setupServer( - url = url, - email = email, - password = "Password1!", - create = false, - replaceLocalContent = replaceLocalContent, - ) - - @Test - fun `An http url logs in to a plaintext server`() = runTest { - setupSucceeds() - val component = newComponent() - advanceUntilIdle() - - component.logIn(url = "http://192.168.1.50:8080") - advanceUntilIdle() - - coVerify { accountUseCase.setupServer("192.168.1.50:8080", any(), any(), any(), any(), false) } - } - - @Test - fun `A bare host logs in over https`() = runTest { - setupSucceeds() - val component = newComponent() - advanceUntilIdle() - - component.logIn(url = "hammer.ink") - advanceUntilIdle() - - coVerify { accountUseCase.setupServer("hammer.ink", any(), any(), any(), any(), true) } - } - - @Test - fun `Typing an http url warns that it is insecure`() = runTest { - val component = newComponent() - advanceUntilIdle() - - component.updateServerUrl("http://192.168.1.50:8080") - assertTrue(component.state.value.serverUrlInsecure) - - component.updateServerUrl("hammer.ink") - assertFalse(component.state.value.serverUrlInsecure) - } - - private fun AccountSettingsComponent.createAccount() = setupServer( - url = "example.com", - email = "writer@example.com", - password = "Password1!", - create = true, - replaceLocalContent = false, - ) - @Test fun `Auto-sync setting update is reflected in state`() = runTest { val component = newComponent() @@ -233,276 +120,63 @@ class AccountSettingsComponentTest : BaseTest() { @Test fun `Creating a new account clears stale server project IDs`() = runTest { - seedProject(PROJECT_A) - seedProject(PROJECT_B) - setupSucceeds() + val projectA = mockk() + val projectB = mockk() + every { projectsRepository.getProjects() } returns listOf(projectA, projectB) + coEvery { + accountUseCase.setupServer( + any(), + any(), + any(), + any(), + any() + ) + } returns ServerSetupResult.Success val component = newComponent() - advanceUntilIdle() - projectsRepository.setProjectId( - projectsRepository.getProjectDefinition(PROJECT_A), - ProjectId("stale-a"), + component.setupServer( + url = "example.com", + email = "writer@example.com", + password = "Password1!", + create = true, + removeLocalContent = false, ) - projectsRepository.setProjectId( - projectsRepository.getProjectDefinition(PROJECT_B), - ProjectId("stale-b"), - ) - - component.createAccount() advanceUntilIdle() - assertNull(projectsRepository.getProjectId(projectsRepository.getProjectDefinition(PROJECT_A))) - assertNull(projectsRepository.getProjectId(projectsRepository.getProjectDefinition(PROJECT_B))) + verify { projectsRepository.removeProjectId(projectA) } + verify { projectsRepository.removeProjectId(projectB) } } @Test fun `Logging in to an existing account leaves server project IDs untouched`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - - val component = newComponent() - advanceUntilIdle() - val projectA = projectsRepository.getProjectDefinition(PROJECT_A) - projectsRepository.setProjectId(projectA, ProjectId("keep-me")) - - component.logIn() - advanceUntilIdle() - component.chooseMerge() - advanceUntilIdle() - - assertEquals(ProjectId("keep-me"), projectsRepository.getProjectId(projectA)) - } - - @Test - fun `A failed login leaves local projects untouched`() = runTest { - seedProject(PROJECT_A) - seedProject(PROJECT_B) - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns - ServerSetupResult.Failure(displayMessage = null, exception = null) - - val component = newComponent() - component.logIn(replaceLocalContent = true) - advanceUntilIdle() - - assertEquals(listOf(PROJECT_A, PROJECT_B), localProjectNames()) - } - - @Test - fun `Logging in with only the example project silently drops it`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) - setupSucceeds() - - val component = newComponent() - component.logIn() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - assertEquals(emptyList(), localProjectNames()) - } - - @Test - fun `A failed login with only the example project keeps it`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns - ServerSetupResult.Failure(displayMessage = null, exception = null) - - val component = newComponent() - component.logIn() - advanceUntilIdle() - - assertEquals(listOf(ExampleProjectRepository.PROJECT_NAME), localProjectNames()) - } - - @Test - fun `Declining terms of service keeps the example project`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) + val projectA = mockk() + every { projectsRepository.getProjects() } returns listOf(projectA) coEvery { - accountUseCase.setupServer(any(), any(), any(), any(), null) - } returns ServerSetupResult.TermsRequired(TermsOfServiceChallenge(text = "Legal text", version = "v1")) - - val component = newComponent() - component.logIn() - advanceUntilIdle() - component.declineTos() - advanceUntilIdle() - - assertEquals(listOf(ExampleProjectRepository.PROJECT_NAME), localProjectNames()) - } - - @Test - fun `Accepting terms of service still drops the example project`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) - coEvery { - accountUseCase.setupServer(any(), any(), any(), any(), null) - } returns ServerSetupResult.TermsRequired(TermsOfServiceChallenge(text = "Legal text", version = "v1")) - coEvery { - accountUseCase.setupServer(any(), any(), any(), any(), "v1") + accountUseCase.setupServer( + any(), + any(), + any(), + any(), + any() + ) } returns ServerSetupResult.Success val component = newComponent() - component.logIn() - advanceUntilIdle() - component.acceptTos() - advanceUntilIdle() - - assertEquals(emptyList(), localProjectNames()) - } - - @Test - fun `Creating an account with only the example project keeps it`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) - setupSucceeds() - - val component = newComponent() - component.createAccount() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - assertEquals(listOf(ExampleProjectRepository.PROJECT_NAME), localProjectNames()) - } - - @Test - fun `Creating an account with real projects never prompts`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - - val component = newComponent() - component.createAccount() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - assertEquals(listOf(PROJECT_A), localProjectNames()) - } - - @Test - fun `Logging in to a new server with real projects raises the merge prompt`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - - val component = newComponent() - component.logIn() - advanceUntilIdle() - - assertTrue(component.state.value.mergePrompt) - assertFalse(component.state.value.serverSetup) - coVerify(exactly = 0) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } - } - - @Test - fun `Choosing merge runs the setup and keeps every local project`() = runTest { - seedProject(PROJECT_A) - seedProject(PROJECT_B) - setupSucceeds() - - val component = newComponent() - component.logIn() - advanceUntilIdle() - component.chooseMerge() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - coVerify(exactly = 1) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } - assertEquals(listOf(PROJECT_A, PROJECT_B), localProjectNames()) - } - - @Test - fun `Choosing replace deletes every local project`() = runTest { - seedProject(PROJECT_A) - seedProject(PROJECT_B) - setupSucceeds() - - val component = newComponent() - component.logIn() - advanceUntilIdle() - component.chooseReplace() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - assertEquals(emptyList(), localProjectNames()) - } - - @Test - fun `Cancelling the merge prompt returns to setup without contacting the server`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - - val component = newComponent() - component.logIn() - advanceUntilIdle() - component.cancelMergePrompt() - advanceUntilIdle() - - assertFalse(component.state.value.mergePrompt) - assertTrue(component.state.value.serverSetup) - coVerify(exactly = 0) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } - assertEquals(listOf(PROJECT_A), localProjectNames()) - } - - @Test - fun `Re-authenticating against the configured server never prompts`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - serverSettingsUpdates.emit( - ServerSettings( - url = "example.com", - email = "writer@example.com", - userId = 1L, - bearerToken = null, - refreshToken = null, - ) + component.setupServer( + url = "example.com", + email = "writer@example.com", + password = "Password1!", + create = false, + removeLocalContent = false, ) - - val component = newComponent() - advanceUntilIdle() - component.logIn() advanceUntilIdle() - assertFalse(component.state.value.mergePrompt) - coVerify(exactly = 1) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } - assertEquals(listOf(PROJECT_A), localProjectNames()) - } - - @Test - fun `Re-authenticating against the configured server keeps the example project`() = runTest { - seedProject(ExampleProjectRepository.PROJECT_NAME) - setupSucceeds() - serverSettingsUpdates.emit( - ServerSettings( - url = "example.com", - email = "writer@example.com", - userId = 1L, - bearerToken = null, - refreshToken = null, - ) - ) - - val component = newComponent() - advanceUntilIdle() - component.logIn() - advanceUntilIdle() - - assertEquals(listOf(ExampleProjectRepository.PROJECT_NAME), localProjectNames()) - } - - @Test - fun `Cancelling while the post-success wipe runs keeps the new credentials`() = runTest { - seedProject(PROJECT_A) - setupSucceeds() - - val component = newComponent() - advanceUntilIdle() - // The wipe runs off the main dispatcher, so a close or ESC can land while it is in flight. - // By then the account exists and its tokens must survive. - onFirstDelete = { component.cancelServerSetup() } - component.logIn(replaceLocalContent = true) - advanceUntilIdle() - - verify(exactly = 0) { globalSettingsStore.deleteServerSettings() } - assertEquals(emptyList(), localProjectNames()) + verify(exactly = 0) { projectsRepository.removeProjectId(any()) } } @Test fun `Terms of service challenge is surfaced and acceptance retries the request`() = runTest { + every { projectsRepository.getProjects() } returns emptyList() coEvery { accountUseCase.setupServer(any(), any(), any(), any(), null) } returns ServerSetupResult.TermsRequired(TermsOfServiceChallenge(text = "Legal text", version = "v1")) @@ -511,7 +185,13 @@ class AccountSettingsComponentTest : BaseTest() { } returns ServerSetupResult.Success val component = newComponent() - component.createAccount() + component.setupServer( + url = "example.com", + email = "writer@example.com", + password = "Password1!", + create = true, + removeLocalContent = false, + ) advanceUntilIdle() assertEquals("Legal text", component.state.value.tosChallenge?.text) @@ -533,7 +213,13 @@ class AccountSettingsComponentTest : BaseTest() { } returns ServerSetupResult.TermsRequired(TermsOfServiceChallenge(text = "Legal text", version = "v1")) val component = newComponent() - component.createAccount() + component.setupServer( + url = "example.com", + email = "writer@example.com", + password = "Password1!", + create = true, + removeLocalContent = false, + ) advanceUntilIdle() assertNotNull(component.state.value.tosChallenge) @@ -546,42 +232,4 @@ class AccountSettingsComponentTest : BaseTest() { // Only the initial challenge attempt ran; declining never resubmits. coVerify(exactly = 1) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } } - - private companion object { - const val PROJECT_A = "Test Project A" - const val PROJECT_B = "Test Project B" - } -} - -/** Runs [onFirstDelete] once, on the first deletion, so a test can act from inside a wipe. */ -private class DeleteHookFileSystem( - delegate: FileSystem, - private val onFirstDelete: () -> Unit, -) : ForwardingFileSystem(delegate) { - private var fired = false - - override fun delete(path: Path, mustExist: Boolean) { - if (!fired) { - fired = true - onFirstDelete() - } - super.delete(path, mustExist) - } -} - -private class FakeExampleProjectRepository( - globalSettingsStore: GlobalSettingsStore, - fileSystem: FileSystem, - toml: Toml, - clock: Clock, -) : ExampleProjectRepository(globalSettingsStore, fileSystem, toml, clock) { - override fun removeExampleProject() { - fileSystem.deleteRecursively(projectsDir() / PROJECT_NAME) - } - - override fun platformInstall() { - val dir = projectsDir() / PROJECT_NAME - fileSystem.createDirectories(dir) - fileSystem.write(dir / ProjectMetadata.FILENAME) { writeUtf8("") } - } } diff --git a/common/src/desktopTest/kotlin/components/projectselection/ProjectSelectionComponentTest.kt b/common/src/desktopTest/kotlin/components/projectselection/ProjectSelectionComponentTest.kt index 11ce492c5..9ce59a1b5 100644 --- a/common/src/desktopTest/kotlin/components/projectselection/ProjectSelectionComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectselection/ProjectSelectionComponentTest.kt @@ -12,15 +12,16 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ClientAccountSynchronizer -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.changelog.Changelog -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogRepository +import com.darkrockstudios.apps.hammer.common.data.versioncheck.GithubReleaseInfo +import com.darkrockstudios.apps.hammer.common.data.versioncheck.ShouldNotifyOfUpdateUseCase +import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath import com.darkrockstudios.apps.hammer.common.util.UrlLauncher import getProjectsDirectory import io.mockk.* +import kotlinx.coroutines.channels.BufferOverflow +import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.first import kotlinx.coroutines.test.advanceUntilIdle @@ -34,7 +35,6 @@ import org.junit.jupiter.api.Test import org.koin.dsl.bind import org.koin.dsl.module import utils.BaseTest -import utils.FakeAppUpdater @OptIn(kotlinx.coroutines.ExperimentalCoroutinesApi::class) class ProjectSelectionComponentTest : BaseTest() { @@ -51,9 +51,9 @@ class ProjectSelectionComponentTest : BaseTest() { lateinit var projectsRepository: ProjectsRepository lateinit var exampleProjectRepository: ExampleProjectRepository lateinit var projectsSynchronizer: ClientAccountSynchronizer - lateinit var changelogRepository: ChangelogRepository + lateinit var versionCheckRepository: VersionCheckRepository + lateinit var versionCheckUpdates: MutableSharedFlow lateinit var urlLauncher: UrlLauncher - lateinit var appUpdater: FakeAppUpdater private var globalSettings: GlobalSettings = GlobalSettings( projectsDirectory = "", @@ -75,18 +75,24 @@ class ProjectSelectionComponentTest : BaseTest() { projectsRepository = mockk() exampleProjectRepository = mockk() projectsSynchronizer = mockk() - changelogRepository = mockk(relaxed = true) + versionCheckRepository = mockk() urlLauncher = mockk(relaxed = true) - appUpdater = FakeAppUpdater() + + versionCheckUpdates = MutableSharedFlow( + extraBufferCapacity = 1, + replay = 1, + onBufferOverflow = BufferOverflow.DROP_OLDEST, + ) + every { versionCheckRepository.updates } returns versionCheckUpdates val testModule = module { single { globalSettingsStore } bind GlobalSettingsStore::class single { projectsRepository } bind ProjectsRepository::class single { exampleProjectRepository } bind ExampleProjectRepository::class single { projectsSynchronizer } - single { changelogRepository } + single { versionCheckRepository } single { urlLauncher } bind UrlLauncher::class - single { appUpdater } + factory { ShouldNotifyOfUpdateUseCase() } } setupKoin(testModule) lifecycle.resume() @@ -122,118 +128,119 @@ class ProjectSelectionComponentTest : BaseTest() { onProjectSelected = {}, ) - @Test - fun `app update state mirrors the updater`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns false - - val component = newComponent() - advanceUntilIdle() - assertEquals(AppUpdateState.Idle, component.appUpdate.value) - - val available = AppUpdateState.Available(version = "9.9.9", installable = true) - appUpdater.state.value = available - advanceUntilIdle() - - assertEquals(available, component.appUpdate.value) - } - - @Test - fun `update and dismiss are handed to the updater`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns false - - val component = newComponent() - advanceUntilIdle() - component.updateApp() - component.dismissUpdate() - - assertEquals(1, appUpdater.updates) - assertEquals(1, appUpdater.dismissals) - } - - private val changelog = Changelog( - version = "99.0.0", - date = "2026-8-4", - notes = "[New]\n- A thing", + private fun release(tag: String) = GithubReleaseInfo( + tagName = tag, + name = "Release $tag", + body = "Notes for $tag", + htmlUrl = "https://github.com/Darkrock-Studios/hammer-editor/releases/tag/$tag", ) @Test - fun `Dialog visible on launch when the baked changelog has not been seen`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns true - coEvery { changelogRepository.getChangelog() } returns changelog + fun `Dialog visible on launch when new version available and not previously dismissed`() = runTest { + coEvery { versionCheckRepository.checkForUpdate(any()) } answers { + val result = VersionCheckRepository.VersionCheckResult( + latestRelease = release("v99.0.0"), + isNewVersionAvailable = true, + currentVersion = "v1.0.0", + ) + versionCheckUpdates.tryEmit(result) + result + } val component = newComponent() advanceUntilIdle() - val state = component.changelog.value + val state = component.updateNotification.value assertTrue(state.visible) - assertEquals("99.0.0", state.version) - assertEquals("2026-8-4", state.date) - assertEquals("[New]\n- A thing", state.notes) + assertEquals("v99.0.0", state.latestVersionTag) + assertEquals("Notes for v99.0.0", state.releaseBody) } @Test - fun `Dialog hidden on launch when the changelog has already been seen`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns false + fun `Dialog hidden when latest tag matches lastDismissedUpdateVersion`() = runTest { + globalSettings = globalSettings.copy(lastDismissedUpdateVersion = "v99.0.0") + coEvery { versionCheckRepository.checkForUpdate(any()) } returns + VersionCheckRepository.VersionCheckResult( + latestRelease = release("v99.0.0"), + isNewVersionAvailable = true, + currentVersion = "v1.0.0", + ) val component = newComponent() advanceUntilIdle() - assertFalse(component.changelog.value.visible) - coVerify(exactly = 0) { changelogRepository.getChangelog() } + assertFalse(component.updateNotification.value.visible) } @Test - fun `Launch never checks GitHub for a version`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns true - coEvery { changelogRepository.getChangelog() } returns changelog - - newComponent() - advanceUntilIdle() - - // The whole point of baking the changelog in: startup makes no network request. - coVerify(exactly = 0) { urlLauncher.openInBrowser(any()) } - } - - @Test - fun `dismissChangelog hides the dialog and marks it seen`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns true - coEvery { changelogRepository.getChangelog() } returns changelog + fun `Dialog hidden when no new version is available`() = runTest { + coEvery { versionCheckRepository.checkForUpdate(any()) } returns + VersionCheckRepository.VersionCheckResult( + latestRelease = release("v1.0.0"), + isNewVersionAvailable = false, + currentVersion = "v1.0.0", + ) val component = newComponent() advanceUntilIdle() - component.dismissChangelog() - advanceUntilIdle() - assertFalse(component.changelog.value.visible) - coVerify(exactly = 1) { changelogRepository.markSeen() } + assertFalse(component.updateNotification.value.visible) } @Test - fun `showChangelog reopens the dialog after it was dismissed`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns false - coEvery { changelogRepository.getChangelog() } returns changelog + fun `dismissUpdateNotification with remember writes lastDismissedUpdateVersion`() = runTest { + coEvery { versionCheckRepository.checkForUpdate(any()) } returns + VersionCheckRepository.VersionCheckResult( + latestRelease = release("v99.0.0"), + isNewVersionAvailable = true, + currentVersion = "v1.0.0", + ) + val captured = slot<(GlobalSettings) -> GlobalSettings>() + coEvery { globalSettingsStore.updateSettings(capture(captured)) } just Runs val component = newComponent() advanceUntilIdle() - assertFalse(component.changelog.value.visible) - - component.showChangelog() + component.dismissUpdateNotification(remember = true) advanceUntilIdle() - assertTrue(component.changelog.value.visible) - assertEquals("99.0.0", component.changelog.value.version) + assertFalse(component.updateNotification.value.visible) + val updated = captured.captured(globalSettings) + assertEquals("v99.0.0", updated.lastDismissedUpdateVersion) } @Test - fun `openLatestRelease launches the releases page`() = runTest { - coEvery { changelogRepository.hasUnseenChangelog() } returns false + fun `dismissUpdateNotification without remember does not write settings`() = runTest { + coEvery { versionCheckRepository.checkForUpdate(any()) } returns + VersionCheckRepository.VersionCheckResult( + latestRelease = release("v99.0.0"), + isNewVersionAvailable = true, + currentVersion = "v1.0.0", + ) val component = newComponent() advanceUntilIdle() - component.openLatestRelease() + component.dismissUpdateNotification(remember = false) + advanceUntilIdle() + + assertFalse(component.updateNotification.value.visible) + coVerify(exactly = 0) { globalSettingsStore.updateSettings(any()) } + } + + @Test + fun `openReleaseUrl launches the release URL`() = runTest { + coEvery { versionCheckRepository.checkForUpdate(any()) } returns + VersionCheckRepository.VersionCheckResult( + latestRelease = release("v99.0.0"), + isNewVersionAvailable = true, + currentVersion = "v1.0.0", + ) + + val component = newComponent() + advanceUntilIdle() + component.openReleaseUrl() coVerify(exactly = 1) { - urlLauncher.openInBrowser("https://github.com/Darkrock-Studios/hammer-editor/releases/latest") + urlLauncher.openInBrowser("https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v99.0.0") } } } diff --git a/common/src/desktopTest/kotlin/components/projectselection/ServerUrlValidationTest.kt b/common/src/desktopTest/kotlin/components/projectselection/ServerUrlValidationTest.kt deleted file mode 100644 index 1faeeaf8f..000000000 --- a/common/src/desktopTest/kotlin/components/projectselection/ServerUrlValidationTest.kt +++ /dev/null @@ -1,126 +0,0 @@ -package components.projectselection - -import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettingsComponent.Companion.cleanUpUrl -import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettingsComponent.Companion.validateUrl -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -class ServerUrlValidationTest { - - @Test - fun `a pasted http scheme is stripped`() { - assertEquals("192.168.1.50:8080", cleanUpUrl("http://192.168.1.50:8080")) - } - - @Test - fun `a pasted https scheme is stripped`() { - assertEquals("hammer.example.com", cleanUpUrl("https://hammer.example.com")) - } - - @Test - fun `surrounding whitespace and a trailing slash are stripped`() { - assertEquals("hammer.example.com", cleanUpUrl(" https://hammer.example.com/ ")) - } - - @Test - fun `a url with no scheme is left alone`() { - assertEquals("hammer.ink", cleanUpUrl("hammer.ink")) - } - - @Test - fun `a mixed case host is lowercased`() { - assertEquals("hammer.example.com", cleanUpUrl("Hammer.Example.COM")) - } - - @Test - fun `an uppercase scheme is stripped`() { - assertEquals("hammer.example.com", cleanUpUrl("HTTPS://Hammer.Example.com")) - } - - @Test - fun `a cleaned pasted url validates`() { - assertTrue(validateUrl(cleanUpUrl("http://192.168.1.50:8080"))) - } - - @Test - fun `a domain with a port validates`() { - assertTrue(validateUrl("hammer.example.com:8080")) - } - - @Test - fun `a bare lan hostname validates`() { - assertTrue(validateUrl("homeserver:8080")) - } - - @Test - fun `a hostname with a hyphen validates`() { - assertTrue(validateUrl("home-server.lan:8080")) - } - - @Test - fun `a hyphen in a subdomain validates`() { - assertTrue(validateUrl("my-sub.example.com")) - } - - @Test - fun `a hyphen in a middle label validates`() { - assertTrue(validateUrl("machine.tailnet-name.ts.net")) - } - - @Test - fun `a mixed case hostname validates`() { - assertTrue(validateUrl("Hammer.Example.com")) - } - - @Test - fun `an ip address validates`() { - assertTrue(validateUrl("192.168.1.50")) - } - - @Test - fun `a blank url does not validate`() { - assertFalse(validateUrl(" ")) - } - - @Test - fun `a url still carrying its scheme does not validate`() { - assertFalse(validateUrl("http://hammer.example.com")) - } - - @Test - fun `a url with a path does not validate`() { - assertFalse(validateUrl("hammer.example.com/sync")) - } - - @Test - fun `a non numeric port does not validate`() { - assertFalse(validateUrl("hammer.example.com:port")) - } - - @Test - fun `a port beyond the valid range does not validate`() { - assertFalse(validateUrl("hammer.example.com:99999")) - } - - @Test - fun `a host with a trailing hyphen does not validate`() { - assertFalse(validateUrl("hammer-.example.com")) - } - - @Test - fun `a host with a leading hyphen does not validate`() { - assertFalse(validateUrl("-hammer.example.com")) - } - - @Test - fun `a host with an empty label does not validate`() { - assertFalse(validateUrl("hammer..com")) - } - - @Test - fun `a host with an underscore does not validate`() { - assertFalse(validateUrl("hammer_example.com")) - } -} diff --git a/common/src/desktopTest/kotlin/components/projectselection/accountsettings/BackupManagerComponentTest.kt b/common/src/desktopTest/kotlin/components/projectselection/accountsettings/BackupManagerComponentTest.kt index 60f28fa95..dd9e861a4 100644 --- a/common/src/desktopTest/kotlin/components/projectselection/accountsettings/BackupManagerComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectselection/accountsettings/BackupManagerComponentTest.kt @@ -5,9 +5,9 @@ import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.projectbackup.BackupManagerService import com.darkrockstudios.apps.hammer.common.data.projectbackup.ProjectBackupDef import com.darkrockstudios.apps.hammer.common.data.projectbackup.ProjectBackupRepository +import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.fileio.HPath import com.darkrockstudios.apps.hammer.common.util.StrRes -import io.mockk.coEvery import io.mockk.coVerify import io.mockk.every import io.mockk.mockk @@ -30,10 +30,12 @@ import kotlin.time.Instant class BackupManagerComponentTest : ComponentTest() { private lateinit var backupRepository: ProjectBackupRepository + private lateinit var projectsRepository: ProjectsRepository private lateinit var backupManagerService: BackupManagerService private val projAlpha = ProjectDef("Alpha", HPath("/projects/Alpha", "Alpha", false)) private val projZulu = ProjectDef("Zulu", HPath("/projects/Zulu", "Zulu", false)) + private val projNoBackups = ProjectDef("NoBackups", HPath("/projects/NoBackups", "NoBackups", false)) private val alphaOld = backup(projAlpha, "alpha-old.zip", at = 100) private val alphaNew = backup(projAlpha, "alpha-new.zip", at = 200) @@ -54,14 +56,17 @@ class BackupManagerComponentTest : ComponentTest() { alphaBackups = listOf(alphaOld, alphaNew) backupRepository = mockk(relaxed = true) + projectsRepository = mockk(relaxed = true) backupManagerService = mockk(relaxed = true) - every { backupRepository.getBackedUpProjects() } returns listOf(projAlpha, projZulu) + every { projectsRepository.getProjects() } returns listOf(projAlpha, projZulu, projNoBackups) every { backupRepository.getBackups(projAlpha) } answers { alphaBackups } every { backupRepository.getBackups(projZulu) } returns listOf(zuluBackup) + every { backupRepository.getBackups(projNoBackups) } returns emptyList() setupKoin(module { single { backupRepository } + single { projectsRepository } single { backupManagerService } single { TestStrRes() } }) @@ -94,7 +99,7 @@ class BackupManagerComponentTest : ComponentTest() { @Test fun `a failure while loading projects surfaces an error`() = runTest(mainTestDispatcher) { - every { backupRepository.getBackedUpProjects() } throws RuntimeException("disk exploded") + every { projectsRepository.getProjects() } throws RuntimeException("disk exploded") val comp = newComponent() context.resume() @@ -163,20 +168,6 @@ class BackupManagerComponentTest : ComponentTest() { coVerify(exactly = 1) { backupRepository.restoreBackup(alphaNew, projAlpha.path) } } - @Test - fun `a failed restore surfaces an error`() = runTest(mainTestDispatcher) { - coEvery { backupRepository.restoreBackup(any(), any()) } returns false - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.restoreBackup(alphaNew) - advanceUntilIdle() - - assertNotNull(comp.state.value.error) - } - @Test fun `exportBackup delegates to the backup manager service`() = runTest(mainTestDispatcher) { val comp = newComponent() diff --git a/common/src/desktopTest/kotlin/components/projectselection/accountsettings/DesktopPlatformSettingsComponentTest.kt b/common/src/desktopTest/kotlin/components/projectselection/accountsettings/DesktopPlatformSettingsComponentTest.kt deleted file mode 100644 index bf13efd69..000000000 --- a/common/src/desktopTest/kotlin/components/projectselection/accountsettings/DesktopPlatformSettingsComponentTest.kt +++ /dev/null @@ -1,109 +0,0 @@ -package components.projectselection.accountsettings - -import com.arkivanov.decompose.DefaultComponentContext -import com.arkivanov.essenty.lifecycle.LifecycleRegistry -import com.arkivanov.essenty.lifecycle.resume -import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.DesktopPlatformSettingsComponent -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.sandbox.NoopSandboxFileAccess -import com.darkrockstudios.apps.hammer.common.sandbox.SandboxFileAccess -import io.mockk.Runs -import io.mockk.coEvery -import io.mockk.every -import io.mockk.just -import io.mockk.mockk -import io.mockk.slot -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.test.advanceUntilIdle -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.bind -import org.koin.dsl.module -import utils.BaseTest -import utils.FakeAppUpdater - -@OptIn(kotlinx.coroutines.ExperimentalCoroutinesApi::class) -class DesktopPlatformSettingsComponentTest : BaseTest() { - - private lateinit var settingsStore: GlobalSettingsStore - private lateinit var settingsUpdates: MutableSharedFlow - private lateinit var appUpdater: FakeAppUpdater - - private val settings = GlobalSettings( - projectsDirectory = "/projects", - spellCheckSettings = SpellCheckerSettings(locale = mockk()), - ) - - @BeforeEach - override fun setup() { - super.setup() - - settingsStore = mockk(relaxed = true) - settingsUpdates = MutableSharedFlow(extraBufferCapacity = 1) - every { settingsStore.globalSettings } returns settings - every { settingsStore.globalSettingsUpdates } returns settingsUpdates - - val projectsRepository = mockk() - every { projectsRepository.getProjectsDirectory() } returns HPath("/projects", "projects", isAbsolute = true) - - appUpdater = FakeAppUpdater() - - setupKoin( - module { - single { settingsStore } bind GlobalSettingsStore::class - single { projectsRepository } bind ProjectsRepository::class - single { NoopSandboxFileAccess } - single { appUpdater } - } - ) - } - - private fun newComponent(): DesktopPlatformSettingsComponent { - val lifecycle = LifecycleRegistry() - val component = DesktopPlatformSettingsComponent(DefaultComponentContext(lifecycle = lifecycle)) - lifecycle.resume() - return component - } - - @Test - fun `the update toggle is offered only on a build that can update`() = runTest { - appUpdater.state.value = AppUpdateState.Idle - assertTrue(newComponent().state.value.updateChecksSupported) - - appUpdater.state.value = AppUpdateState.Unsupported - assertFalse(newComponent().state.value.updateChecksSupported) - } - - @Test - fun `the stored preference is mirrored into the state`() = runTest { - val component = newComponent() - advanceUntilIdle() - assertTrue(component.state.value.automaticUpdateChecks) - - settingsUpdates.emit(settings.copy(automaticUpdateChecks = false)) - advanceUntilIdle() - - assertFalse(component.state.value.automaticUpdateChecks) - } - - @Test - fun `turning the preference off writes it to the settings`() = runTest { - val component = newComponent() - val update = slot<(GlobalSettings) -> GlobalSettings>() - coEvery { settingsStore.updateSettings(capture(update)) } just Runs - - component.setAutomaticUpdateChecks(false) - advanceUntilIdle() - - assertFalse(update.captured(settings).automaticUpdateChecks) - } -} diff --git a/common/src/desktopTest/kotlin/components/projectselection/projectslist/ProjectsListComponentTest.kt b/common/src/desktopTest/kotlin/components/projectselection/projectslist/ProjectsListComponentTest.kt index 4672d4ae9..1359e5607 100644 --- a/common/src/desktopTest/kotlin/components/projectselection/projectslist/ProjectsListComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectselection/projectslist/ProjectsListComponentTest.kt @@ -1,16 +1,11 @@ package components.projectselection.projectslist import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.projects_list_toast_delete_failed -import com.darkrockstudios.apps.hammer.common.components.ToastMessage import com.darkrockstudios.apps.hammer.common.components.projectselection.projectslist.ProjectsList import com.darkrockstudios.apps.hammer.common.components.projectselection.projectslist.ProjectsListComponent import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.Info import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.SyncedProjectDefinition import com.darkrockstudios.apps.hammer.common.data.account.AccountReauthUseCase @@ -18,17 +13,14 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import com.darkrockstudios.apps.hammer.common.data.importer.ImportPreview import com.darkrockstudios.apps.hammer.common.data.importer.MarkdownStoryImporter import com.darkrockstudios.apps.hammer.common.data.importer.RtfStoryImporter -import com.darkrockstudios.apps.hammer.common.data.importer.StoryImporter import com.darkrockstudios.apps.hammer.common.data.importer.StoryImporterRegistry import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.projectstatistics.ProjectStatisticsCacheReader import com.darkrockstudios.apps.hammer.common.data.protocolmismatch.ProtocolMismatchRepository import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ClientAccountSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountUseCase import com.darkrockstudios.apps.hammer.common.data.toMsg import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckDataSource import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository @@ -43,11 +35,8 @@ import io.mockk.every import io.mockk.mockk import io.mockk.slot import io.mockk.verify -import kotlinx.coroutines.CoroutineStart import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.async import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.flow.first import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest import net.peanuuutz.tomlkt.Toml @@ -83,22 +72,6 @@ class ProjectsListComponentTest : ComponentTest() { private var selectedProject: ProjectDef? = null - private var previewsParsed = 0 - - /** Counts parses so a test can tell one debounced parse from a burst of them. */ - private inner class CountingImporter(private val delegate: StoryImporter) : StoryImporter { - override val format = delegate.format - - override fun preview( - sourceName: String, - content: ByteArray, - options: ImportOptions, - ): ImportPreview { - previewsParsed++ - return delegate.preview(sourceName, content, options) - } - } - private val projectDefA = ProjectDef("Alpha", HPath("/projects/Alpha", "Alpha", false)) private val fixedNow = Instant.fromEpochSeconds(1_000_000) @@ -137,16 +110,11 @@ class ProjectsListComponentTest : ComponentTest() { single { metadataDatasource } single { statsReader } single { reauthUseCase } - factory { SyncAccountUseCase(get(), get(), get(), get()) } single { FakeFileSystem() } single { createTomlSerializer() } single { TestStrRes() } single { object : Clock { override fun now(): Instant = fixedNow } } - single { - StoryImporterRegistry( - listOf(CountingImporter(MarkdownStoryImporter()), CountingImporter(RtfStoryImporter())) - ) - } + single { StoryImporterRegistry(listOf(MarkdownStoryImporter(), RtfStoryImporter())) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { VersionCheckRepository(get()) } @@ -197,14 +165,14 @@ class ProjectsListComponentTest : ComponentTest() { fun `createProject success on a synced account creates locally and on the server then clears the dialog`() = runTest(mainTestDispatcher) { every { synchronizer.isServerSynchronized() } returns true - every { projectsRepository.createProject("Novel", any()) } returns CResult.success(projectDefA) + every { projectsRepository.createProject("Novel") } returns CResult.success(projectDefA) val comp = newComponent() comp.onProjectNameUpdate("Novel") comp.createProject("Novel") advanceUntilIdle() - verify { projectsRepository.createProject("Novel", any()) } + verify { projectsRepository.createProject("Novel") } verify { synchronizer.createProject("Novel") } assertEquals("", comp.state.value.createDialogProjectName) } @@ -213,7 +181,7 @@ class ProjectsListComponentTest : ComponentTest() { fun `createProject success on a non-synced account does not touch the synchronizer`() = runTest(mainTestDispatcher) { every { synchronizer.isServerSynchronized() } returns false - every { projectsRepository.createProject("Novel", any()) } returns CResult.success(projectDefA) + every { projectsRepository.createProject("Novel") } returns CResult.success(projectDefA) val comp = newComponent() comp.createProject("Novel") @@ -225,7 +193,7 @@ class ProjectsListComponentTest : ComponentTest() { @Test fun `createProject failure leaves the dialog open and does not reload or sync`() = runTest(mainTestDispatcher) { - every { projectsRepository.createProject("bad/name", any()) } returns + every { projectsRepository.createProject("bad/name") } returns CResult.failure(error = "invalid", displayMessage = "Bad name".toMsg()) val comp = newComponent() comp.onProjectNameUpdate("bad/name") @@ -259,7 +227,6 @@ class ProjectsListComponentTest : ComponentTest() { val comp = newComponent() comp.selectImportFile("The Wreck.md", "# Chapter One\n\nText\n\n# Chapter Two\n\nMore".encodeToByteArray()) - advanceUntilIdle() assertEquals("The Wreck", comp.state.value.importProjectName) assertTrue(comp.state.value.showImportDialog) @@ -276,66 +243,10 @@ class ProjectsListComponentTest : ComponentTest() { "alice.md", "# Alice in Wonderland\n\n## Chapter One\n\nText".encodeToByteArray(), ) - advanceUntilIdle() assertEquals("Alice in Wonderland", comp.state.value.importProjectName) } - // Auto keeps two H2 scenes; H1 collapses the document to one, so the preview shows which won. - private val twoLevelDoc = - "# Part One\n\n## Chapter A\n\nText\n\n## Chapter B\n\nMore".encodeToByteArray() - - @Test - fun `the dialog opens busy and clears when the parse lands`() = - runTest(mainTestDispatcher) { - val comp = newComponent() - - comp.selectImportFile("The Wreck.md", twoLevelDoc) - - // The picker has closed, so the dialog carries the wait rather than the projects list. - assertTrue(comp.state.value.showImportDialog, "Dialog opens before the parse finishes") - assertTrue(comp.state.value.isParsingImport, "It opens in the busy state") - assertTrue(comp.state.value.importPreview.isEmpty, "With nothing to show yet") - - advanceUntilIdle() - - assertFalse(comp.state.value.isParsingImport, "Busy clears once the preview lands") - assertFalse(comp.state.value.importPreview.isEmpty) - } - - @Test - fun `a burst of option changes costs one parse and settles on the last`() = - runTest(mainTestDispatcher) { - val comp = newComponent() - comp.selectImportFile("Draft.md", twoLevelDoc) - advanceUntilIdle() - assertEquals(2, comp.state.value.importPreview.totalScenes, "Auto splits on H2") - previewsParsed = 0 - - comp.updateImportOptions(ImportOptions(markdownSplitStrategy = MarkdownSplitStrategy.H2)) - comp.updateImportOptions(ImportOptions(markdownSplitStrategy = MarkdownSplitStrategy.Auto)) - comp.updateImportOptions(ImportOptions(markdownSplitStrategy = MarkdownSplitStrategy.H1)) - advanceUntilIdle() - - assertEquals(1, previewsParsed, "Superseded options must be dropped before they parse") - assertEquals(MarkdownSplitStrategy.H1, comp.state.value.importOptions.markdownSplitStrategy) - assertEquals(1, comp.state.value.importPreview.totalScenes, "H1 keeps it as one scene") - } - - @Test - fun `confirming an empty preview creates nothing`() = - runTest(mainTestDispatcher) { - val comp = newComponent() - comp.selectImportFile("Blank.md", " \n\n \n".encodeToByteArray()) - advanceUntilIdle() - assertTrue(comp.state.value.importPreview.isEmpty, "A blank document previews as nothing") - - comp.confirmImportDialog() - advanceUntilIdle() - - verify(exactly = 0) { projectsRepository.createProject(any(), any()) } - } - @Test fun `updateImportProjectName updates the import name`() = runTest(mainTestDispatcher) { val comp = newComponent() @@ -349,8 +260,6 @@ class ProjectsListComponentTest : ComponentTest() { fun `cancelImportDialog clears the import state`() = runTest(mainTestDispatcher) { val comp = newComponent() comp.selectImportFile("Draft.md", "# One\n\nText".encodeToByteArray()) - advanceUntilIdle() - assertTrue(comp.state.value.showImportDialog) comp.cancelImportDialog() @@ -363,7 +272,7 @@ class ProjectsListComponentTest : ComponentTest() { fun `confirmImportDialog leaves the dialog open and does not sync when project creation fails`() = runTest(mainTestDispatcher) { every { synchronizer.isServerSynchronized() } returns true - every { projectsRepository.createProject("Draft", any()) } returns + every { projectsRepository.createProject("Draft") } returns CResult.failure(error = "exists", displayMessage = "Project already exists".toMsg()) val comp = newComponent() comp.selectImportFile("Draft.md", "# One\n\nText\n\n# Two\n\nMore".encodeToByteArray()) @@ -391,21 +300,6 @@ class ProjectsListComponentTest : ComponentTest() { verify { synchronizer.deleteProject(SyncedProjectDefinition(projectDefA, ProjectId("server-id"))) } } - @Test - fun `deleteProject does not touch the filesystem on the calling thread`() = runTest(mainTestDispatcher) { - every { projectsRepository.deleteProject(projectDefA) } returns true - val comp = newComponent() - - comp.deleteProject(projectDefA) - - verify(exactly = 0) { projectsRepository.getProjectId(any()) } - verify(exactly = 0) { projectsRepository.deleteProject(any()) } - - advanceUntilIdle() - - verify { projectsRepository.deleteProject(projectDefA) } - } - @Test fun `deleteProject skips the server when the project has no id`() = runTest(mainTestDispatcher) { every { projectsRepository.getProjectId(projectDefA) } returns null @@ -423,29 +317,12 @@ class ProjectsListComponentTest : ComponentTest() { every { projectsRepository.getProjectId(projectDefA) } returns ProjectId("server-id") every { projectsRepository.deleteProject(projectDefA) } returns false val comp = newComponent() - val toast = async(start = CoroutineStart.UNDISPATCHED) { comp.toast.first() } comp.deleteProject(projectDefA) advanceUntilIdle() verify(exactly = 0) { synchronizer.deleteProject(any()) } verify(exactly = 0) { projectsRepository.getProjects(any()) } - assertEquals(ToastMessage.Resource(Res.string.projects_list_toast_delete_failed), toast.await()) - } - - @Test - fun `deleteProject shows a failure when the filesystem throws`() = runTest(mainTestDispatcher) { - every { projectsRepository.getProjectId(projectDefA) } returns ProjectId("server-id") - every { projectsRepository.deleteProject(projectDefA) } throws IOException("Access denied") - val comp = newComponent() - val toast = async(start = CoroutineStart.UNDISPATCHED) { comp.toast.first() } - - comp.deleteProject(projectDefA) - advanceUntilIdle() - - verify(exactly = 0) { synchronizer.deleteProject(any()) } - verify(exactly = 0) { projectsRepository.getProjects(any()) } - assertEquals(ToastMessage.Resource(Res.string.projects_list_toast_delete_failed), toast.await()) } // --- renameProject ------------------------------------------------------- @@ -589,27 +466,6 @@ class ProjectsListComponentTest : ComponentTest() { assertIs(comp.modalRouterState.value.child?.instance) } - @Test - fun `a project the server reports unchanged shows as complete in the sync dialog`() = - runTest(mainTestDispatcher) { - globalSettings = globalSettings.copy(autoCloseSyncDialog = false) - every { synchronizer.isServerSynchronized() } returns true - every { projectsRepository.getProjects(any()) } returns listOf(projectDefA) - every { metadataDatasource.loadMetadata(projectDefA) } returns - metadata(Instant.fromEpochSeconds(1), serverId = ProjectId("server-id")) - coEvery { synchronizer.syncProjects(any(), any(), any(), any()) } returns true - coEvery { synchronizer.probeUnchangedProjects(any()) } returns setOf(ProjectId("server-id")) - val comp = newComponent() - - comp.showProjectsSync() - advanceUntilIdle() - - val status = comp.state.value.syncState.projectsStatus.getValue("Alpha") - assertEquals(ProjectsList.Status.Complete, status.status) - assertEquals(1f, status.progress) - assertTrue(comp.state.value.syncState.syncComplete) - } - // --- loadProjectList ----------------------------------------------------- @Test diff --git a/common/src/desktopTest/kotlin/components/projectsync/ProjectSynchronizationComponentTest.kt b/common/src/desktopTest/kotlin/components/projectsync/ProjectSynchronizationComponentTest.kt index d06002e78..78d0bdd42 100644 --- a/common/src/desktopTest/kotlin/components/projectsync/ProjectSynchronizationComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/projectsync/ProjectSynchronizationComponentTest.kt @@ -68,7 +68,7 @@ class ProjectSynchronizationComponentTest : ComponentTest() { val onProgress: suspend (Float, SyncLogMessage?) -> Unit, val onLog: suspend (SyncLogMessage?) -> Unit, val onConflict: suspend (ApiProjectEntity) -> Unit, - val onComplete: suspend (Boolean) -> Unit, + val onComplete: suspend () -> Unit, val onUnauthorized: suspend () -> Unit, ) @@ -132,7 +132,7 @@ class ProjectSynchronizationComponentTest : ComponentTest() { fun `Successful sync reports progress and auto-closes the dialog`() = runTest(mainTestDispatcher) { stubSync { callbacks -> callbacks.onProgress(0.5f, null) - callbacks.onComplete(true) + callbacks.onComplete() true } @@ -158,7 +158,7 @@ class ProjectSynchronizationComponentTest : ComponentTest() { autoCloseSyncDialog = false, ) stubSync { callbacks -> - callbacks.onComplete(true) + callbacks.onComplete() true } @@ -196,7 +196,7 @@ class ProjectSynchronizationComponentTest : ComponentTest() { stubSync { callbacks -> callbacks.onProgress(0.25f, SyncLogMessage("first", SyncLogLevel.INFO, projectDef.name, Instant.DISTANT_PAST)) callbacks.onLog(SyncLogMessage("second", SyncLogLevel.WARN, projectDef.name, Instant.DISTANT_PAST)) - callbacks.onComplete(true) + callbacks.onComplete() true } every { globalSettingsStore.globalSettings } returns GlobalSettings( @@ -215,26 +215,6 @@ class ProjectSynchronizationComponentTest : ComponentTest() { assertTrue(messages.contains("second")) } - @Test - fun `Failed sync does not log Sync complete`() = runTest(mainTestDispatcher) { - stubSync { callbacks -> - callbacks.onLog(SyncLogMessage("Sync failed: boom", SyncLogLevel.ERROR, projectDef.name, Instant.DISTANT_PAST)) - callbacks.onComplete(false) - false - } - - val comp = newComponent() - context.resume() - - comp.syncProject { } - advanceUntilIdle() - - val messages = comp.state.value.syncLog.map { it.message } - assertTrue(messages.contains("Sync failed: boom")) - assertFalse(messages.contains("Sync complete!")) - assertFalse(comp.state.value.isSyncing) - } - @Test fun `Cancel sync stops syncing and logs a warning`() = runTest(mainTestDispatcher) { stubSync { callbacks -> diff --git a/common/src/desktopTest/kotlin/components/sceneeditor/scenemetadata/EntryAddSearchTest.kt b/common/src/desktopTest/kotlin/components/sceneeditor/scenemetadata/EntryAddSearchTest.kt index d8ff8c35b..d0404a44d 100644 --- a/common/src/desktopTest/kotlin/components/sceneeditor/scenemetadata/EntryAddSearchTest.kt +++ b/common/src/desktopTest/kotlin/components/sceneeditor/scenemetadata/EntryAddSearchTest.kt @@ -114,40 +114,6 @@ class EntryAddSearchTest { assertEquals(EntryType.THING, result.single().entryDef.type) } - @Test - fun `types restricts the result to the requested entry types`() { - val result = filterEntriesForAdd( - query = "a", - entries = entries, - confirmedIds = emptySet(), - dismissedIds = emptySet(), - maxResults = 20, - types = setOf(EntryType.PLACE), - ) - assertEquals(listOf("Atlantis"), result.map { it.entryDef.name }) - } - - @Test - fun `types narrows before maxResults truncates`() { - // The alphabetically-early people would fill the cap on their own; the - // requested type must still come back rather than being starved out. - val crowded = listOf( - entry(1, "Aaron"), - entry(2, "Abel"), - entry(3, "Abigail"), - entry(4, "Aventine", type = EntryType.PLACE), - ) - val result = filterEntriesForAdd( - query = "a", - entries = crowded, - confirmedIds = emptySet(), - dismissedIds = emptySet(), - maxResults = 2, - types = setOf(EntryType.PLACE), - ) - assertEquals(listOf("Aventine"), result.map { it.entryDef.name }) - } - @Test fun `maxResults caps the returned list`() { // 'b' matches Bob, Bobby, and Robert; the cap must keep the first two in sorted order. diff --git a/common/src/desktopTest/kotlin/components/storyeditor/StoryEditorComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/StoryEditorComponentTest.kt index 6f01c65f9..c9f4e7754 100644 --- a/common/src/desktopTest/kotlin/components/storyeditor/StoryEditorComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/storyeditor/StoryEditorComponentTest.kt @@ -3,7 +3,6 @@ package components.storyeditor import com.arkivanov.decompose.value.getValue import com.darkrockstudios.apps.hammer.common.components.storyeditor.StoryEditor import com.darkrockstudios.apps.hammer.common.components.storyeditor.StoryEditorComponent -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditorComponent import com.darkrockstudios.apps.hammer.common.data.MenuDescriptor import com.darkrockstudios.apps.hammer.common.data.SceneItem @@ -35,11 +34,8 @@ import org.junit.jupiter.api.Test import org.koin.core.qualifier.named import org.koin.dsl.module import utils.ComponentTest -import utils.TestComponentContext -import kotlin.test.assertEquals import kotlin.test.assertFalse import kotlin.test.assertIs -import kotlin.test.assertSame import kotlin.test.assertTrue @OptIn(ExperimentalCoroutinesApi::class) @@ -49,7 +45,6 @@ class StoryEditorComponentTest : ComponentTest() { private lateinit var settingsStore: GlobalSettingsStore private val sceneTreeCallbacks = mutableListOf<(SceneSummary) -> Unit>() - private lateinit var sceneUpdates: MutableSharedFlow private val addedMenus = mutableListOf() private var focusModeScene: SceneItem? = null @@ -67,8 +62,6 @@ class StoryEditorComponentTest : ComponentTest() { sceneEditor = mockk(relaxed = true) every { sceneEditor.subscribeToSceneUpdates(any(), capture(sceneTreeCallbacks)) } returns mockk(relaxed = true) - sceneUpdates = MutableSharedFlow(replay = 1) - every { sceneEditor.sceneListChannel } returns sceneUpdates val spellCheckRepository = mockk(relaxed = true) every { spellCheckRepository.dictionaryFlow } returns MutableSharedFlow() @@ -90,8 +83,8 @@ class StoryEditorComponentTest : ComponentTest() { }) } - private fun newComponent(componentContext: TestComponentContext = context) = StoryEditorComponent( - componentContext = componentContext, + private fun newComponent() = StoryEditorComponent( + componentContext = context, projectDef = projectDef, addMenu = { addedMenus.add(it) }, removeMenu = { }, @@ -287,163 +280,6 @@ class StoryEditorComponentTest : ComponentTest() { ) } - private fun StoryEditor.reader(): ReaderMode = - assertIs(detailsRouterState.value.active.instance) - .component - - private fun StoryEditor.sceneList() = - assertIs(listRouterState.value.active.instance).component - - @Test - fun `Showing the reader opens it in the detail and hides the list in single pane`() = - runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(null) - advanceUntilIdle() - - assertEquals(1, comp.reader().state.value.activeChapterId) - assertIs(comp.listRouterState.value.active.instance) - assertFalse(comp.isAtRoot()) - } - - @Test - fun `Showing the reader in multi pane keeps the list visible`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.setMultiPane(true) - comp.showReader(sceneItem(2)) - advanceUntilIdle() - - assertEquals(2, comp.reader().state.value.activeChapterId) - assertIs(comp.listRouterState.value.active.instance) - } - - @Test - fun `Tapping a scene in the list while reading moves the reader instead of opening the editor`() = - runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.setMultiPane(true) - comp.showReader(null) - advanceUntilIdle() - val reader = comp.reader() - - comp.sceneList().onSceneSelected(sceneItem(2)) - advanceUntilIdle() - - assertSame(reader, comp.reader()) - assertEquals(2, reader.state.value.activeChapterId) - assertEquals(2, reader.state.value.scrollToSceneId) - } - - @Test - fun `Showing a scene while reading opens the editor`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(null) - advanceUntilIdle() - comp.showScene(sceneItem(2)) - advanceUntilIdle() - - assertIs(comp.detailsRouterState.value.active.instance) - - comp.onBack() - advanceUntilIdle() - assertFalse(comp.isDetailShown()) - } - - @Test - fun `The reader's edit action opens the editor for the scene being read`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(sceneItem(2)) - advanceUntilIdle() - comp.reader().editScene() - advanceUntilIdle() - - val editor = - assertIs(comp.detailsRouterState.value.active.instance) - assertEquals(2, editor.component.state.value.sceneItem.id) - } - - @Test - fun `Back from the reader shows the list again in single pane`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(null) - advanceUntilIdle() - comp.onBack() - advanceUntilIdle() - - assertFalse(comp.isDetailShown()) - assertIs(comp.listRouterState.value.active.instance) - } - - @Test - fun `Tree updates do not close the reader`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(sceneItem(1)) - advanceUntilIdle() - - val updated = SceneSummary(treeOf(sceneItem(2)), persistentSetOf()) - sceneTreeCallbacks.toList().forEach { it(updated) } - sceneUpdates.emit(updated) - advanceUntilIdle() - - assertEquals(2, comp.reader().state.value.activeChapterId) - } - - @Test - fun `The reader survives process death`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns treeOf(sceneItem(1), sceneItem(2)) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReader(null) - advanceUntilIdle() - comp.reader().showChapter(2) - advanceUntilIdle() - - val restoredContext = context.saveAndRecreate() - val restored = newComponent(restoredContext) - restoredContext.resume() - advanceUntilIdle() - - assertEquals(2, restored.reader().state.value.activeChapterId) - } - @Test fun `Unsaved buffer queries delegate to the scene editor service`() = runTest(mainTestDispatcher) { every { sceneEditor.hasDirtyBuffers() } returns true diff --git a/common/src/desktopTest/kotlin/components/storyeditor/focusmode/FocusModeComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/focusmode/FocusModeComponentTest.kt index 03795080e..a9cc24c40 100644 --- a/common/src/desktopTest/kotlin/components/storyeditor/focusmode/FocusModeComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/storyeditor/focusmode/FocusModeComponentTest.kt @@ -10,10 +10,8 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository +import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import io.mockk.coEvery -import io.mockk.coVerify import io.mockk.every import io.mockk.mockk import io.mockk.slot @@ -36,7 +34,6 @@ class FocusModeComponentTest : ComponentTest() { private lateinit var settingsStore: GlobalSettingsStore private lateinit var focusModeService: FocusModeService private lateinit var sceneEditor: SceneEditorService - private lateinit var projectDictionary: ProjectDictionaryUseCase private lateinit var settingsUpdates: MutableSharedFlow private val bufferCallback = slot Unit>() @@ -73,14 +70,12 @@ class FocusModeComponentTest : ComponentTest() { sceneEditor.subscribeToBufferUpdates(any(), any(), capture(bufferCallback)) } returns mockk(relaxed = true) - val spellCheckRepository = mockk(relaxed = true) + val spellCheckRepository = mockk(relaxed = true) every { spellCheckRepository.dictionaryFlow } returns MutableSharedFlow() - projectDictionary = mockk(relaxed = true) setupComponentKoin(module { single { settingsStore } single { spellCheckRepository } - single { projectDictionary } single { focusModeService } scope { scoped { sceneEditor } @@ -118,18 +113,6 @@ class FocusModeComponentTest : ComponentTest() { verify(exactly = 1) { focusModeService.exitFocusMode() } } - @Test - fun `addWordToDictionary delegates to the project dictionary`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.addWordToDictionary("Kvothe") - advanceUntilIdle() - - coVerify(exactly = 1) { projectDictionary.addWord("Kvothe") } - } - @Test fun `Content edits are forwarded to the scene editor`() = runTest(mainTestDispatcher) { val comp = newComponent() @@ -182,43 +165,6 @@ class FocusModeComponentTest : ComponentTest() { assertEquals(42f, comp.state.value.textSize) } - @Test - fun `Editor width controls persist through settings`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.setEditorMaxWidth(900f) - advanceUntilIdle() - assertEquals(900f, settingsTransform.captured(GlobalSettings(projectsDirectory = "/p")).editorMaxWidth) - - comp.setEditorMaxWidth(5000f) - advanceUntilIdle() - assertEquals( - GlobalSettings.MAX_EDITOR_WIDTH, - settingsTransform.captured(GlobalSettings(projectsDirectory = "/p")).editorMaxWidth, - ) - - comp.resetEditorMaxWidth() - advanceUntilIdle() - assertEquals( - GlobalSettings.DEFAULT_EDITOR_WIDTH, - settingsTransform.captured(GlobalSettings(projectsDirectory = "/p")).editorMaxWidth, - ) - } - - @Test - fun `Settings updates change the editor width in state`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - settingsUpdates.emit(GlobalSettings(projectsDirectory = "/projects", editorMaxWidth = 1200f)) - advanceUntilIdle() - - assertEquals(1200f, comp.state.value.editorMaxWidth) - } - @Test fun `External buffer updates refresh state and force an editor update`() = runTest(mainTestDispatcher) { val comp = newComponent() diff --git a/common/src/desktopTest/kotlin/components/storyeditor/readermode/ReaderModeComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/readermode/ReaderModeComponentTest.kt deleted file mode 100644 index c3d3a4158..000000000 --- a/common/src/desktopTest/kotlin/components/storyeditor/readermode/ReaderModeComponentTest.kt +++ /dev/null @@ -1,476 +0,0 @@ -package components.storyeditor.readermode - -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderModeComponent -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.EDITOR_TEXT_SIZES -import com.darkrockstudios.apps.hammer.common.data.SceneBuffer -import com.darkrockstudios.apps.hammer.common.data.SceneContent -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.SceneSummary -import com.darkrockstudios.apps.hammer.common.data.UpdateSource -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree -import com.darkrockstudios.apps.hammer.common.data.tree.Tree -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import io.mockk.slot -import io.mockk.verify -import kotlinx.collections.immutable.persistentSetOf -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.test.advanceUntilIdle -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import utils.ComponentTest -import utils.TestComponentContext -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNull -import kotlin.test.assertTrue - -@OptIn(ExperimentalCoroutinesApi::class) -class ReaderModeComponentTest : ComponentTest() { - - private lateinit var sceneEditor: SceneEditorService - private lateinit var settingsStore: GlobalSettingsStore - private lateinit var settingsUpdates: MutableSharedFlow - - private lateinit var sceneUpdates: MutableSharedFlow - private val bufferCallback = slot Unit>() - private val settingsTransform = slot<(GlobalSettings) -> GlobalSettings>() - - private var closed = false - private var editedScene: SceneItem? = null - private val scenesInView = mutableListOf() - - private val chapterOne = item(10, SceneItem.Type.Group) - private val sceneA = item(11, SceneItem.Type.Scene) - private val sceneB = item(12, SceneItem.Type.Scene) - private val chapterTwo = item(20, SceneItem.Type.Group) - private val sceneC = item(21, SceneItem.Type.Scene) - private val loneScene = item(30, SceneItem.Type.Scene) - - private fun item(id: Int, type: SceneItem.Type, name: String = "Item $id") = - SceneItem(projectDef = projectDef, type = type, id = id, name = name, order = id) - - private fun tree(vararg chapters: Pair>): ImmutableTree { - val root = TreeNode(item(SceneItem.ROOT_ID, SceneItem.Type.Root)) - chapters.forEach { (chapter, scenes) -> - val node = TreeNode(chapter) - scenes.forEach { node.addChild(TreeNode(it)) } - root.addChild(node) - } - return Tree().apply { setRoot(root) }.toImmutableTree() - } - - private fun fullTree() = tree( - chapterOne to listOf(sceneA, sceneB), - chapterTwo to listOf(sceneC), - loneScene to emptyList(), - ) - - private fun summary(tree: ImmutableTree) = SceneSummary(tree, persistentSetOf()) - - @BeforeEach - override fun setup() { - super.setup() - - closed = false - editedScene = null - scenesInView.clear() - settingsUpdates = MutableSharedFlow(extraBufferCapacity = 4) - - settingsStore = mockk(relaxed = true) - every { settingsStore.globalSettings } returns GlobalSettings(projectsDirectory = "/projects") - every { settingsStore.globalSettingsUpdates } returns settingsUpdates - coEvery { settingsStore.updateSettings(capture(settingsTransform)) } returns Unit - - sceneEditor = mockk(relaxed = true) - every { sceneEditor.getSceneTree() } returns fullTree() - every { sceneEditor.getCurrentSceneContentOrNull(any()) } answers { "text of ${firstArg().id}" } - sceneUpdates = MutableSharedFlow(replay = 1) - every { sceneEditor.sceneListChannel } returns sceneUpdates - every { - sceneEditor.subscribeToBufferUpdates(any(), any(), capture(bufferCallback)) - } returns mockk(relaxed = true) - - setupComponentKoin(module { - single { settingsStore } - scope { - scoped { sceneEditor } - } - }) - } - - private fun newComponent( - initialScene: SceneItem? = null, - componentContext: TestComponentContext = context, - ) = ReaderModeComponent( - componentContext = componentContext, - projectDef = projectDef, - initialScene = initialScene, - closeReader = { closed = true }, - openSceneEditor = { editedScene = it }, - onSceneInView = { scenesInView.add(it) }, - ) - - private fun ReaderModeComponent.sceneIds() = state.value.scenes.map { it.sceneItem.id } - - @Test - fun `Opens on the first chapter with its scenes stitched in order`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - val state = comp.state.value - assertEquals(listOf(10, 20, 30), state.chapters.map { it.chapter.id }) - assertEquals(listOf(2, 1, 1), state.chapters.map { it.sceneCount }) - assertEquals(chapterOne.id, state.activeChapterId) - assertEquals(listOf("text of 11", "text of 12"), state.scenes.map { it.markdown }) - assertFalse(state.isLoading) - assertNull(state.scrollToSceneId) - } - - @Test - fun `Opens on the chapter holding the initial scene and asks to scroll to it`() = runTest(mainTestDispatcher) { - val comp = newComponent(initialScene = sceneC) - context.resume() - advanceUntilIdle() - - assertEquals(chapterTwo.id, comp.state.value.activeChapterId) - assertEquals(sceneC.id, comp.state.value.scrollToSceneId) - assertEquals(listOf(sceneC.id), comp.sceneIds()) - } - - @Test - fun `Next and previous stop at the ends of the book`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.previousChapter() - advanceUntilIdle() - assertEquals(chapterOne.id, comp.state.value.activeChapterId) - - comp.nextChapter() - comp.nextChapter() - comp.nextChapter() - advanceUntilIdle() - - assertEquals(loneScene.id, comp.state.value.activeChapterId) - assertEquals(listOf(loneScene.id), comp.sceneIds()) - } - - @Test - fun `showScene switches chapter and requests a scroll`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showScene(sceneC) - advanceUntilIdle() - - assertEquals(chapterTwo.id, comp.state.value.activeChapterId) - assertEquals(sceneC.id, comp.state.value.scrollToSceneId) - assertEquals(listOf("text of 21"), comp.state.value.scenes.map { it.markdown }) - } - - @Test - fun `Scene in view is not reported while a scroll is pending`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showScene(sceneB) - comp.sceneInView(sceneA) - - assertTrue(scenesInView.isEmpty()) - - comp.scrollHandled() - - assertEquals(listOf(sceneB), scenesInView) - assertEquals(sceneB, comp.state.value.sceneInView) - assertNull(comp.state.value.scrollToSceneId) - } - - @Test - fun `Scene in view is reported only when it changes`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.sceneInView(sceneA) - comp.sceneInView(sceneA) - comp.sceneInView(sceneB) - - assertEquals(listOf(sceneA, sceneB), scenesInView) - } - - @Test - fun `Showing a scene the reader does not know re-reports the scene in view`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.sceneInView(sceneA) - - comp.showScene(SceneItem(projectDef, SceneItem.Type.Scene, id = 99, name = "Unknown", order = 99)) - - assertEquals(listOf(sceneA, sceneA), scenesInView) - assertNull(comp.state.value.scrollToSceneId) - } - - @Test - fun `Opening the reader does not force a scene list reload`() = runTest(mainTestDispatcher) { - newComponent() - context.resume() - advanceUntilIdle() - - verify(exactly = 0) { sceneEditor.subscribeToSceneUpdates(any(), any()) } - } - - @Test - fun `Edit opens the scene in view, or the first scene when none is`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.editScene() - assertEquals(sceneA, editedScene) - - comp.sceneInView(sceneB) - comp.editScene() - assertEquals(sceneB, editedScene) - } - - @Test - fun `An update with an unchanged tree does not reload the chapter`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - sceneUpdates.emit(summary(fullTree())) - advanceUntilIdle() - - verify(exactly = 2) { sceneEditor.getCurrentSceneContentOrNull(any()) } - assertEquals(listOf(11, 12), comp.sceneIds()) - } - - @Test - fun `A scene added to the active chapter reloads it`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - val added = item(13, SceneItem.Type.Scene) - sceneUpdates.emit( - summary(tree(chapterOne to listOf(sceneA, sceneB, added), chapterTwo to listOf(sceneC))) - ) - advanceUntilIdle() - - assertEquals(listOf(11, 12, 13), comp.sceneIds()) - assertEquals(listOf(3, 1), comp.state.value.chapters.map { it.sceneCount }) - } - - @Test - fun `A rename refreshes names without reloading`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - val renamed = sceneA.copy(name = "Renamed") - sceneUpdates.emit( - summary(tree(chapterOne to listOf(renamed, sceneB), chapterTwo to listOf(sceneC), loneScene to emptyList())) - ) - advanceUntilIdle() - - assertEquals("Renamed", comp.state.value.scenes.first().sceneItem.name) - verify(exactly = 2) { sceneEditor.getCurrentSceneContentOrNull(any()) } - } - - @Test - fun `Removing the active chapter moves to its neighbour instead of closing`() = runTest(mainTestDispatcher) { - val comp = newComponent(initialScene = loneScene) - context.resume() - advanceUntilIdle() - - sceneUpdates.emit(summary(tree(chapterOne to listOf(sceneA, sceneB), chapterTwo to listOf(sceneC)))) - advanceUntilIdle() - - assertFalse(closed) - assertEquals(chapterTwo.id, comp.state.value.activeChapterId) - assertEquals(listOf(sceneC.id), comp.sceneIds()) - } - - @Test - fun `An emptied book shows no chapters and recovers when scenes return`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - sceneUpdates.emit(summary(tree())) - advanceUntilIdle() - - assertFalse(closed) - assertTrue(comp.state.value.chapters.isEmpty()) - assertNull(comp.state.value.activeChapterId) - assertFalse(comp.state.value.isLoading) - - sceneUpdates.emit(summary(fullTree())) - advanceUntilIdle() - - assertEquals(chapterOne.id, comp.state.value.activeChapterId) - assertEquals(listOf(11, 12), comp.sceneIds()) - } - - @Test - fun `A buffer update that arrives while the chapter loads is not lost`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - - bufferCallback.captured( - SceneBuffer(SceneContent(sceneB, markdown = "fresh words"), dirty = true, source = UpdateSource.Editor) - ) - advanceUntilIdle() - - assertEquals(listOf("text of 11", "fresh words"), comp.state.value.scenes.map { it.markdown }) - } - - @Test - fun `A buffer update replaces the text of a scene being read`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - bufferCallback.captured( - SceneBuffer(SceneContent(sceneB, markdown = "fresh words"), dirty = true, source = UpdateSource.Editor) - ) - advanceUntilIdle() - - assertEquals(listOf("text of 11", "fresh words"), comp.state.value.scenes.map { it.markdown }) - } - - @Test - fun `A buffer update for another chapter is ignored`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - val before = comp.state.value - - bufferCallback.captured( - SceneBuffer(SceneContent(sceneC, markdown = "elsewhere"), dirty = true, source = UpdateSource.Editor) - ) - advanceUntilIdle() - - assertEquals(before, comp.state.value) - } - - @Test - fun `A scene whose content cannot be read renders empty`() = runTest(mainTestDispatcher) { - every { sceneEditor.getCurrentSceneContentOrNull(sceneB) } returns null - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - assertEquals(listOf("text of 11", ""), comp.state.value.scenes.map { it.markdown }) - } - - @Test - fun `An empty group is a chapter with no scenes`() = runTest(mainTestDispatcher) { - every { sceneEditor.getSceneTree() } returns tree(chapterOne to emptyList()) - - val comp = newComponent() - context.resume() - advanceUntilIdle() - - assertEquals(chapterOne.id, comp.state.value.activeChapterId) - assertTrue(comp.state.value.scenes.isEmpty()) - assertFalse(comp.state.value.isLoading) - } - - @Test - fun `Font size changes are written to the reader setting and clamped`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - val settings = GlobalSettings(projectsDirectory = "/projects", editorFontSize = 20f) - - comp.increaseFontSize() - advanceUntilIdle() - val increased = settingsTransform.captured(settings) - assertEquals(18f, increased.readerFontSize) - assertEquals(20f, increased.editorFontSize) - - comp.decreaseFontSize() - advanceUntilIdle() - assertEquals(14f, settingsTransform.captured(settings).readerFontSize) - - comp.increaseFontSize() - advanceUntilIdle() - assertEquals( - EDITOR_TEXT_SIZES.last(), - settingsTransform.captured(settings.copy(readerFontSize = EDITOR_TEXT_SIZES.last())).readerFontSize, - ) - - comp.resetFontSize() - advanceUntilIdle() - assertEquals( - GlobalSettings.DEFAULT_FONT_SIZE, - settingsTransform.captured(settings.copy(readerFontSize = 30f)).readerFontSize, - ) - } - - @Test - fun `The scene headings toggle is persisted and mirrored from settings`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - val settings = GlobalSettings(projectsDirectory = "/projects") - - comp.toggleSceneHeadings() - advanceUntilIdle() - val toggled = settingsTransform.captured(settings) - assertTrue(toggled.readerShowSceneHeadings) - - settingsUpdates.emit(toggled.copy(readerFontSize = 22f)) - advanceUntilIdle() - - assertTrue(comp.state.value.showSceneHeadings) - assertEquals(22f, comp.state.value.fontSize) - } - - @Test - fun `The chapter and scene being read survive process death`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.showChapter(chapterTwo.id) - advanceUntilIdle() - comp.sceneInView(sceneC) - - val restoredContext = context.saveAndRecreate() - val restored = newComponent(initialScene = sceneA, componentContext = restoredContext) - restoredContext.resume() - advanceUntilIdle() - - assertEquals(chapterTwo.id, restored.state.value.activeChapterId) - assertEquals(sceneC.id, restored.state.value.scrollToSceneId) - } - - @Test - fun `Close invokes the close callback`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.close() - - assertTrue(closed) - } -} diff --git a/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/EditorTextSizeStepsTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/EditorTextSizeStepsTest.kt deleted file mode 100644 index 08dd702b1..000000000 --- a/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/EditorTextSizeStepsTest.kt +++ /dev/null @@ -1,30 +0,0 @@ -package components.storyeditor.sceneeditor - -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.EDITOR_TEXT_SIZES -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.decreaseEditorTextSize -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.increaseEditorTextSize -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -class EditorTextSizeStepsTest { - - @Test - fun `steps walk the ladder`() { - assertEquals(18f, increaseEditorTextSize(16f)) - assertEquals(14f, decreaseEditorTextSize(16f)) - } - - @Test - fun `a size off the ladder snaps to it`() { - assertEquals(18f, increaseEditorTextSize(17f)) - assertEquals(16f, decreaseEditorTextSize(17f)) - } - - @Test - fun `steps stop at the ends`() { - assertEquals(EDITOR_TEXT_SIZES.last(), increaseEditorTextSize(EDITOR_TEXT_SIZES.last())) - assertEquals(EDITOR_TEXT_SIZES.first(), decreaseEditorTextSize(EDITOR_TEXT_SIZES.first())) - assertEquals(EDITOR_TEXT_SIZES.last(), increaseEditorTextSize(99f)) - assertEquals(EDITOR_TEXT_SIZES.first(), decreaseEditorTextSize(1f)) - } -} diff --git a/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/SceneEditorComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/SceneEditorComponentTest.kt index 25f9194dc..c72a7aee1 100644 --- a/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/SceneEditorComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/storyeditor/sceneeditor/SceneEditorComponentTest.kt @@ -9,12 +9,10 @@ import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings import com.darkrockstudios.apps.hammer.common.data.references.AutoConfirmReferencesUseCase -import com.darkrockstudios.apps.hammer.common.data.references.ScrubInvalidReferencesUseCase import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree import com.darkrockstudios.apps.hammer.common.data.tree.TreeValue -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryUseCase -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository +import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker import io.mockk.* import kotlinx.collections.immutable.persistentListOf @@ -36,8 +34,7 @@ import kotlin.time.Instant @OptIn(ExperimentalCoroutinesApi::class) // These tests drive lifecycle by calling onCreate()/onStart()/onStop() directly rather than // context.resume(), which keeps the eagerly-constructed child SceneMetadataPanelComponent dormant -// so its lazy dependencies don't need registering. Its construction-time dependencies -// (SceneEditorService, ScrubInvalidReferencesUseCase) still must be registered. +// so its dependencies don't need registering. class SceneEditorComponentTest : ComponentTest() { private val sceneItem = SceneItem(projectDef, SceneItem.Type.Scene, id = 7, name = "Chapter One", order = 0) @@ -46,8 +43,7 @@ class SceneEditorComponentTest : ComponentTest() { private lateinit var sceneEditor: SceneEditorService private lateinit var draftsRepository: SceneDraftRepository private lateinit var autoConfirm: AutoConfirmReferencesUseCase - private lateinit var spellCheck: ProjectSpellCheckRepository - private lateinit var projectDictionary: ProjectDictionaryUseCase + private lateinit var spellCheck: SpellCheckRepository private lateinit var settingsUpdates: MutableSharedFlow private lateinit var dictionaryFlow: MutableSharedFlow @@ -59,7 +55,6 @@ class SceneEditorComponentTest : ComponentTest() { private var closeCount = 0 private var focusShownFor: SceneItem? = null - private var readerShownFor: SceneItem? = null private val addedMenus = mutableListOf() private val removedMenuIds = mutableListOf() @@ -101,21 +96,16 @@ class SceneEditorComponentTest : ComponentTest() { } returns mockk(relaxed = true) every { sceneEditor.subscribeToSceneUpdates(any(), capture(sceneTreeCallback)) } returns mockk(relaxed = true) - projectDictionary = mockk(relaxed = true) - setupComponentKoin(module { single { settingsStore } - single { spellCheck } - single { projectDictionary } + single { spellCheck } single { sceneEditor } bind SceneEditorService::class single { draftsRepository } bind SceneDraftRepository::class single { autoConfirm } bind AutoConfirmReferencesUseCase::class - single { mockk(relaxed = true) } }) closeCount = 0 focusShownFor = null - readerShownFor = null addedMenus.clear() removedMenuIds.clear() } @@ -128,7 +118,6 @@ class SceneEditorComponentTest : ComponentTest() { closeSceneEditor = { closeCount++ }, showDraftsList = {}, showFocusMode = { focusShownFor = it }, - showReader = { readerShownFor = it }, showEntry = {}, showGlobalSearchForTag = {}, ) @@ -158,17 +147,6 @@ class SceneEditorComponentTest : ComponentTest() { assertFalse(comp.state.value.metadataPanelVisible) } - @Test - fun `addWordToDictionary delegates to the project dictionary`() = runTest(mainTestDispatcher) { - val comp = newComponent() - comp.onCreate() - - comp.addWordToDictionary("Kvothe") - advanceUntilIdle() - - coVerify(exactly = 1) { projectDictionary.addWord("Kvothe") } - } - // --- scene name ---------------------------------------------------------- @Test @@ -327,7 +305,7 @@ class SceneEditorComponentTest : ComponentTest() { fun `saveDraft with an invalid name returns false without saving`() = runTest(mainTestDispatcher) { val comp = newComponent() - val result = comp.saveDraft("bad~name", "bad~name") + val result = comp.saveDraft("bad/name", "bad/name") assertFalse(result) coVerify(exactly = 0) { draftsRepository.saveDraft(any(), any()) } @@ -413,50 +391,6 @@ class SceneEditorComponentTest : ComponentTest() { assertTrue(expected > GlobalSettings.DEFAULT_FONT_SIZE) } - // --- editor width (settings writes) -------------------------------------- - - @Test - fun `initial state seeds editorMaxWidth from settings`() = runTest(mainTestDispatcher) { - globalSettings = settings().copy(editorMaxWidth = 900f) - - val comp = newComponent() - - assertEquals(900f, comp.state.value.editorMaxWidth) - } - - @Test - fun `setEditorMaxWidth persists the width`() = runTest(mainTestDispatcher) { - val comp = newComponent() - - comp.setEditorMaxWidth(900f) - advanceUntilIdle() - - assertEquals(900f, settingsAction.captured(globalSettings).editorMaxWidth) - } - - @Test - fun `setEditorMaxWidth clamps out-of-range widths`() = runTest(mainTestDispatcher) { - val comp = newComponent() - - comp.setEditorMaxWidth(5000f) - advanceUntilIdle() - assertEquals(GlobalSettings.MAX_EDITOR_WIDTH, settingsAction.captured(globalSettings).editorMaxWidth) - - comp.setEditorMaxWidth(100f) - advanceUntilIdle() - assertEquals(GlobalSettings.MIN_EDITOR_WIDTH, settingsAction.captured(globalSettings).editorMaxWidth) - } - - @Test - fun `resetEditorMaxWidth persists the default width`() = runTest(mainTestDispatcher) { - val comp = newComponent() - - comp.resetEditorMaxWidth() - advanceUntilIdle() - - assertEquals(GlobalSettings.DEFAULT_EDITOR_WIDTH, settingsAction.captured(globalSettings).editorMaxWidth) - } - // --- forwarding ---------------------------------------------------------- @Test @@ -467,14 +401,6 @@ class SceneEditorComponentTest : ComponentTest() { assertEquals(sceneItem, focusShownFor) } - @Test - fun `readScene forwards the scene to the parent`() = runTest(mainTestDispatcher) { - val comp = newComponent() - - comp.readScene() - assertEquals(sceneItem, readerShownFor) - } - @Test fun `closeEditor invokes the parent callback`() = runTest(mainTestDispatcher) { val comp = newComponent() @@ -540,7 +466,6 @@ class SceneEditorComponentTest : ComponentTest() { sceneTreeCallback.captured.invoke(SceneSummary(treeOf(renamed), persistentSetOf())) assertEquals("Renamed Externally", comp.state.value.sceneItem.name) - assertEquals("Renamed Externally", comp.sceneMetadataComponent.state.value.sceneItem.name) } @Test diff --git a/common/src/desktopTest/kotlin/components/storyeditor/scenelist/SceneListComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/scenelist/SceneListComponentTest.kt index 6d8871634..4f542a827 100644 --- a/common/src/desktopTest/kotlin/components/storyeditor/scenelist/SceneListComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/storyeditor/scenelist/SceneListComponentTest.kt @@ -37,18 +37,14 @@ class SceneListComponentTest : ComponentTest() { private val sceneListCallback = slot<(SceneSummary) -> Unit>() private val selectedScenes = mutableListOf() - private val openedScenes = mutableListOf() private var outlineShown = false - private var readerShown = false @BeforeEach override fun setup() { super.setup() selectedScenes.clear() - openedScenes.clear() outlineShown = false - readerShown = false selectedSceneFlow = MutableSharedFlow(replay = 1) sceneEditor = mockk(relaxed = true) @@ -72,9 +68,7 @@ class SceneListComponentTest : ComponentTest() { projectDef = projectDef, selectedSceneItem = selectedSceneFlow, sceneSelected = { selectedScenes.add(it) }, - openSceneEditor = { openedScenes.add(it) }, showOutlineOverviewDialog = { outlineShown = true }, - showReader = { readerShown = true }, ) private fun sceneItem(id: Int = 1, type: SceneItem.Type = SceneItem.Type.Scene) = SceneItem( @@ -121,7 +115,7 @@ class SceneListComponentTest : ComponentTest() { } @Test - fun `Creating a scene under the root passes a null parent and opens the new scene in the editor`() = + fun `Creating a scene under the root passes a null parent and selects the new scene`() = runTest(mainTestDispatcher) { val root = sceneItem(0, SceneItem.Type.Root) val created = sceneItem(9) @@ -135,12 +129,11 @@ class SceneListComponentTest : ComponentTest() { advanceUntilIdle() coVerify { sceneEditor.createScene(null, "New Scene") } - assertEquals(listOf(created), openedScenes) - assertTrue(selectedScenes.isEmpty()) + assertEquals(listOf(created), selectedScenes) } @Test - fun `Failed scene creation opens nothing`() = runTest(mainTestDispatcher) { + fun `Failed scene creation selects nothing`() = runTest(mainTestDispatcher) { coEvery { sceneEditor.createScene(any(), any()) } returns null val comp = newComponent() @@ -150,7 +143,7 @@ class SceneListComponentTest : ComponentTest() { comp.createScene(null, "Nope") advanceUntilIdle() - assertTrue(openedScenes.isEmpty()) + assertTrue(selectedScenes.isEmpty()) } @Test @@ -233,7 +226,7 @@ class SceneListComponentTest : ComponentTest() { } @Test - fun `Unarchiving opens the restored scene in the editor and closes the dialog`() = runTest(mainTestDispatcher) { + fun `Unarchiving selects the restored scene and closes the dialog`() = runTest(mainTestDispatcher) { val archived = sceneItem(8).copy(archived = true) val restored = archived.copy(archived = false) coEvery { sceneEditor.unarchiveScene(archived) } returns restored @@ -246,7 +239,7 @@ class SceneListComponentTest : ComponentTest() { comp.unarchiveScene(archived) advanceUntilIdle() - assertEquals(listOf(restored), openedScenes) + assertEquals(listOf(restored), selectedScenes) assertFalse(comp.state.value.showArchivedDialog) } @@ -263,7 +256,7 @@ class SceneListComponentTest : ComponentTest() { comp.unarchiveScene(archived) advanceUntilIdle() - assertTrue(openedScenes.isEmpty()) + assertTrue(selectedScenes.isEmpty()) assertTrue(comp.state.value.showArchivedDialog) } @@ -290,16 +283,6 @@ class SceneListComponentTest : ComponentTest() { assertTrue(outlineShown) } - @Test - fun `Reader mode request is forwarded`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showReaderMode() - assertTrue(readerShown) - } - @Test fun `Rename delegates to the repository`() = runTest(mainTestDispatcher) { val scene = sceneItem(1) diff --git a/common/src/desktopTest/kotlin/components/storyeditor/scenemetadata/SceneMetadataPanelComponentTest.kt b/common/src/desktopTest/kotlin/components/storyeditor/scenemetadata/SceneMetadataPanelComponentTest.kt deleted file mode 100644 index bebd83d05..000000000 --- a/common/src/desktopTest/kotlin/components/storyeditor/scenemetadata/SceneMetadataPanelComponentTest.kt +++ /dev/null @@ -1,248 +0,0 @@ -package components.storyeditor.scenemetadata - -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.scenemetadata.SceneMetadataPanelComponent -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.UpdateSource -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaService -import com.darkrockstudios.apps.hammer.common.data.references.ScrubInvalidReferencesUseCase -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMetadataUpdate -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.awaitCancellation -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.test.advanceUntilIdle -import kotlinx.coroutines.test.runTest -import okio.IOException -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.core.qualifier.named -import org.koin.dsl.module -import utils.ComponentTest -import kotlin.test.assertEquals - -@OptIn(ExperimentalCoroutinesApi::class) -class SceneMetadataPanelComponentTest : ComponentTest() { - - private lateinit var sceneEditor: SceneEditorService - private lateinit var metadataUpdateFlow: MutableSharedFlow - - private val sceneItem - get() = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 1, - name = "Scene 1", - order = 0, - ) - - @BeforeEach - override fun setup() { - super.setup() - - sceneEditor = mockk(relaxed = true) - metadataUpdateFlow = MutableSharedFlow(extraBufferCapacity = 8) - every { sceneEditor.metadataUpdateFlow } returns metadataUpdateFlow - every { sceneEditor.getSceneBuffer(any()) } returns null - every { sceneEditor.getSceneFilePathOrNull(any()) } returns null - coEvery { sceneEditor.loadSceneMetadata(any()) } returns SceneMetadata() - - val encyclopediaService = mockk(relaxed = true) - every { encyclopediaService.entryListFlow } returns MutableSharedFlow() - coEvery { encyclopediaService.ensureEntriesLoaded() } returns emptyList() - - setupComponentKoin(module { - single(named(APP_SCOPE)) { scope } - scope { - scoped { sceneEditor } - scoped { encyclopediaService } - scoped { ScrubInvalidReferencesUseCase(mockk(relaxed = true)) } - } - }) - } - - private fun newComponent() = SceneMetadataPanelComponent( - componentContext = context, - originalSceneItem = sceneItem, - showEntry = { }, - onShowGlobalSearchForTag = { }, - ) - - @Test - fun `A changed scene item updates the title`() = runTest(mainTestDispatcher) { - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.onSceneItemChanged(sceneItem.copy(name = "Renamed By Sync")) - advanceUntilIdle() - - assertEquals("Renamed By Sync", component.state.value.sceneItem.name) - } - - @Test - fun `A synced metadata write replaces the outline and notes`() = runTest(mainTestDispatcher) { - coEvery { sceneEditor.loadSceneMetadata(any()) } returns - SceneMetadata(outline = "old outline", notes = "old notes") - val component = newComponent() - context.resume() - advanceUntilIdle() - - metadataUpdateFlow.emit( - SceneMetadataUpdate( - sceneItem.id, - SceneMetadata(outline = "server outline", notes = "server notes"), - UpdateSource.Sync, - ) - ) - advanceUntilIdle() - - assertEquals("server outline", component.state.value.metadata.outline) - assertEquals("server notes", component.state.value.metadata.notes) - // Storage already holds the synced metadata, so the panel must not write it back. - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } - } - - @Test - fun `A synced metadata write keeps an unsaved outline edit`() = runTest(mainTestDispatcher) { - // The debounced store never completes, so the local edit stays unsaved. - coEvery { sceneEditor.storeMetadata(any(), any()) } coAnswers { awaitCancellation() } - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.updateOutline("my unsaved outline") - metadataUpdateFlow.emit( - SceneMetadataUpdate( - sceneItem.id, - SceneMetadata(outline = "server outline", tags = setOf("synced")), - UpdateSource.Sync, - ) - ) - advanceUntilIdle() - - assertEquals("my unsaved outline", component.state.value.metadata.outline) - assertEquals(setOf("synced"), component.state.value.metadata.tags) - } - - @Test - fun `A non-sync metadata write keeps the local outline`() = runTest(mainTestDispatcher) { - coEvery { sceneEditor.loadSceneMetadata(any()) } returns SceneMetadata(outline = "local outline") - val component = newComponent() - context.resume() - advanceUntilIdle() - - metadataUpdateFlow.emit( - SceneMetadataUpdate( - sceneItem.id, - SceneMetadata(outline = "stale outline", tags = setOf("auto")), - UpdateSource.Editor, - ) - ) - advanceUntilIdle() - - assertEquals("local outline", component.state.value.metadata.outline) - assertEquals(setOf("auto"), component.state.value.metadata.tags) - } - - @Test - fun `A failed store does not stop later stores`() = runTest(mainTestDispatcher) { - coEvery { sceneEditor.storeMetadata(any(), any()) } throws IOException("volume gone") - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.updateOutline("first") - advanceUntilIdle() - - coEvery { sceneEditor.storeMetadata(any(), any()) } returns Unit - component.updateOutline("second") - advanceUntilIdle() - - coVerify { sceneEditor.storeMetadata(match { it.outline == "second" }, sceneItem.id) } - } - - @Test - fun `Destroy flushes pending metadata edits`() = runTest(mainTestDispatcher) { - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.updateOutline("Final outline edit") - context.destroy() - advanceUntilIdle() - - coVerify { - sceneEditor.storeMetadata( - match { it.outline == "Final outline edit" }, - sceneItem.id, - ) - } - } - - @Test - fun `Destroy flush IO failure does not propagate`() = runTest(mainTestDispatcher) { - coEvery { sceneEditor.storeMetadata(any(), any()) } throws IOException("volume gone") - - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.updateOutline("Final outline edit") - context.destroy() - advanceUntilIdle() - - coVerify { - sceneEditor.storeMetadata(any(), sceneItem.id) - } - } - - @Test - fun `Destroy before the metadata load completes does not overwrite stored metadata`() = - runTest(mainTestDispatcher) { - coEvery { sceneEditor.loadSceneMetadata(any()) } coAnswers { awaitCancellation() } - - val component = newComponent() - context.resume() - advanceUntilIdle() - - context.destroy() - advanceUntilIdle() - - // State still holds the default empty SceneMetadata; flushing it would wipe the - // scene's real outline/notes/references on disk. - coVerify(exactly = 0) { - sceneEditor.storeMetadata(any(), any()) - } - } - - @Test - fun `Destroy after the project scope closed does not crash and still flushes metadata`() = - runTest(mainTestDispatcher) { - val component = newComponent() - context.resume() - advanceUntilIdle() - - component.updateOutline("Final outline edit") - - // Project close order on desktop: the Koin scope closes first, then Compose - // disposal destroys the components. - component.projectScope.scope.close() - context.destroy() - advanceUntilIdle() - - coVerify { - sceneEditor.storeMetadata( - match { it.outline == "Final outline edit" }, - sceneItem.id, - ) - } - } -} diff --git a/common/src/desktopTest/kotlin/components/storyideas/StoryIdeasComponentTest.kt b/common/src/desktopTest/kotlin/components/storyideas/StoryIdeasComponentTest.kt index dcd28cdcd..ed6cb4e69 100644 --- a/common/src/desktopTest/kotlin/components/storyideas/StoryIdeasComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/storyideas/StoryIdeasComponentTest.kt @@ -1,6 +1,5 @@ package components.storyideas -import com.darkrockstudios.apps.hammer.base.IdeaId import com.darkrockstudios.apps.hammer.common.components.projectselection.storyideas.StoryIdeas import com.darkrockstudios.apps.hammer.common.components.projectselection.storyideas.StoryIdeasComponent import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings @@ -17,8 +16,6 @@ import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSeri import io.mockk.every import io.mockk.mockk import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.async -import kotlinx.coroutines.test.UnconfinedTestDispatcher import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest import okio.fakefilesystem.FakeFileSystem @@ -27,9 +24,7 @@ import org.junit.jupiter.api.Test import org.koin.dsl.bind import org.koin.dsl.module import utils.ComponentTest -import utils.TestComponentContext import kotlin.test.assertEquals -import kotlin.test.assertFalse import kotlin.test.assertIs import kotlin.test.assertNull import kotlin.test.assertTrue @@ -64,21 +59,7 @@ class StoryIdeasComponentTest : ComponentTest() { }) } - private fun newComponent(componentContext: TestComponentContext = context) = - StoryIdeasComponent(componentContext = componentContext) - - /** Types a whole idea into the create editor and saves it. */ - private suspend fun StoryIdeas.writeIdea( - title: String? = null, - content: String, - tags: List = emptyList(), - ): StoryIdeas.SaveResult { - showCreate() - if (title != null) updateTitle(title) - updateContent(content) - updateTags(tags) - return saveDraft() - } + private fun newComponent() = StoryIdeasComponent(componentContext = context) @Test fun `Created ideas appear in component state`() = runTest(mainTestDispatcher) { @@ -86,13 +67,12 @@ class StoryIdeasComponentTest : ComponentTest() { context.resume() advanceUntilIdle() - val result = comp.writeIdea(title = "Tides", content = "A story about tides", tags = listOf("ocean")) + val error = comp.createIdea(title = "Tides", content = "A story about tides", tags = setOf("ocean")) advanceUntilIdle() - assertEquals(StoryIdeas.SaveResult.Created, result) + assertEquals(IdeaError.NONE, error) assertEquals(1, comp.state.value.ideas.size) assertEquals("Tides", comp.state.value.ideas.single().title) - assertNull(comp.state.value.editor, "Saving a new idea closes the editor") } @Test @@ -100,7 +80,7 @@ class StoryIdeasComponentTest : ComponentTest() { val comp = newComponent() context.resume() advanceUntilIdle() - comp.writeIdea(content = "edit me") + comp.createIdea(title = null, content = "edit me", tags = emptySet()) advanceUntilIdle() val idea = comp.state.value.ideas.single() @@ -111,8 +91,6 @@ class StoryIdeasComponentTest : ComponentTest() { val editor = comp.state.value.editor assertIs(editor) assertEquals(idea, editor.idea) - assertEquals("edit me", comp.state.value.draft?.content) - assertFalse(comp.state.value.draft!!.isEditing, "An existing idea opens read-only") comp.closeEditor() assertNull(comp.state.value.editor) @@ -123,189 +101,18 @@ class StoryIdeasComponentTest : ComponentTest() { val comp = newComponent() context.resume() advanceUntilIdle() - comp.writeIdea(content = "v1") + comp.createIdea(title = null, content = "v1", tags = emptySet()) advanceUntilIdle() val idea = comp.state.value.ideas.single() - comp.editIdea(idea.id) - comp.beginEdit() - comp.updateTitle("Now titled") - comp.updateContent("v2") - comp.updateTags(listOf("t")) - val result = comp.saveDraft() + val error = comp.saveIdea(idea.id, title = "Now titled", content = "v2", tags = setOf("t")) advanceUntilIdle() - assertEquals(StoryIdeas.SaveResult.Saved, result) + assertEquals(IdeaError.NONE, error) val updated = comp.state.value.ideas.single() assertEquals("v2", updated.content) assertEquals("Now titled", updated.title) assertEquals(setOf("t"), updated.tags) - // Back to read-only, showing what was stored rather than looking unsaved. - val draft = comp.state.value.draft!! - assertFalse(draft.isEditing) - assertFalse(draft.isDirty) - assertEquals("v2", draft.savedContent) - } - - @Test - fun `A save landing after the editor moved on leaves the new draft alone`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.writeIdea(content = "first") - comp.writeIdea(content = "second") - advanceUntilIdle() - - val first = comp.state.value.ideas.single { it.content == "first" } - val second = comp.state.value.ideas.single { it.content == "second" } - - comp.editIdea(first.id) - comp.beginEdit() - comp.updateContent("first, rewritten") - - // Unconfined so the save runs up to its first suspension, leaving the write in flight - // while the editor is switched underneath it. - val save = async(UnconfinedTestDispatcher(testScheduler)) { comp.saveDraft() } - assertFalse(save.isCompleted, "The write must still be in flight for this to test anything") - comp.editIdea(second.id) - advanceUntilIdle() - - assertEquals(StoryIdeas.SaveResult.Saved, save.await()) - assertEquals("first, rewritten", comp.state.value.ideas.single { it.id == first.id }.content) - - val draft = comp.state.value.draft!! - assertEquals("second", draft.content, "The open editor still shows the idea it was opened on") - assertEquals("second", draft.savedContent) - } - - @Test - fun `A tag typed but not committed is folded in on save`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showCreate() - comp.updateContent("half typed") - comp.updateTags(listOf("committed")) - comp.updateTagDraft("#pending") - comp.saveDraft() - advanceUntilIdle() - - assertEquals(setOf("committed", "pending"), comp.state.value.ideas.single().tags) - } - - @Test - fun `Discarding an edit restores the stored idea`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.writeIdea(title = "Keep", content = "original") - advanceUntilIdle() - - comp.editIdea(comp.state.value.ideas.single().id) - comp.beginEdit() - comp.updateContent("scribbled over") - assertTrue(comp.state.value.draft!!.isDirty) - - comp.discardEdit() - - val draft = comp.state.value.draft!! - assertFalse(draft.isEditing) - assertEquals("original", draft.content) - assertEquals("Keep", draft.title) - } - - @Test - fun `An unsaved draft survives process death`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.writeIdea(title = "Stored title", content = "stored body") - advanceUntilIdle() - val idea = comp.state.value.ideas.single() - - comp.editIdea(idea.id) - comp.beginEdit() - comp.updateTitle("Typed title") - comp.updateContent("typed body, never saved") - comp.updateTags(listOf("fresh")) - comp.updateTagDraft("half-typ") - - val restoredContext = context.saveAndRecreate() - val restored = newComponent(restoredContext) - restoredContext.resume() - advanceUntilIdle() - - val editor = restored.state.value.editor - assertIs(editor) - assertEquals(idea.id, editor.idea.id) - - val draft = restored.state.value.draft!! - assertTrue(draft.isEditing) - assertEquals("Typed title", draft.title) - assertEquals("typed body, never saved", draft.content) - assertEquals(listOf("fresh"), draft.tags) - assertEquals("half-typ", draft.tagDraft) - // The baseline came back too, so the editor still knows it has unsaved changes. - assertEquals("stored body", draft.savedContent) - assertTrue(draft.isDirty) - } - - @Test - fun `A restored draft can still be saved`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.writeIdea(content = "stored body") - advanceUntilIdle() - - comp.editIdea(comp.state.value.ideas.single().id) - comp.beginEdit() - comp.updateContent("typed body, never saved") - - val restoredContext = context.saveAndRecreate() - val restored = newComponent(restoredContext) - restoredContext.resume() - advanceUntilIdle() - - val result = restored.saveDraft() - advanceUntilIdle() - - assertEquals(StoryIdeas.SaveResult.Saved, result) - assertEquals("typed body, never saved", restored.state.value.ideas.single().content) - } - - @Test - fun `Nothing is stashed when no editor is open`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - comp.writeIdea(content = "just browsing") - advanceUntilIdle() - - val restoredContext = context.saveAndRecreate() - val restored = newComponent(restoredContext) - restoredContext.resume() - advanceUntilIdle() - - assertNull(restored.state.value.editor) - assertNull(restored.state.value.draft) - } - - @Test - fun `An empty idea is rejected`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.showCreate() - comp.updateTitle("Title only") - val result = comp.saveDraft() - advanceUntilIdle() - - assertEquals(StoryIdeas.SaveResult.Failed(IdeaError.EMPTY), result) - assertTrue(comp.state.value.ideas.isEmpty()) - assertIs(comp.state.value.editor, "A rejected idea keeps the editor open") } @Test @@ -313,7 +120,7 @@ class StoryIdeasComponentTest : ComponentTest() { val comp = newComponent() context.resume() advanceUntilIdle() - comp.writeIdea(content = "doomed") + comp.createIdea(title = null, content = "doomed", tags = emptySet()) advanceUntilIdle() val idea = comp.state.value.ideas.single() @@ -328,7 +135,7 @@ class StoryIdeasComponentTest : ComponentTest() { val comp = newComponent() context.resume() advanceUntilIdle() - comp.writeIdea(content = "keep") + comp.createIdea(title = null, content = "keep", tags = emptySet()) advanceUntilIdle() val idea = comp.state.value.ideas.single() @@ -343,23 +150,12 @@ class StoryIdeasComponentTest : ComponentTest() { val comp = newComponent() context.resume() advanceUntilIdle() - comp.writeIdea(content = "a", tags = listOf("gothic", "ghost")) - comp.writeIdea(content = "b", tags = listOf("gothic")) + comp.createIdea(title = null, content = "a", tags = setOf("gothic", "ghost")) + comp.createIdea(title = null, content = "b", tags = setOf("gothic")) advanceUntilIdle() assertEquals(listOf("gothic", "ghost"), comp.suggestTags("g")) assertEquals(listOf("gothic"), comp.suggestTags("go")) assertTrue(comp.suggestTags("x").isEmpty()) } - - @Test - fun `Editing an unknown idea does nothing`() = runTest(mainTestDispatcher) { - val comp = newComponent() - context.resume() - advanceUntilIdle() - - comp.editIdea(IdeaId.randomUUID()) - - assertNull(comp.state.value.editor) - } } diff --git a/common/src/desktopTest/kotlin/components/timeline/TimeLineComponentTest.kt b/common/src/desktopTest/kotlin/components/timeline/TimeLineComponentTest.kt index 701e2ee6a..8c708b0fa 100644 --- a/common/src/desktopTest/kotlin/components/timeline/TimeLineComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/timeline/TimeLineComponentTest.kt @@ -20,7 +20,6 @@ import org.koin.dsl.bind import org.koin.dsl.module import utils.ComponentTest import kotlin.test.assertEquals -import kotlin.test.assertIs class TimeLineComponentTest : ComponentTest() { @@ -48,7 +47,7 @@ class TimeLineComponentTest : ComponentTest() { every { tagIndexService.tagIndex } returns MutableStateFlow(mockk(relaxed = true)) every { tagIndexService.getRankedTags(any(), any()) } returns emptyList() - setupComponentKoin(module { + setupKoin(module { single { timelineRepo } bind TimeLineRepository::class single { tagIndexService } bind TagIndexService::class }) @@ -101,38 +100,4 @@ class TimeLineComponentTest : ComponentTest() { assertEquals(setOf(CloseConfirm.Timeline), component.shouldConfirmClose()) } - - @Test - fun `discardUnsaved reverts a dirty timeline event edit`() = runTest(mainTestDispatcher) { - val component = newComponent() - context.resume() - component.showViewEvent(event.id) - advanceUntilIdle() - - val viewEvent = viewEvent(component) - viewEvent.beginEdit() - viewEvent.onEventTextChanged("a different body") - advanceUntilIdle() - - component.discardUnsaved(CloseConfirm.Timeline) - advanceUntilIdle() - - assertEquals(emptySet(), component.shouldConfirmClose()) - assertEquals(event.content, viewEvent.contentText.value) - } - - @Test - fun `discardUnsaved pops an open create event screen`() = runTest(mainTestDispatcher) { - val component = newComponent() - context.resume() - component.showCreateEvent() - advanceUntilIdle() - assertEquals(setOf(CloseConfirm.Timeline), component.shouldConfirmClose()) - - component.discardUnsaved(CloseConfirm.Timeline) - advanceUntilIdle() - - assertIs(component.stack.value.active.instance) - assertEquals(emptySet(), component.shouldConfirmClose()) - } } diff --git a/common/src/desktopTest/kotlin/components/timeline/ViewTimeLineEventComponentTest.kt b/common/src/desktopTest/kotlin/components/timeline/ViewTimeLineEventComponentTest.kt index 674ebc4aa..2ea328230 100644 --- a/common/src/desktopTest/kotlin/components/timeline/ViewTimeLineEventComponentTest.kt +++ b/common/src/desktopTest/kotlin/components/timeline/ViewTimeLineEventComponentTest.kt @@ -65,84 +65,4 @@ class ViewTimeLineEventComponentTest : TimeLineTestBase() { assertFalse(component.state.value.isEditing, "storeEvent should exit edit mode") assertEquals(updatedEvent, component.state.value.event, "State should refresh to the stored event") } - - private fun newComponent(eventId: Int) = ViewTimeLineEventComponent( - componentContext = context, - projectDef = getProjectDef(PROJECT_EMPTY_NAME), - eventId = eventId, - onCloseEvent = {}, - addMenu = {}, - removeMenu = {}, - updateShouldClose = {}, - onShowGlobalSearchForTag = {}, - ) - - @Test - fun `An event changed elsewhere refreshes the open view`() = runTest { - val events = fakeEvents() - val component = newComponent(eventId = 0) - lifecycleCallbacks[1].onCreate() - advanceUntilIdle() - - timelineRepoCollectCallback.captured.emit(TimeLineContainer(events)) - advanceUntilIdle() - assertEquals("Event 0", component.contentText.value) - - val synced = events.first().copy(date = "server date", content = "server content") - timelineRepoCollectCallback.captured.emit(TimeLineContainer(listOf(synced) + events.drop(1))) - advanceUntilIdle() - - assertEquals(synced, component.state.value.event) - assertEquals("server content", component.contentText.value) - assertEquals("server date", component.dateText.value) - } - - @Test - fun `An event changed elsewhere replaces an untouched edit`() = runTest { - val events = fakeEvents() - // Event 1 has no date, which must not read as a dirty edit. - val component = newComponent(eventId = 1) - lifecycleCallbacks[1].onCreate() - advanceUntilIdle() - - timelineRepoCollectCallback.captured.emit(TimeLineContainer(events)) - advanceUntilIdle() - - component.beginEdit() - assertFalse(component.isEditingAndDirty()) - - val synced = events[1].copy(content = "server content") - timelineRepoCollectCallback.captured.emit( - TimeLineContainer(events.map { if (it.id == 1) synced else it }) - ) - advanceUntilIdle() - - assertTrue(component.state.value.isEditing) - assertEquals("server content", component.contentText.value) - assertFalse(component.isEditingAndDirty()) - } - - @Test - fun `An event changed elsewhere while editing keeps the draft`() = runTest { - val events = fakeEvents() - val component = newComponent(eventId = 0) - lifecycleCallbacks[1].onCreate() - advanceUntilIdle() - - timelineRepoCollectCallback.captured.emit(TimeLineContainer(events)) - advanceUntilIdle() - - component.beginEdit() - component.onEventTextChanged("my draft") - - val synced = events.first().copy(content = "server content") - timelineRepoCollectCallback.captured.emit(TimeLineContainer(listOf(synced) + events.drop(1))) - advanceUntilIdle() - - assertEquals(synced, component.state.value.event) - assertEquals("my draft", component.contentText.value) - - component.discardEdit() - assertEquals("server content", component.contentText.value) - } } \ No newline at end of file diff --git a/common/src/desktopTest/kotlin/data/ProjectEditorScopeUtilsTest.kt b/common/src/desktopTest/kotlin/data/ProjectEditorScopeUtilsTest.kt deleted file mode 100644 index 486433ec1..000000000 --- a/common/src/desktopTest/kotlin/data/ProjectEditorScopeUtilsTest.kt +++ /dev/null @@ -1,73 +0,0 @@ -package data - -import PROJECT_EMPTY_NAME -import com.darkrockstudios.apps.hammer.common.data.closeProjectScope -import com.darkrockstudios.apps.hammer.common.data.openProjectScope -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.temporaryProjectTask -import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryService -import getProjectDef -import io.mockk.mockk -import io.mockk.verify -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.core.component.getScopeId -import org.koin.dsl.module -import utils.BaseTest -import kotlin.test.assertNotNull -import kotlin.test.assertNull - -class ProjectEditorScopeUtilsTest : BaseTest() { - - private val projectDef = getProjectDef(PROJECT_EMPTY_NAME) - private lateinit var dictionaryService: ProjectDictionaryService - - @BeforeEach - override fun setup() { - super.setup() - dictionaryService = mockk(relaxed = true) - setupKoin(module { - scope { - scoped { projectDef } - scoped { mockk(relaxed = true) } - scoped { mockk(relaxed = true) } - scoped { dictionaryService } - } - }) - } - - private fun scopeOrNull() = getKoin().getScopeOrNull(ProjectDefScope(projectDef).getScopeId()) - - @Test - fun `a temporary task alone never starts the editor services and closes its scope`() = runTest { - temporaryProjectTask(projectDef) {} - - verify(exactly = 0) { dictionaryService.initialize() } - assertNull(scopeOrNull()) - } - - @Test - fun `opening for editing while a temporary task holds the scope starts the editor services and keeps the scope`() = - runTest { - temporaryProjectTask(projectDef) { - verify(exactly = 0) { dictionaryService.initialize() } - openProjectScope(projectDef) - verify(exactly = 1) { dictionaryService.initialize() } - } - - val scope = assertNotNull(scopeOrNull()) - closeProjectScope(scope, projectDef) - } - - @Test - fun `reopening for editing does not start the editor services twice`() = runTest { - openProjectScope(projectDef) - openProjectScope(projectDef) - - verify(exactly = 1) { dictionaryService.initialize() } - closeProjectScope(assertNotNull(scopeOrNull()), projectDef) - } -} diff --git a/common/src/desktopTest/kotlin/data/changelog/ChangelogParseTest.kt b/common/src/desktopTest/kotlin/data/changelog/ChangelogParseTest.kt deleted file mode 100644 index 0b4717e53..000000000 --- a/common/src/desktopTest/kotlin/data/changelog/ChangelogParseTest.kt +++ /dev/null @@ -1,50 +0,0 @@ -package data.changelog - -import com.darkrockstudios.apps.hammer.base.BuildMetadata -import com.darkrockstudios.apps.hammer.common.data.changelog.parseChangelog -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class ChangelogParseTest { - - @Test - fun `parses version date and notes from the header`() { - val changelog = parseChangelog( - """ - ## [3.7.2] - 2026-7-27 - - [Improve] - - Web: Redesign home page - """.trimIndent() - ) - - assertEquals("3.7.2", changelog?.version) - assertEquals("2026-7-27", changelog?.date) - assertEquals("[Improve]\n- Web: Redesign home page", changelog?.notes) - } - - @Test - fun `header without a date still parses`() { - val changelog = parseChangelog("## [3.7.2]\n\n- A thing") - - assertEquals("3.7.2", changelog?.version) - assertNull(changelog?.date) - assertEquals("- A thing", changelog?.notes) - } - - @Test - fun `text with no header falls back to the running version`() { - val changelog = parseChangelog("- Just some notes") - - assertEquals(BuildMetadata.APP_VERSION, changelog?.version) - assertNull(changelog?.date) - assertEquals("- Just some notes", changelog?.notes) - } - - @Test - fun `blank text is not a changelog`() { - assertNull(parseChangelog("")) - assertNull(parseChangelog(" \n \n")) - } -} diff --git a/common/src/desktopTest/kotlin/data/changelog/ChangelogRepositoryTest.kt b/common/src/desktopTest/kotlin/data/changelog/ChangelogRepositoryTest.kt deleted file mode 100644 index 2b87ebac6..000000000 --- a/common/src/desktopTest/kotlin/data/changelog/ChangelogRepositoryTest.kt +++ /dev/null @@ -1,112 +0,0 @@ -package data.changelog - -import com.darkrockstudios.apps.hammer.common.data.changelog.Changelog -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogDatasource -import com.darkrockstudios.apps.hammer.common.data.changelog.ChangelogRepository -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import io.mockk.Runs -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.every -import io.mockk.just -import io.mockk.mockk -import io.mockk.slot -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNull -import kotlin.test.assertTrue - -class ChangelogRepositoryTest : BaseTest() { - - private lateinit var datasource: ChangelogDatasource - private lateinit var settingsStore: GlobalSettingsStore - - private var settings = GlobalSettings( - projectsDirectory = "", - spellCheckSettings = SpellCheckerSettings(locale = mockk()), - ) - - private val changelog = Changelog(version = "3.7.2", date = "2026-7-27", notes = "- A thing") - - @BeforeEach - override fun setup() { - super.setup() - - datasource = mockk() - settingsStore = mockk(relaxed = true) - every { settingsStore.globalSettings } answers { settings } - } - - private fun repository() = ChangelogRepository(datasource, settingsStore) - - @Test - fun `Changelog is unseen when the stored version differs`() = runTest { - settings = settings.copy(lastSeenChangelogVersion = "3.6.0") - coEvery { datasource.loadChangelog() } returns changelog - - assertTrue(repository().hasUnseenChangelog()) - } - - @Test - fun `Changelog is unseen when nothing has been stored`() = runTest { - coEvery { datasource.loadChangelog() } returns changelog - - assertNull(settings.lastSeenChangelogVersion) - assertTrue(repository().hasUnseenChangelog()) - } - - @Test - fun `Changelog is seen when the stored version matches`() = runTest { - settings = settings.copy(lastSeenChangelogVersion = "3.7.2") - coEvery { datasource.loadChangelog() } returns changelog - - assertFalse(repository().hasUnseenChangelog()) - } - - @Test - fun `Missing resource never shows the dialog`() = runTest { - coEvery { datasource.loadChangelog() } returns null - - val repository = repository() - assertFalse(repository.hasUnseenChangelog()) - assertNull(repository.getChangelog()) - } - - @Test - fun `markSeen stores the changelog version`() = runTest { - coEvery { datasource.loadChangelog() } returns changelog - val captured = slot<(GlobalSettings) -> GlobalSettings>() - coEvery { settingsStore.updateSettings(capture(captured)) } just Runs - - repository().markSeen() - - assertEquals("3.7.2", captured.captured(settings).lastSeenChangelogVersion) - } - - @Test - fun `markSeen with no changelog writes nothing`() = runTest { - coEvery { datasource.loadChangelog() } returns null - - repository().markSeen() - - coVerify(exactly = 0) { settingsStore.updateSettings(any()) } - } - - @Test - fun `Resource is read once per session`() = runTest { - coEvery { datasource.loadChangelog() } returns changelog - - val repository = repository() - repository.getChangelog() - repository.getChangelog() - repository.hasUnseenChangelog() - - coVerify(exactly = 1) { datasource.loadChangelog() } - } -} diff --git a/common/src/desktopTest/kotlin/data/changelog/InAppChangelogSupportTest.kt b/common/src/desktopTest/kotlin/data/changelog/InAppChangelogSupportTest.kt deleted file mode 100644 index a1f9b17d4..000000000 --- a/common/src/desktopTest/kotlin/data/changelog/InAppChangelogSupportTest.kt +++ /dev/null @@ -1,17 +0,0 @@ -package data.changelog - -import com.darkrockstudios.apps.hammer.base.DistributionChannel -import com.darkrockstudios.apps.hammer.common.data.changelog.supportsInAppChangelog -import kotlin.test.Test -import kotlin.test.assertEquals - -class InAppChangelogSupportTest { - - @Test - fun `only the Mac App Store build hides the in-app changelog`() { - for (channel in DistributionChannel.entries) { - val expected = channel != DistributionChannel.MAC_APP_STORE - assertEquals(expected, supportsInAppChangelog(channel), "channel ${channel.token}") - } - } -} diff --git a/common/src/desktopTest/kotlin/data/pairing/PairingProtocolTest.kt b/common/src/desktopTest/kotlin/data/pairing/PairingProtocolTest.kt deleted file mode 100644 index d06fbe026..000000000 --- a/common/src/desktopTest/kotlin/data/pairing/PairingProtocolTest.kt +++ /dev/null @@ -1,69 +0,0 @@ -package data.pairing - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull -import kotlin.test.assertTrue - -class PairingProtocolTest { - - @Test - fun `a request survives the round trip`() { - val request = PairRequest(requestId = "req-1", installId = "watch-install", deviceLabel = "Pixel Watch") - - val decoded = PairingProtocol.decodeRequest(PairingProtocol.encodeRequest(request)) - - assertEquals(request, decoded) - } - - @Test - fun `a success response carries the settings through the round trip`() { - val response = PairResponse.Success( - requestId = "req-1", - settings = ServerSettings( - url = "hammer.ink", - email = "writer@example.com", - userId = 7, - bearerToken = "watch-auth", - refreshToken = "watch-refresh", - ), - ) - - val decoded = PairingProtocol.decodeResponse(PairingProtocol.encodeResponse(response)) - - assertEquals(response, decoded) - } - - @Test - fun `an error response survives the round trip`() { - val response = PairResponse.Error(requestId = "req-1", code = PairErrorCode.Declined) - - val decoded = PairingProtocol.decodeResponse(PairingProtocol.encodeResponse(response)) - - assertEquals(response, decoded) - } - - @Test - fun `the protocol version travels with the request`() { - val request = PairRequest(requestId = "req-1", installId = "watch-install", deviceLabel = "Pixel Watch") - - val encoded = PairingProtocol.encodeRequest(request).decodeToString() - - // Left off the wire, a future version decodes as this one and the compatibility check is dead. - assertTrue(encoded.contains("\"version\"")) - assertEquals(99, PairingProtocol.decodeRequest(PairingProtocol.encodeRequest(request.copy(version = 99)))?.version) - } - - @Test - fun `a malformed payload decodes to null rather than throwing`() { - val garbage = "not json".encodeToByteArray() - - assertNull(PairingProtocol.decodeRequest(garbage)) - assertNull(PairingProtocol.decodeResponse(garbage)) - } -} diff --git a/common/src/desktopTest/kotlin/data/search/LegacyMarkdownProjection.kt b/common/src/desktopTest/kotlin/data/search/LegacyMarkdownProjection.kt deleted file mode 100644 index 9c24555de..000000000 --- a/common/src/desktopTest/kotlin/data/search/LegacyMarkdownProjection.kt +++ /dev/null @@ -1,283 +0,0 @@ -// PR #821 implementation, kept verbatim in the test source set as a benchmark baseline. -package data.search - -private const val ASCII_PUNCTUATION = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~" - -/** - * Compared directly rather than via set or string membership: this runs once per character of every - * document scanned, and `in` on a CharSequence costs a call per character. - */ -private fun Char.isDelimiter(): Boolean = this == '*' || this == '_' || this == '`' - -private fun Char.isSpaceOrTab(): Boolean = this == ' ' || this == '\t' - -private fun Char?.isBlankOrEdge(): Boolean = this == null || isWhitespace() - -private fun Char?.isPunctuation(): Boolean = this != null && this in ASCII_PUNCTUATION - -/** - * A maximal run of one delimiter character, plus how much of it the projection consumes. Emphasis - * pairs off from the end of the opener and the start of the closer, so the surviving characters are - * always the middle of the run. - */ -private class DelimiterRun(val char: Char, val start: Int, val end: Int, val paragraph: Int) { - var canOpen = false - var canClose = false - - /** Set for runs sitting inside a resolved code span, where emphasis does not apply. */ - var inert = false - var dropFront = 0 - var dropBack = 0 - - val available: Int get() = end - start - dropFront - dropBack -} - -/** - * Flattens stored Markdown into the prose a reader sees. Backslash escapes resolve to their literal - * character (`well\-known` becomes `well-known`), paired emphasis and code delimiters are dropped - * (`**Chapter** One` becomes `Chapter One`), and leading blockquote, heading and bullet markers are - * removed from each line. - * - * Delimiters pair only within a paragraph, and only where CommonMark's flanking rules allow, so - * literal markers survive: `user_name`, `2 * 3`, a bare `***` divider and a stray apostrophe-backtick - * are all left intact. - * - * Link and image syntax is left as written. Punctuation is tested against ASCII only, and escapes - * resolve inside code spans as well as outside them. - */ -fun legacyProjectMarkdownToPlainText(markdown: String): String { - if (!legacyContainsMarkdownSyntax(markdown)) return markdown - - val runs = scanDelimiterRuns(markdown) - resolveCodeSpans(runs) - resolveEmphasis(runs) - return render(markdown, runs) -} - -/** - * The prose title for [markdown]: the first non-blank line of its projection. Falls back to the raw - * first line when the projection of it is blank, so a marker-only line still yields a title rather - * than reading as an empty document. - */ -fun legacyMarkdownTitleLine(markdown: String): String { - val projected = legacyProjectMarkdownToPlainText(markdown) - val title = projected.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() - if (title.isNotEmpty()) return title - return markdown.lineSequence().firstOrNull { it.isNotBlank() }?.trim().orEmpty() -} - -/** - * True when [text] holds a character the projection can remove. A query without one that misses the - * projection cannot match the raw source either, because the projection only ever deletes. - */ -fun legacyContainsMarkdownSyntax(text: String): Boolean { - var i = 0 - while (i < text.length) { - val c = text[i] - if (c.isDelimiter() || c == '\\' || c == '#' || c == '>' || c == '-' || c == '+') return true - i++ - } - return false -} - -/** - * The offset after any blockquote, heading or bullet marker opening the line at [start], or [start] - * itself when the line opens with prose. Ordered-list markers are left alone: a single line cannot - * distinguish "1. Draft opening" from "1984. The year everything changed". - */ -private fun skipBlockPrefix(markdown: String, start: Int): Int { - val length = markdown.length - var i = start - var found = false - - while (i < length && markdown[i].isSpaceOrTab()) i++ - - while (i < length && markdown[i] == '>') { - i++ - found = true - while (i < length && markdown[i].isSpaceOrTab()) i++ - } - - if (i < length && markdown[i] == '#') { - var j = i - var hashes = 0 - while (j < length && markdown[j] == '#') { - j++ - hashes++ - } - if (hashes <= 6 && j < length && markdown[j].isSpaceOrTab()) { - i = j - found = true - } - } else if (i < length && (markdown[i] == '-' || markdown[i] == '*' || markdown[i] == '+')) { - if (i + 1 < length && markdown[i + 1].isSpaceOrTab()) { - i++ - found = true - } - } - - if (!found) return start - while (i < length && markdown[i].isSpaceOrTab()) i++ - return i -} - -/** Appends the character at [i], resolving a backslash escape, and returns the next index. */ -private fun StringBuilder.appendResolved(markdown: String, i: Int): Int { - val c = markdown[i] - if (c == '\\' && i + 1 < markdown.length && markdown[i + 1] in ASCII_PUNCTUATION) { - append(markdown[i + 1]) - return i + 2 - } - append(c) - return i + 1 -} - -private fun scanDelimiterRuns(markdown: String): List { - val runs = mutableListOf() - val length = markdown.length - var i = 0 - var paragraph = 0 - while (i < length) { - val c = markdown[i] - if (c == '\\' && i + 1 < length && markdown[i + 1] in ASCII_PUNCTUATION) { - i += 2 - continue - } - if (c == '\n') { - var k = i + 1 - while (k < length && (markdown[k].isSpaceOrTab() || markdown[k] == '\r')) k++ - if (k >= length || markdown[k] == '\n') paragraph++ - i++ - continue - } - if (!c.isDelimiter()) { - i++ - continue - } - - val start = i - var end = start + 1 - while (end < length && markdown[end] == c) end++ - i = end - - var canOpen = true - var canClose = true - if (c != '`') { - val prev = markdown.getOrNull(start - 1) - val next = markdown.getOrNull(end) - val leftFlanking = !next.isBlankOrEdge() && - (!next.isPunctuation() || prev.isBlankOrEdge() || prev.isPunctuation()) - val rightFlanking = !prev.isBlankOrEdge() && - (!prev.isPunctuation() || next.isBlankOrEdge() || next.isPunctuation()) - if (c == '*') { - canOpen = leftFlanking - canClose = rightFlanking - } else { - // Underscores cannot delimit emphasis inside a word, which is what saves `user_name`. - canOpen = leftFlanking && (!rightFlanking || prev.isPunctuation()) - canClose = rightFlanking && (!leftFlanking || next.isPunctuation()) - } - // A run that can do neither is literal text; leaving it out keeps it out of the render. - if (!canOpen && !canClose) continue - } - - val run = DelimiterRun(c, start, end, paragraph) - run.canOpen = canOpen - run.canClose = canClose - runs.add(run) - } - return runs -} - -/** Code spans bind tighter than emphasis, so they claim their delimiters first. */ -private fun resolveCodeSpans(runs: List) { - var i = 0 - while (i < runs.size) { - val opener = runs[i] - if (opener.char != '`') { - i++ - continue - } - - val width = opener.end - opener.start - var j = i + 1 - var closer = -1 - while (j < runs.size && runs[j].paragraph == opener.paragraph) { - val candidate = runs[j] - if (candidate.char == '`' && candidate.end - candidate.start == width) { - closer = j - break - } - j++ - } - if (closer < 0) { - i++ - continue - } - - opener.dropBack = width - runs[closer].dropFront = width - for (k in i + 1 until closer) runs[k].inert = true - i = closer + 1 - } -} - -private fun resolveEmphasis(runs: List) { - val open = mutableListOf() - var paragraph = -1 - for (run in runs) { - if (run.paragraph != paragraph) { - open.clear() - paragraph = run.paragraph - } - if (run.char == '`' || run.inert) continue - - if (run.canClose) { - while (run.available > 0) { - val openerIndex = open.indexOfLast { it.char == run.char } - if (openerIndex < 0) break - - val opener = open[openerIndex] - val consumed = minOf(run.available, opener.available) - opener.dropBack += consumed - run.dropFront += consumed - - // Anything stacked above the matched opener can never close now. - while (open.size > openerIndex) open.removeAt(open.size - 1) - if (opener.available > 0) open.add(opener) - } - } - if (run.available > 0 && run.canOpen) open.add(run) - } -} - -private fun render(markdown: String, runs: List): String { - val sb = StringBuilder(markdown.length) - val length = markdown.length - var i = 0 - var r = 0 - var atLineStart = true - while (i < length) { - if (atLineStart) { - atLineStart = false - val afterPrefix = skipBlockPrefix(markdown, i) - if (afterPrefix > i) { - i = afterPrefix - while (r < runs.size && runs[r].start < i) r++ - continue - } - } - - if (r < runs.size && i == runs[r].start) { - val run = runs[r] - sb.append(markdown, run.start + run.dropFront, run.end - run.dropBack) - i = run.end - r++ - continue - } - - if (markdown[i] == '\n') atLineStart = true - i = sb.appendResolved(markdown, i) - } - return sb.toString() -} diff --git a/common/src/desktopTest/kotlin/data/search/ProjectorBenchmark.kt b/common/src/desktopTest/kotlin/data/search/ProjectorBenchmark.kt deleted file mode 100644 index 09c20ae8e..000000000 --- a/common/src/desktopTest/kotlin/data/search/ProjectorBenchmark.kt +++ /dev/null @@ -1,111 +0,0 @@ -package data.search - -import com.darkrockstudios.apps.hammer.common.data.search.MarkdownProjector -import com.darkrockstudios.apps.hammer.common.data.search.projectMarkdownToPlainText -import com.sun.management.ThreadMXBean -import java.lang.management.ManagementFactory -import kotlin.system.measureTimeMillis -import kotlin.test.Test -import kotlin.test.assertEquals - -/** Cost of a full-project scan: PR #821's implementation against the reusable workspace. */ -class ProjectorBenchmark { - - private val threads = ManagementFactory.getThreadMXBean() as ThreadMXBean - - private inline fun measureAlloc(block: () -> Unit): Long { - val before = threads.getCurrentThreadAllocatedBytes() - block() - return threads.getCurrentThreadAllocatedBytes() - before - } - - @Test - fun `the rewrite agrees with the implementation it replaces`() { - val corpus = buildCorpus(20_000) - val projector = MarkdownProjector() - corpus.forEach { scene -> - projector.project(scene) - assertEquals(legacyProjectMarkdownToPlainText(scene), projector.projected()) - } - } - - @Test - fun `full-project scan, legacy versus reusable workspace`() { - for (words in listOf(300_000, 1_250_000)) { - val corpus = buildCorpus(words) - val query = "gulls argue" - val projector = MarkdownProjector() - - repeat(3) { - corpus.forEach { legacyProjectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - corpus.forEach { projectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - corpus.forEach { projector.project(it); projector.indexOf(query) } - } - - val legacyTime = (0 until 3).minOf { - measureTimeMillis { - corpus.forEach { legacyProjectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - } - } - val wrapperTime = (0 until 3).minOf { - measureTimeMillis { - corpus.forEach { projectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - } - } - val reusedTime = (0 until 3).minOf { - measureTimeMillis { - corpus.forEach { projector.project(it); projector.indexOf(query) } - } - } - - val legacyAlloc = measureAlloc { - corpus.forEach { legacyProjectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - } - val wrapperAlloc = measureAlloc { - corpus.forEach { projectMarkdownToPlainText(it).indexOf(query, ignoreCase = true) } - } - val reusedAlloc = measureAlloc { - corpus.forEach { projector.project(it); projector.indexOf(query) } - } - - println("=== ${words / 1000}k words, ${corpus.size} scenes ===") - println(" legacy (#821) : ${legacyTime}ms, ${legacyAlloc.mb()}") - println(" new, workspace/call: ${wrapperTime}ms, ${wrapperAlloc.mb()}") - println(" new, reused : ${reusedTime}ms, ${reusedAlloc.mb()}") - } - } - - private fun Long.mb(): String = - "${(this / 1024.0 / 1024.0).let { kotlin.math.round(it * 100) / 100 }} MB" - - private fun buildCorpus(totalWords: Int): List { - val wordsPerScene = 2_000 - val scenes = totalWords / wordsPerScene - val words = ("the quick brown fox jumps over a lazy dog while morning light spills across " + - "the harbour and gulls argue about nothing at all she thought of him again").split(" ") - return (0 until scenes).map { s -> - val sb = StringBuilder() - sb.append("# Scene $s\n\n") - var w = 0 - while (w < wordsPerScene) { - val paragraph = StringBuilder() - repeat(120) { - val word = words[(w * 7 + it * 13 + s) % words.size] - if ((w + it) % 5 == 0) { - when ((w + it) % 15) { - 0 -> paragraph.append("**").append(word).append("**") - 5 -> paragraph.append("*").append(word).append("*") - else -> paragraph.append("well\\-known") - } - } else { - paragraph.append(word) - } - paragraph.append(' ') - } - w += 120 - sb.append(paragraph.trimEnd()).append(".\n\n") - } - sb.toString() - } - } -} diff --git a/common/src/desktopTest/kotlin/data/search/ScanLoadPathBenchmark.kt b/common/src/desktopTest/kotlin/data/search/ScanLoadPathBenchmark.kt deleted file mode 100644 index a1e7280a8..000000000 --- a/common/src/desktopTest/kotlin/data/search/ScanLoadPathBenchmark.kt +++ /dev/null @@ -1,128 +0,0 @@ -package data.search - -import com.darkrockstudios.apps.hammer.common.data.search.MarkdownProjector -import com.darkrockstudios.apps.hammer.common.util.readUtf8Into -import com.sun.management.ThreadMXBean -import okio.FileSystem -import okio.Path.Companion.toOkioPath -import java.lang.management.ManagementFactory -import kotlin.io.path.createTempDirectory -import kotlin.system.measureTimeMillis -import kotlin.test.Test -import kotlin.test.assertEquals - -/** End-to-end scan cost from disk: a string per scene against decoding into the scan buffer. */ -class ScanLoadPathBenchmark { - - private val threads = ManagementFactory.getThreadMXBean() as ThreadMXBean - - private inline fun measureAlloc(block: () -> Unit): Long { - val before = threads.getCurrentThreadAllocatedBytes() - block() - return threads.getCurrentThreadAllocatedBytes() - before - } - - @Test - fun `both load paths read the same text`() { - val dir = createTempDirectory("scan-load-agree") - val fs = FileSystem.SYSTEM - val document = "The **big** dog barked at the well\\-known café 😀 日本語" - val path = dir.resolve("scene.md").toOkioPath() - fs.write(path) { writeUtf8(document) } - - val viaString = fs.read(path) { readUtf8() } - assertEquals(document, viaString) - - val projector = MarkdownProjector() - val byteCount = fs.metadata(path).size!!.toInt() - val chars = fs.read(path) { readUtf8Into(projector, byteCount) } - projector.projectSource(chars) - - val expected = MarkdownProjector().also { it.project(document) }.projected() - assertEquals(expected, projector.projected()) - - fs.deleteRecursively(dir.toOkioPath()) - } - - @Test - fun `full-project scan from disk`() { - val dir = createTempDirectory("scan-load-bench") - val fs = FileSystem.SYSTEM - val corpus = buildCorpus(300_000) - val paths = corpus.mapIndexed { i, text -> - val p = dir.resolve("scene-$i.md").toOkioPath() - fs.write(p) { writeUtf8(text) } - p - } - val query = "gulls argue" - val projector = MarkdownProjector() - - fun stringPerScene(): Int { - var hits = 0 - paths.forEach { p -> - val text = fs.read(p) { readUtf8() } - if (legacyProjectMarkdownToPlainText(text).indexOf(query, ignoreCase = true) >= 0) hits++ - } - return hits - } - - fun intoScanBuffer(): Int { - var hits = 0 - paths.forEach { p -> - val byteCount = (fs.metadata(p).size ?: 0L).toInt() - val chars = fs.read(p) { readUtf8Into(projector, byteCount) } - projector.projectSource(chars) - if (projector.indexOf(query) >= 0) hits++ - } - return hits - } - - repeat(3) { stringPerScene(); intoScanBuffer() } - assertEquals(stringPerScene(), intoScanBuffer()) - - val oldTime = (0 until 3).minOf { measureTimeMillis { stringPerScene() } } - val newTime = (0 until 3).minOf { measureTimeMillis { intoScanBuffer() } } - val oldAlloc = measureAlloc { stringPerScene() } - val newAlloc = measureAlloc { intoScanBuffer() } - - println("=== 300k words, ${paths.size} scenes, read from disk ===") - println(" string per scene : ${oldTime}ms, ${oldAlloc.mb()}") - println(" into scan buffer : ${newTime}ms, ${newAlloc.mb()}") - - fs.deleteRecursively(dir.toOkioPath()) - } - - private fun Long.mb(): String = - "${(this / 1024.0 / 1024.0).let { kotlin.math.round(it * 100) / 100 }} MB" - - private fun buildCorpus(totalWords: Int): List { - val wordsPerScene = 2_000 - val scenes = totalWords / wordsPerScene - val words = ("the quick brown fox jumps over a lazy dog while morning light spills across " + - "the harbour and gulls argue about nothing at all she thought of him again").split(" ") - return (0 until scenes).map { s -> - val sb = StringBuilder() - sb.append("# Scene $s\n\n") - var w = 0 - while (w < wordsPerScene) { - val paragraph = StringBuilder() - repeat(120) { - val word = words[(w * 7 + it * 13 + s) % words.size] - if ((w + it) % 5 == 0) { - when ((w + it) % 15) { - 0 -> paragraph.append("**").append(word).append("**") - 5 -> paragraph.append("*").append(word).append("*") - else -> paragraph.append("well\\-known") - } - } else { - paragraph.append(word) - } - paragraph.append(' ') - } - w += 120 - sb.append(paragraph.trimEnd()).append(".\n\n") - } - sb.toString() - } - } -} diff --git a/common/src/desktopTest/kotlin/data/search/SearchQueryTest.kt b/common/src/desktopTest/kotlin/data/search/SearchQueryTest.kt index 4430bbd58..5562973ff 100644 --- a/common/src/desktopTest/kotlin/data/search/SearchQueryTest.kt +++ b/common/src/desktopTest/kotlin/data/search/SearchQueryTest.kt @@ -34,49 +34,6 @@ class SearchQueryTest { assertEquals("alice in wonderland", parsed.text) } - /** Text entered on iOS/macOS can arrive decomposed: base letter plus a combining mark. */ - @Test - fun `parseQuery composes decomposed accents in tags`() { - val parsed = parseQuery("#the\u0300me") - - assertEquals(listOf("th\u00e8me"), parsed.tags) - assertTrue(setOf("th\u00e8me").matchesAllTags(parsed.tags)) - } - - @Test - fun `parseQuery starts a tag on a fullwidth hash`() { - val parsed = parseQuery("\uff03\u4eba\u7269") - - assertEquals(listOf("\u4eba\u7269"), parsed.tags) - assertEquals("", parsed.text) - } - - @Test - fun `parseQuery drops duplicate tags`() { - assertEquals(listOf("epic"), parseQuery("##epic #epic").tags) - assertEquals(listOf("th\u00e8me"), parseQuery("#th\u00e8me #the\u0300me").tags) - } - - /** A hash mid-word is part of the word: `C#` is a search term, not an empty tag. */ - @Test - fun `parseQuery keeps a hash inside a word as free text`() { - val ascii = parseQuery("C#") - assertTrue(ascii.tags.isEmpty()) - assertEquals("C#", ascii.text) - - val fullwidth = parseQuery("\uff23\uff03") - assertTrue(fullwidth.tags.isEmpty()) - assertEquals("\uff23\uff03", fullwidth.text) - } - - @Test - fun `parseQuery splits a comma-joined tag run the way tag input does`() { - val parsed = parseQuery("#\u4eba\u7269\u3001\u9b54\u6cd5") - - assertEquals(listOf("\u4eba\u7269", "\u9b54\u6cd5"), parsed.tags) - assertEquals("", parsed.text) - } - @Test fun `isUsable requires a tag or two text chars`() { assertFalse(parseQuery("a").isUsable()) diff --git a/common/src/desktopTest/kotlin/data/versioncheck/ShouldNotifyOfUpdateUseCaseTest.kt b/common/src/desktopTest/kotlin/data/versioncheck/ShouldNotifyOfUpdateUseCaseTest.kt new file mode 100644 index 000000000..e2902f5cb --- /dev/null +++ b/common/src/desktopTest/kotlin/data/versioncheck/ShouldNotifyOfUpdateUseCaseTest.kt @@ -0,0 +1,71 @@ +package data.versioncheck + +import com.darkrockstudios.apps.hammer.common.data.versioncheck.GithubReleaseInfo +import com.darkrockstudios.apps.hammer.common.data.versioncheck.ShouldNotifyOfUpdateUseCase +import com.darkrockstudios.apps.hammer.common.data.versioncheck.VersionCheckRepository +import org.junit.jupiter.api.Test +import kotlin.test.assertFalse +import kotlin.test.assertTrue + +class ShouldNotifyOfUpdateUseCaseTest { + + private val useCase = ShouldNotifyOfUpdateUseCase() + + private fun result( + tag: String?, + isNewVersionAvailable: Boolean = true, + ) = VersionCheckRepository.VersionCheckResult( + latestRelease = tag?.let { + GithubReleaseInfo( + tagName = it, + name = "Release $it", + body = "body", + htmlUrl = "https://example/$it", + ) + }, + isNewVersionAvailable = isNewVersionAvailable, + currentVersion = "v1.0.0", + ) + + @Test + fun `notifies when new version and no dismissal`() { + assertTrue(useCase(result("v1.2.4"), dismissed = null)) + } + + @Test + fun `does not notify when no new version available`() { + assertFalse(useCase(result("v1.2.4", isNewVersionAvailable = false), dismissed = null)) + } + + @Test + fun `does not notify when latest release is null`() { + assertFalse(useCase(result(tag = null), dismissed = null)) + } + + @Test + fun `does not notify when latest version equals dismissed`() { + assertFalse(useCase(result("v1.2.4"), dismissed = "v1.2.4")) + } + + @Test + fun `partial release notifies users who haven't dismissed`() { + assertTrue(useCase(result("v1.2.4+google-play"), dismissed = null)) + } + + @Test + fun `dismissing a partial release suppresses the eventual full release at the same version`() { + // User dismissed v1.2.4+google-play; later v1.2.4 (full) arrives — + // they shouldn't be re-prompted for the same nominal version. + assertFalse(useCase(result("v1.2.4"), dismissed = "v1.2.4+google-play")) + } + + @Test + fun `dismissing a full release suppresses a later partial release at the same version`() { + assertFalse(useCase(result("v1.2.4+fdroid"), dismissed = "v1.2.4")) + } + + @Test + fun `partial release of newer version still notifies even if older was dismissed`() { + assertTrue(useCase(result("v1.2.5+google-play"), dismissed = "v1.2.4")) + } +} diff --git a/common/src/desktopTest/kotlin/data/versioncheck/VersionCheckRepositoryTest.kt b/common/src/desktopTest/kotlin/data/versioncheck/VersionCheckRepositoryTest.kt index 02a7ec0b2..95d787703 100644 --- a/common/src/desktopTest/kotlin/data/versioncheck/VersionCheckRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/data/versioncheck/VersionCheckRepositoryTest.kt @@ -80,4 +80,16 @@ class VersionCheckRepositoryTest { coVerify(exactly = 2) { dataSource.fetchLatestRelease() } } + @Test + fun `updates flow replays cached value for late subscribers`() = runTest { + val dataSource = mockk() + coEvery { dataSource.fetchLatestRelease() } returns release("v99.0.0") + val repo = VersionCheckRepository(dataSource) + + repo.checkForUpdate() + val replayed = repo.updates.replayCache.lastOrNull() + + assertNotNull(replayed) + assertEquals("v99.0.0", replayed?.latestRelease?.tagName) + } } diff --git a/common/src/desktopTest/kotlin/datamigrator/DataMigratorTest.kt b/common/src/desktopTest/kotlin/datamigrator/DataMigratorTest.kt index bb71a0058..f1d642e11 100644 --- a/common/src/desktopTest/kotlin/datamigrator/DataMigratorTest.kt +++ b/common/src/desktopTest/kotlin/datamigrator/DataMigratorTest.kt @@ -117,7 +117,6 @@ class DataMigratorTest : BaseTest() { val testModule = module { factory { mockMigrator } factory { mockk(relaxed = true) } - factory { mockk(relaxed = true) } factory { mockk(relaxed = true) } factory { mockk(relaxed = true) } } @@ -168,7 +167,6 @@ class DataMigratorTest : BaseTest() { val testModule = module { factory { mockMigrator } factory { mockk(relaxed = true) } - factory { mockk(relaxed = true) } factory { mockk(relaxed = true) } factory { mockk(relaxed = true) } } diff --git a/common/src/desktopTest/kotlin/datamigrator/Migration2_3Test.kt b/common/src/desktopTest/kotlin/datamigrator/Migration2_3Test.kt deleted file mode 100644 index 090eb9114..000000000 --- a/common/src/desktopTest/kotlin/datamigrator/Migration2_3Test.kt +++ /dev/null @@ -1,139 +0,0 @@ -package datamigrator - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource -import com.darkrockstudios.apps.hammer.common.data.migrator.Migration2_3 -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import okio.Path -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import utils.BaseTest -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class Migration2_3Test : BaseTest() { - - private lateinit var ffs: FakeFileSystem - private lateinit var projDef: ProjectDef - - @BeforeEach - override fun setup() { - super.setup() - ffs = FakeFileSystem() - val projectPath = "/projects".toPath().div("Test Project") - ffs.createDirectories(projectPath) - projDef = ProjectDef(name = "Test Project", path = projectPath.toHPath()) - } - - private fun encyclopediaTypeDir(type: String): Path { - val dir = projDef.path.toOkioPath() - .div(EncyclopediaDatasource.ENCYCLOPEDIA_DIRECTORY) - .div(type) - ffs.createDirectories(dir) - return dir - } - - private fun sceneDraftsDir(sceneId: Int): Path { - val dir = SceneDatasource.getSceneDirectory(projDef, ffs).toOkioPath() - .div(SceneDraftsDatasource.DRAFTS_DIR) - .div(sceneId.toString()) - ffs.createDirectories(dir) - return dir - } - - @Test - fun `renames encyclopedia entry files from hyphen to tilde`() { - val dir = encyclopediaTypeDir("person") - ffs.write(dir.div("person-1-Alice.toml")) { writeUtf8("a") } - ffs.write(dir.div("person-2-Bob.toml")) { writeUtf8("b") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(dir.div("person~1~Alice.toml"))) - assertTrue(ffs.exists(dir.div("person~2~Bob.toml"))) - assertFalse(ffs.exists(dir.div("person-1-Alice.toml"))) - } - - @Test - fun `renames encyclopedia entry images`() { - val dir = encyclopediaTypeDir("place") - ffs.write(dir.div("place-7-image.jpg")) { writeUtf8("img") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(dir.div("place~7~image.jpg"))) - assertFalse(ffs.exists(dir.div("place-7-image.jpg"))) - } - - @Test - fun `renames draft files from hyphen to tilde`() { - val dir = sceneDraftsDir(1) - ffs.write(dir.div("1-9-First Draft-1729285670.md")) { writeUtf8("a") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(dir.div("1~9~First Draft~1729285670.md"))) - assertFalse(ffs.exists(dir.div("1-9-First Draft-1729285670.md"))) - } - - @Test - fun `canonicalises a legacy name the old rules let through`() { - // The old rules allowed a trailing space; the datasources encode it away when they build a - // filename, so the migrated file has to be encoded too or nothing will ever find it again. - val entryDir = encyclopediaTypeDir("person") - ffs.write(entryDir.div("person-1-Alice .toml")) { writeUtf8("a") } - val draftDir = sceneDraftsDir(1) - ffs.write(draftDir.div("1-9-My Draft -1729285670.md")) { writeUtf8("b") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(entryDir.div("person~1~Alice.toml"))) - assertTrue(ffs.exists(draftDir.div("1~9~My Draft~1729285670.md"))) - } - - @Test - fun `skips a legacy name that encodes to nothing`() { - val draftDir = sceneDraftsDir(1) - val allSpaces = draftDir.div("1-9- -1729285670.md") - ffs.write(allSpaces) { writeUtf8("b") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(allSpaces), "must be left alone rather than renamed to `1~9~~...`") - } - - @Test - fun `leaves already migrated files untouched`() { - val entryDir = encyclopediaTypeDir("person") - ffs.write(entryDir.div("person~1~Mr. Finch.toml")) { writeUtf8("a") } - val draftDir = sceneDraftsDir(1) - ffs.write(draftDir.div("1~9~Act 2, Take 3~1729285670.md")) { writeUtf8("b") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(entryDir.div("person~1~Mr. Finch.toml"))) - assertTrue(ffs.exists(draftDir.div("1~9~Act 2, Take 3~1729285670.md"))) - } - - @Test - fun `skips a rename when the target already exists`() { - val dir = encyclopediaTypeDir("person") - ffs.write(dir.div("person-1-Alice.toml")) { writeUtf8("legacy") } - ffs.write(dir.div("person~1~Alice.toml")) { writeUtf8("current") } - - Migration2_3(ffs).migrate(projDef) - - assertTrue(ffs.exists(dir.div("person-1-Alice.toml")), "legacy file must be left alone") - assertTrue(ffs.exists(dir.div("person~1~Alice.toml"))) - } - - @Test - fun `a project with neither directory migrates cleanly`() { - Migration2_3(ffs).migrate(projDef) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/TemporaryProjectTaskTest.kt b/common/src/desktopTest/kotlin/repositories/TemporaryProjectTaskTest.kt deleted file mode 100644 index 98c2bb3d0..000000000 --- a/common/src/desktopTest/kotlin/repositories/TemporaryProjectTaskTest.kt +++ /dev/null @@ -1,110 +0,0 @@ -package repositories - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.temporaryProjectTask -import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import io.mockk.mockk -import kotlinx.coroutines.CompletableDeferred -import kotlinx.coroutines.async -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.core.component.KoinComponent -import org.koin.core.component.getScopeId -import org.koin.dsl.module -import org.koin.mp.KoinPlatform.getKoin -import utils.BaseTest - -class TemporaryProjectTaskTest : BaseTest(), KoinComponent { - - private val projectDef = ProjectDef( - name = "Test Project", - path = HPath(path = "/projects/Test Project", name = "Test Project", isAbsolute = true), - ) - - @BeforeEach - override fun setup() { - super.setup() - setupKoin( - module { - scope { - scoped { mockk(relaxed = true) } - scoped { mockk(relaxed = true) } - } - } - ) - } - - private fun scopeIsOpen(): Boolean = - getKoin().getScopeOrNull(ProjectDefScope(projectDef).getScopeId()) != null - - @Test - fun `a lone task opens the scope and closes it again`() = runTest { - assertFalse(scopeIsOpen()) - - temporaryProjectTask(projectDef) { - assertTrue(scopeIsOpen()) - } - - assertFalse(scopeIsOpen()) - } - - @Test - fun `an overlapping task does not lose the scope when the first one finishes`() = runTest { - val firstIsIn = CompletableDeferred() - val releaseFirst = CompletableDeferred() - val secondIsIn = CompletableDeferred() - val releaseSecond = CompletableDeferred() - - val first = async { - temporaryProjectTask(projectDef) { - firstIsIn.complete(Unit) - releaseFirst.await() - } - } - firstIsIn.await() - - val second = async { - temporaryProjectTask(projectDef) { - secondIsIn.complete(Unit) - releaseSecond.await() - // The first task created the scope and has already returned by now. Closing on its - // way out would leave this one resolving against a closed scope. - assertTrue(scopeIsOpen()) - getKoin().getScope(ProjectDefScope(projectDef).getScopeId()).get() - } - } - secondIsIn.await() - - releaseFirst.complete(Unit) - first.await() - - assertTrue(scopeIsOpen()) - - releaseSecond.complete(Unit) - second.await() - - // The last one out still closes it, so an overlap cannot leak the scope either. - assertFalse(scopeIsOpen()) - } - - @Test - fun `a task that throws still releases its claim on the scope`() = runTest { - runCatching { - temporaryProjectTask(projectDef) { error("the task blew up") } - } - - assertFalse(scopeIsOpen()) - - temporaryProjectTask(projectDef) { - assertTrue(scopeIsOpen()) - } - - assertFalse(scopeIsOpen()) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaEntryNameTest.kt b/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaEntryNameTest.kt deleted file mode 100644 index dc9dfd591..000000000 --- a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaEntryNameTest.kt +++ /dev/null @@ -1,203 +0,0 @@ -package repositories.encyclopedia - -import ENCYCLOPEDIA_ONLY_PROJECT_NAME -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryError -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType -import com.darkrockstudios.apps.hammer.common.data.id.IdAllocator -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncJournal -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.fileio.ExternalFileIo -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import createProject -import getProjectDef -import io.mockk.MockKAnnotations -import io.mockk.every -import io.mockk.impl.annotations.MockK -import kotlinx.coroutines.test.runTest -import net.peanuuutz.tomlkt.Toml -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -/** - * Covers the widened entry-name character set (data v3) end to end: what the repository accepts, - * what lands on disk, and that a name survives the round trip through the filename. - */ -class EncyclopediaEntryNameTest : BaseTest() { - - private val projDef = getProjectDef(ENCYCLOPEDIA_ONLY_PROJECT_NAME) - - @MockK - lateinit var idAllocator: IdAllocator - - @MockK - lateinit var externalFileIo: ExternalFileIo - - @MockK - lateinit var syncJournal: SyncJournal - - private lateinit var fileSystem: FakeFileSystem - private lateinit var datasource: EncyclopediaDatasource - private lateinit var toml: Toml - - @BeforeEach - override fun setup() { - super.setup() - MockKAnnotations.init(this, relaxUnitFun = true) - setupKoin() - - every { syncJournal.isServerSynchronized() } returns false - fileSystem = FakeFileSystem() - toml = createTomlSerializer() - createProject(fileSystem, ENCYCLOPEDIA_ONLY_PROJECT_NAME) - } - - private fun createRepository(): EncyclopediaRepository { - datasource = EncyclopediaDatasource( - projectDef = projDef, - toml = toml, - fileSystem = fileSystem, - externalFileIo = externalFileIo, - ) - return EncyclopediaRepository( - projectDef = projDef, - idAllocator = idAllocator, - datasource = datasource, - syncJournal = syncJournal, - ) - } - - private suspend fun create(repo: EncyclopediaRepository, name: String, id: Int = 50) = - repo.createEntry( - name = name, - type = EntryType.PERSON, - text = "text", - tags = emptySet(), - imagePath = null, - forceId = id, - ) - - @Test - fun `names with punctuation that used to be rejected are now accepted`() = runTest { - val repo = createRepository() - val names = listOf( - "Mr. Finch", - "Ael'thara, the Drowned", - "Who Goes There?", - "Bag End (Hobbiton)", - "Smith & Sons", - "Chapter 3: The Fall", - "Half-Elf", - "Stop!", - "The “Masked” Man", - ) - - names.forEachIndexed { index, name -> - val result = create(repo, name, id = 100 + index) - assertEquals(EntryError.NONE, result.error, "'$name' should be a legal entry name") - } - } - - @Test - fun `the reserved filename delimiter is still rejected`() = runTest { - val repo = createRepository() - - val result = create(repo, "Bad~Name") - - assertEquals(EntryError.NAME_INVALID_CHARACTERS, result.error) - } - - @Test - fun `a trailing dot is rejected because the on-disk encoder would strip it`() = runTest { - val repo = createRepository() - - val result = create(repo, "Mr. Finch.") - - assertEquals(EntryError.NAME_INVALID_CHARACTERS, result.error) - } - - @Test - fun `a name with OS-forbidden characters is stored under a safe filename and round-trips`() = - runTest { - val repo = createRepository() - val name = "Chapter 3: The Fall?" - - assertEquals(EntryError.NONE, create(repo, name).error) - - val def = repo.getEntryDef(50) - assertEquals(name, def.name, "The display name must survive the filename encoding") - - val path = datasource.getEntryPath(def).toOkioPath() - assertTrue(fileSystem.exists(path)) - assertFalse(path.name.contains(':'), "Filename must not contain a forbidden char") - assertFalse(path.name.contains('?'), "Filename must not contain a forbidden char") - assertEquals("text", repo.loadEntry(50).entry.text) - } - - @Test - fun `an entry stored under the legacy filename is still found, read and deleted`() = runTest { - val repo = createRepository() - val typeDir = EncyclopediaDatasource - .getTypeDirectory(projDef, EntryType.PERSON, fileSystem) - .toOkioPath() - val legacyPath = typeDir / "person-77-Old Timer.toml" - fileSystem.write(legacyPath) { - writeUtf8( - """ - [entry] - id = 77 - name = "Old Timer" - type = "PERSON" - text = "legacy" - tags = [] - """.trimIndent() - ) - } - - val def = repo.getEntryDef(77) - assertEquals("Old Timer", def.name) - assertEquals("legacy", repo.loadEntry(77).entry.text) - - repo.deleteEntry(def) - assertFalse(fileSystem.exists(legacyPath), "The legacy file must actually be deleted") - } - - @Test - fun `renaming a legacy entry rewrites it under the current filename format`() = runTest { - val repo = createRepository() - val typeDir = EncyclopediaDatasource - .getTypeDirectory(projDef, EntryType.PERSON, fileSystem) - .toOkioPath() - val legacyPath = typeDir / "person-78-Old Timer.toml" - fileSystem.write(legacyPath) { - writeUtf8( - """ - [entry] - id = 78 - name = "Old Timer" - type = "PERSON" - text = "legacy" - tags = [] - """.trimIndent() - ) - } - - val result = repo.updateEntry( - oldEntryDef = repo.getEntryDef(78), - name = "Old Timer, Esq", - text = "legacy", - tags = emptySet(), - excludeFromDictionary = false, - ) - - assertEquals(EntryError.NONE, result.error) - assertFalse(fileSystem.exists(legacyPath)) - assertTrue(fileSystem.exists(typeDir / "person~78~Old Timer, Esq.toml")) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaRepositoryTest.kt index 5181bacff..6d17065c6 100644 --- a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaRepositoryTest.kt @@ -96,8 +96,7 @@ class EncyclopediaRepositoryTest : BaseTest() { oldEntryDef = origDef, name = newValidName, text = entry.text, - tags = entry.tags, - excludeFromDictionary = false, + tags = entry.tags ) @@ -119,8 +118,8 @@ class EncyclopediaRepositoryTest : BaseTest() { val repo = createRepository() ///////////////////// - // Invalid characters (`~` is the reserved filename delimiter) - var newName = "A ~ Invalid" + // Invalid characters + var newName = "A : Invalid" var newEntry = oldEntry.copy( name = newName ) @@ -128,8 +127,7 @@ class EncyclopediaRepositoryTest : BaseTest() { oldEntryDef = origDef, name = newName, text = oldEntry.text, - tags = oldEntry.tags, - excludeFromDictionary = false, + tags = oldEntry.tags ) assertInvalid(EntryError.NAME_INVALID_CHARACTERS, result, repo, oldEntry, newEntry) @@ -144,8 +142,7 @@ class EncyclopediaRepositoryTest : BaseTest() { oldEntryDef = origDef, name = newName, text = oldEntry.text, - tags = oldEntry.tags, - excludeFromDictionary = false, + tags = oldEntry.tags ) assertInvalid(EntryError.NAME_TOO_SHORT, result, repo, oldEntry, newEntry) @@ -160,8 +157,7 @@ class EncyclopediaRepositoryTest : BaseTest() { oldEntryDef = origDef, name = newName, text = oldEntry.text, - tags = oldEntry.tags, - excludeFromDictionary = false, + tags = oldEntry.tags ) assertInvalid(EntryError.NAME_TOO_LONG, result, repo, oldEntry, newEntry) @@ -372,7 +368,6 @@ class EncyclopediaRepositoryTest : BaseTest() { name = entry1().name, text = "updated text", tags = entry1().tags, - excludeFromDictionary = false, ) awaitItem() diff --git a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaServiceTest.kt b/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaServiceTest.kt index 1ccdd5653..af1051f4f 100644 --- a/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/encyclopedia/EncyclopediaServiceTest.kt @@ -131,7 +131,6 @@ class EncyclopediaServiceTest : BaseTest() { name = "A new name", text = entry1().text, tags = entry1().tags, - excludeFromDictionary = false, ) assertEquals(EntryError.NONE, result.error) @@ -146,7 +145,6 @@ class EncyclopediaServiceTest : BaseTest() { name = "", text = entry1().text, tags = entry1().tags, - excludeFromDictionary = false, ) assertEquals(EntryError.NAME_TOO_SHORT, result.error) diff --git a/common/src/desktopTest/kotlin/repositories/globalsettings/GlobalSettingsDatasourceTest.kt b/common/src/desktopTest/kotlin/repositories/globalsettings/GlobalSettingsDatasourceTest.kt index 8e9c5b5f2..7a8cef09c 100644 --- a/common/src/desktopTest/kotlin/repositories/globalsettings/GlobalSettingsDatasourceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/globalsettings/GlobalSettingsDatasourceTest.kt @@ -127,25 +127,6 @@ class GlobalSettingsDatasourceTest : BaseTest() { assertEquals(InitialProjectScreen.Home, loaded.initialProjectScreen) } - @Test - fun `Load Global Settings missing reader keys uses the reader defaults`() = runTest { - val datasource = createDatasource() - fileSystem.createDirectories(GlobalSettingsFilesystemDatasource.CONFIG_PATH.parent!!) - fileSystem.write(GlobalSettingsFilesystemDatasource.CONFIG_PATH) { - writeUtf8( - """ - projectsDirectory = "test" - editorFontSize = 22.0 - """.trimIndent() - ) - } - - val loaded: GlobalSettings = datasource.loadSettings() - - assertEquals(GlobalSettings.DEFAULT_FONT_SIZE, loaded.readerFontSize) - assertEquals(false, loaded.readerShowSceneHeadings) - } - @Test fun `Store and load preserves initialProjectScreen`() = runTest { val datasource = createDatasource() diff --git a/common/src/desktopTest/kotlin/repositories/globalsettings/ServerSettingsDatasourceTest.kt b/common/src/desktopTest/kotlin/repositories/globalsettings/ServerSettingsDatasourceTest.kt index ca5f60b43..44ff0f4b5 100644 --- a/common/src/desktopTest/kotlin/repositories/globalsettings/ServerSettingsDatasourceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/globalsettings/ServerSettingsDatasourceTest.kt @@ -88,40 +88,6 @@ class ServerSettingsDatasourceTest : BaseTest() { assertEquals(serverConfig, loaded) } - @Test - fun `A plaintext server round-trips as plaintext`() = runTest { - val datasource = createDatasource() - val plaintext = createConfig().copy(ssl = false, url = "192.168.1.50:8080") - - datasource.storeServerSettings(plaintext, projectsDir()) - - assertEquals(plaintext, datasource.loadServerSettings(projectsDir())) - } - - @Test - fun `A server json written before plaintext support loads as https`() = runTest { - fileSystem.createDirectories(projectsDirPath()) - fileSystem.write(configPath().toOkioPath()) { - writeUtf8("""{"url":"hammer.ink","email":"test@example.com","userId":1}""") - } - - val loaded = createDatasource().loadServerSettings(projectsDir()) - - assertTrue(loaded!!.ssl) - } - - @Test - fun `A legacy ssl false key still loads as https`() = runTest { - fileSystem.createDirectories(projectsDirPath()) - fileSystem.write(configPath().toOkioPath()) { - writeUtf8("""{"ssl":false,"url":"hammer.ink","email":"test@example.com","userId":1}""") - } - - val loaded = createDatasource().loadServerSettings(projectsDir()) - - assertTrue(loaded!!.ssl) - } - @Test fun `Stored server json contains no tokens`() = runTest { val datasource = createDatasource() diff --git a/common/src/desktopTest/kotlin/repositories/globalsettings/ServerUrlTest.kt b/common/src/desktopTest/kotlin/repositories/globalsettings/ServerUrlTest.kt deleted file mode 100644 index 14a55deb5..000000000 --- a/common/src/desktopTest/kotlin/repositories/globalsettings/ServerUrlTest.kt +++ /dev/null @@ -1,60 +0,0 @@ -package repositories.globalsettings - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.isInsecureServerUrl -import com.darkrockstudios.apps.hammer.common.data.globalsettings.parseServerUrl -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -class ServerUrlTest { - - @Test - fun `an http url asks for plaintext`() { - val parsed = parseServerUrl("http://192.168.1.50:8080") - - assertEquals("192.168.1.50:8080", parsed.host) - assertFalse(parsed.ssl) - } - - @Test - fun `an uppercase http scheme still asks for plaintext`() { - assertFalse(parseServerUrl("HTTP://Home-Server.lan:8080").ssl) - } - - @Test - fun `an https url stays encrypted`() { - val parsed = parseServerUrl("https://hammer.ink") - - assertEquals("hammer.ink", parsed.host) - assertTrue(parsed.ssl) - } - - @Test - fun `a bare host stays encrypted`() { - val parsed = parseServerUrl("hammer.ink") - - assertEquals("hammer.ink", parsed.host) - assertTrue(parsed.ssl) - } - - @Test - fun `whitespace, case and a trailing slash are cleaned off the host`() { - val parsed = parseServerUrl(" HTTP://Home-Server.lan:8080/ ") - - assertEquals("home-server.lan:8080", parsed.host) - assertFalse(parsed.ssl) - } - - @Test - fun `an empty url is not treated as insecure`() { - assertFalse(isInsecureServerUrl(" ")) - } - - @Test - fun `isInsecureServerUrl agrees with the parsed scheme`() { - assertTrue(isInsecureServerUrl("http://192.168.1.50:8080")) - assertFalse(isInsecureServerUrl("https://hammer.ink")) - assertFalse(isInsecureServerUrl("hammer.ink")) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/ideas/PromoteIdeaUseCaseTest.kt b/common/src/desktopTest/kotlin/repositories/ideas/PromoteIdeaUseCaseTest.kt index d7cc256bf..52589e685 100644 --- a/common/src/desktopTest/kotlin/repositories/ideas/PromoteIdeaUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/repositories/ideas/PromoteIdeaUseCaseTest.kt @@ -17,8 +17,6 @@ import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetada import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.common.util.Locale import io.mockk.every import io.mockk.mockk import kotlinx.coroutines.flow.MutableSharedFlow @@ -60,15 +58,10 @@ class PromoteIdeaUseCaseTest : BaseTest() { setupKoin() - val deviceLocaleResolver = mockk() - every { deviceLocaleResolver.getCurrentLocale() } returns Locale.forLanguage("en", "US") projectsRepository = ProjectsRepository( fileSystem = ffs, globalSettingsStore = globalSettingsStore, projectsMetadataDatasource = ProjectMetadataDatasource(ffs, toml), - toml = toml, - json = createJsonSerializer(), - deviceLocaleResolver = deviceLocaleResolver, ) val ideasDatasource = IdeasDatasource(ffs, StoryIdeaCodec(toml), globalSettingsStore) ideasRepository = IdeasRepository( @@ -117,8 +110,6 @@ class PromoteIdeaUseCaseTest : BaseTest() { ffs.read(projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME) { readUtf8() }, ) assertEquals(setOf("gothic", "coastal"), storedProjectData.data.tags) - // The tags write must merge onto the seeded default language, not replace the file. - assertEquals("en", storedProjectData.data.language) val promoted = ideasRepository.getIdeaById(idea.id) assertNotNull(promoted?.promoted) @@ -140,7 +131,7 @@ class PromoteIdeaUseCaseTest : BaseTest() { @Test fun `Promotion suffixes the project name when it already exists`() = runTest { advanceUntilIdle() - projectsRepository.createProject("Tides", seedDefaultLanguage = true).let { assertTrue(isSuccess(it)) } + projectsRepository.createProject("Tides").let { assertTrue(isSuccess(it)) } val idea = ideasRepository.createIdea(content = "waves", title = "Tides") .let { assertTrue(isSuccess(it)); it.data } diff --git a/common/src/desktopTest/kotlin/repositories/projectdata/ProjectDataRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/projectdata/ProjectDataRepositoryTest.kt index a393a09ea..0e93483e5 100644 --- a/common/src/desktopTest/kotlin/repositories/projectdata/ProjectDataRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectdata/ProjectDataRepositoryTest.kt @@ -122,33 +122,6 @@ class ProjectDataRepositoryTest : BaseTest() { coVerify(exactly = 1) { syncDataDatasource.invalidateProjectHash() } } - @Test - fun `updateData persists the language and it round-trips through TOML`() = runTest { - datasource.save(StoredProjectData(ProjectData(authorName = "Pat"), "synced-hash")) - - repository.updateData { it.copy(language = "pt-BR") } - - val onDisk = datasource.load() - assertEquals("pt-BR", onDisk.data.language) - assertEquals("Pat", onDisk.data.authorName) - } - - @Test - fun `pre-language project_data toml loads with null language`() = runTest { - val legacyToml = """ - |[data] - |authorName = "Legacy" - | - """.trimMargin() - fileSystem.write("/projects/Test Project/project_data.toml".toPath()) { - writeUtf8(legacyToml) - } - - val loaded = repository.load() - - assertNull(loaded.data.language) - } - @Test fun `pre-tags project_data toml loads with empty tags`() = runTest { // A file written before the tags field existed. @@ -169,9 +142,9 @@ class ProjectDataRepositoryTest : BaseTest() { @Test fun `updateFromSync replaces both data and the synced hash`() = runTest { - val snapshot = repository.load().data + repository.load() - repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash", snapshot) + repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash") assertEquals( StoredProjectData(ProjectData(authorName = "Server"), "server-hash"), @@ -187,35 +160,12 @@ class ProjectDataRepositoryTest : BaseTest() { @Test fun `updateFromSync is idempotent`() = runTest { - val snapshot = repository.load().data - repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash", snapshot) - repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash", snapshot) + repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash") + repository.updateFromSync(ProjectData(authorName = "Server"), "server-hash") assertEquals( StoredProjectData(ProjectData(authorName = "Server"), "server-hash"), repository.state.value, ) } - - @Test - fun `updateFromSync keeps edits made after the snapshot`() = runTest { - val snapshot = repository.load().data - - // Lands while the sync's network round-trip is in flight. - repository.updateData { it.copy(dictionaryWords = setOf("local"), authorName = "Edited") } - - repository.updateFromSync( - ProjectData(authorName = "Server", language = "en", dictionaryWords = setOf("server")), - "server-hash", - snapshot, - ) - - assertEquals( - StoredProjectData( - ProjectData(authorName = "Edited", language = "en", dictionaryWords = setOf("server", "local")), - "server-hash", - ), - repository.state.value, - ) - } } diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBaseTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBaseTest.kt index 4c4499e09..f5d47a0b8 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBaseTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBaseTest.kt @@ -1,13 +1,9 @@ package repositories.projectsrepository -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.common.util.Locale import createRootDirectory import getProjectsDirectory import io.mockk.coEvery @@ -15,9 +11,7 @@ import io.mockk.coJustAwait import io.mockk.every import io.mockk.mockk import kotlinx.coroutines.flow.SharedFlow -import kotlinx.serialization.json.Json import net.peanuuutz.tomlkt.Toml -import okio.FileSystem import okio.fakefilesystem.FakeFileSystem import org.junit.jupiter.api.AfterEach import org.junit.jupiter.api.BeforeEach @@ -29,11 +23,6 @@ abstract class ProjectsRepositoryBaseTest : BaseTest() { protected lateinit var projectsMetaDatasource: ProjectMetadataDatasource protected lateinit var settings: GlobalSettings protected lateinit var toml: Toml - protected lateinit var json: Json - protected lateinit var deviceLocaleResolver: DeviceLocaleResolver - - protected fun projectsRepository(fs: FileSystem = ffs) = - ProjectsRepository(fs, settingsRepo, projectsMetaDatasource, toml, json, deviceLocaleResolver) @BeforeEach override fun setup() { @@ -41,9 +30,6 @@ abstract class ProjectsRepositoryBaseTest : BaseTest() { ffs = FakeFileSystem() toml = createTomlSerializer() - json = createJsonSerializer() - deviceLocaleResolver = mockk() - every { deviceLocaleResolver.getCurrentLocale() } returns Locale.forLanguage("en", "US") projectsMetaDatasource = ProjectMetadataDatasource(ffs, toml) diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBasicTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBasicTest.kt index 4c56062eb..c8738dc2d 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBasicTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryBasicTest.kt @@ -5,7 +5,6 @@ import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.Pr import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.ProjectDefinition import com.darkrockstudios.apps.hammer.common.data.isFailure -import com.darkrockstudios.apps.hammer.common.data.projectdata.loadStoredProjectData import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectCreationFailedException import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository @@ -32,7 +31,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { fun `ProjectsRepository init`() = scope.runTest { val projDir = getProjectsDirectory() assertFalse(ffs.exists(projDir), "Dir should not have existed already") - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) assertTrue(ffs.exists(projDir), "Init did not create project dir") } @@ -94,7 +93,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { @Test fun `Get Projects Directory`() = scope.runTest { val actualProjDir = getProjectsDirectory().toHPath() - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDir = repo.getProjectsDirectory() assertEquals(actualProjDir, projectDir) } @@ -102,7 +101,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { @Test fun `Ensure Projects Directory`() = scope.runTest { val actualProjDir = getProjectsDirectory() - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) ffs.deleteRecursively(actualProjDir) assertFalse(ffs.exists(actualProjDir)) @@ -114,7 +113,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { fun `Get Projects`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projects = repo.getProjects() assertEquals(projectNames.size, projects.size) @@ -141,7 +140,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { // Stray file at the top level ffs.write(projDir.div("stray.txt")) { writeUtf8("") } - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projects = repo.getProjects() assertEquals(projectNames.toSet(), projects.map { it.name }.toSet()) @@ -154,7 +153,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { ffs.createDirectories(projDir.div(encodedName)) ffs.write(projDir.div(encodedName).div(ProjectMetadata.FILENAME)) { writeUtf8("") } - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projects = repo.getProjects() assertEquals(listOf("Chapter 3: The Fall?"), projects.map { it.name }) @@ -163,7 +162,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { @Test fun `Get Project Directory`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] val projectDir = repo.getProjectDirectory(projectName) @@ -174,16 +173,16 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { @Test fun `Create Project`() = scope.runTest { - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] - val result = repo.createProject(projectName, seedDefaultLanguage = true) + val result = repo.createProject(projectName) assertTrue(result.isSuccess) val actualProjDir = getProjectsDirectory().div(projectName) assertTrue(ffs.exists(actualProjDir)) - val result2 = repo.createProject(projectName, seedDefaultLanguage = true) + val result2 = repo.createProject(projectName) assertFalse(result2.isSuccess) val newDef = ProjectDef(projectName, actualProjDir.toHPath()) @@ -195,38 +194,12 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { ) } - @Test - fun `Create Project defaults the project language to the device language without region`() = scope.runTest { - val repo = projectsRepository() - - val projectName = projectNames[0] - assertTrue(repo.createProject(projectName, seedDefaultLanguage = true).isSuccess) - - val newDef = ProjectDef(projectName, getProjectsDirectory().div(projectName).toHPath()) - val stored = loadStoredProjectData(newDef, ffs, toml) - // Region deliberately dropped from the en-US device locale: the auto-default must - // never gate spell check against a same-language dictionary of another region. - assertEquals("en", stored.data.language) - assertEquals(null, stored.lastSyncedHash) - } - - @Test - fun `Create Project without seeding leaves no project_data file`() = scope.runTest { - val repo = projectsRepository() - - val projectName = projectNames[0] - assertTrue(repo.createProject(projectName, seedDefaultLanguage = false).isSuccess) - - // Server-materialized shells must keep the never-synced baseline: no file at all. - assertFalse(ffs.exists(getProjectsDirectory().div(projectName).div("project_data.toml"))) - } - @Test fun `Create Project failure with invalid name`() = scope.runTest { - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = "!@/Invalid Name" - val result = repo.createProject(projectName, seedDefaultLanguage = true) + val result = repo.createProject(projectName) assertTrue(isFailure(result)) assertTrue(result.exception is ProjectCreationFailedException) assertTrue( @@ -238,7 +211,7 @@ class ProjectsRepositoryBasicTest : ProjectsRepositoryBaseTest() { @Test fun `Delete Project`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] val projPath = getProjectsDirectory().div(projectName) diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryConcurrencyTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryConcurrencyTest.kt index c9ddf1166..b03fa5603 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryConcurrencyTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryConcurrencyTest.kt @@ -28,7 +28,7 @@ class ProjectsRepositoryConcurrencyTest : ProjectsRepositoryBaseTest() { if (dir == getProjectsDirectory()) super.list(dir) + phantom else super.list(dir) } - val repo = projectsRepository(racingFs) + val repo = ProjectsRepository(racingFs, settingsRepo, projectsMetaDatasource) val projects = repo.getProjects() assertEquals(projectNames.size, projects.size) diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryDeleteAllLocalDataTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryDeleteAllLocalDataTest.kt deleted file mode 100644 index 7d3ec5a40..000000000 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryDeleteAllLocalDataTest.kt +++ /dev/null @@ -1,91 +0,0 @@ -package repositories.projectsrepository - -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer -import com.darkrockstudios.apps.hammer.common.components.storyeditor.metadata.ProjectMetadata -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.flow.MutableSharedFlow -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class ProjectsRepositoryDeleteAllLocalDataTest : BaseTest() { - - private lateinit var ffs: FakeFileSystem - private lateinit var projectsRepository: ProjectsRepository - - @BeforeEach - override fun setup() { - super.setup() - ffs = FakeFileSystem() - val toml = createTomlSerializer() - - val globalSettingsStore = mockk() - every { globalSettingsStore.globalSettings } returns GlobalSettings(projectsDirectory = "/projects") - every { globalSettingsStore.globalSettingsUpdates } returns MutableSharedFlow() - - setupKoin() - - projectsRepository = ProjectsRepository( - fileSystem = ffs, - globalSettingsStore = globalSettingsStore, - projectsMetadataDatasource = ProjectMetadataDatasource(ffs, toml), - toml = toml, - json = createJsonSerializer(), - deviceLocaleResolver = mockk(relaxed = true), - ) - } - - @Test - fun `everything under the projects directory is removed but the directory remains`() { - projectsRepository.createProject("Alpha", seedDefaultLanguage = false) - projectsRepository.createProject("Beta", seedDefaultLanguage = false) - ffs.createDirectories("/projects/.ideas/idea-1".toPath()) - ffs.write("/projects/.sync.json".toPath()) { writeUtf8("{}") } - - projectsRepository.deleteAllLocalData() - - assertTrue(ffs.exists("/projects".toPath())) - assertEquals(emptyList(), ffs.list("/projects".toPath())) - assertEquals(emptyList(), projectsRepository.getProjects()) - } - - @Test - fun `a project's content goes but the project itself stays listed`() { - projectsRepository.createProject("Alpha", seedDefaultLanguage = false) - val projectDef = projectsRepository.getProjects().single() - val projectDir = projectDef.path.toOkioPath() - ffs.createDirectories(projectDir / "scenes") - ffs.write(projectDir / "scenes" / "1.md") { writeUtf8("a scene synced from the server") } - ffs.write(projectDir / ".sync.json") { writeUtf8("{}") } - - projectsRepository.deleteProjectContent(projectDef) - - // Only the metadata survives: the sync baseline has to go, or a re-download would believe - // the content it just deleted is still present. - assertEquals(listOf(projectDir / ProjectMetadata.FILENAME), ffs.list(projectDir)) - assertEquals(listOf(projectDef), projectsRepository.getProjects()) - } - - @Test - fun `removing the content of a project that is already gone does nothing`() { - projectsRepository.createProject("Alpha", seedDefaultLanguage = false) - val projectDef = projectsRepository.getProjects().single() - ffs.deleteRecursively(projectDef.path.toOkioPath()) - - projectsRepository.deleteProjectContent(projectDef) - - assertEquals(emptyList(), projectsRepository.getProjects()) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryFindTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryFindTest.kt index c8893ef1f..bb16f6857 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryFindTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryFindTest.kt @@ -21,7 +21,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_2_NAME) createProject(ffs, OUT_OF_ORDER_PROJECT_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDef = repo.findProject(PROJECT_2_NAME) @@ -33,7 +33,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_1_NAME) createProject(ffs, OUT_OF_ORDER_PROJECT_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDef = repo.findProject(PROJECT_2_NAME) @@ -49,7 +49,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_2_NAME) createProject(ffs, OUT_OF_ORDER_PROJECT_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDef = repo.findProject(proj1Id) @@ -64,7 +64,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_2_NAME) createProject(ffs, OUT_OF_ORDER_PROJECT_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDef = repo.findProject(fakeId) @@ -78,7 +78,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_2_NAME) createProject(ffs, OUT_OF_ORDER_PROJECT_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectDef = repo.getProjectDefinition(PROJECT_1_NAME) @@ -93,7 +93,7 @@ class ProjectsRepositoryFindTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_1_NAME) createProject(ffs, PROJECT_2_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val known = repo.getProjects().firstOrNull { it.name == PROJECT_1_NAME } val forged = repo.getProjects().firstOrNull { it.name == "../../attacker/controlled" } diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryIdTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryIdTest.kt index c988a85b8..b16f0e51a 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryIdTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryIdTest.kt @@ -21,7 +21,7 @@ class ProjectsRepositoryIdTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_1_NAME) createProject(ffs, PROJECT_2_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) assertEquals(ProjectId("5f1d7446-1f08-4909-a81e-cdc7470a2f63"), repo.getProjectId(proj1Def)) assertNull(repo.getProjectId(proj2Def)) @@ -35,7 +35,7 @@ class ProjectsRepositoryIdTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_1_NAME) createProject(ffs, PROJECT_2_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) assertNull(repo.getProjectId(proj2Def)) @@ -52,7 +52,7 @@ class ProjectsRepositoryIdTest : ProjectsRepositoryBaseTest() { createProject(ffs, PROJECT_1_NAME) createProject(ffs, PROJECT_2_NAME) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) assertNotNull(repo.getProjectId(proj1Def)) diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryRenameTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryRenameTest.kt index 04886b88e..98ed774be 100644 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryRenameTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositoryRenameTest.kt @@ -22,7 +22,7 @@ class ProjectsRepositoryRenameTest : ProjectsRepositoryBaseTest() { @Test fun `Rename Project, success`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] val newProjectName = "New Project Name" @@ -40,7 +40,7 @@ class ProjectsRepositoryRenameTest : ProjectsRepositoryBaseTest() { @Test fun `Rename Project, invalid name`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] val newProjectName = "@invalid Project Name" @@ -65,7 +65,7 @@ class ProjectsRepositoryRenameTest : ProjectsRepositoryBaseTest() { @Test fun `Rename Project, project does not exist`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = "None Existent Project" val newProjectName = "New Project Name" @@ -90,7 +90,7 @@ class ProjectsRepositoryRenameTest : ProjectsRepositoryBaseTest() { @Test fun `Rename Project, already exists`() = scope.runTest { createProjectDirectories(ffs) - val repo = projectsRepository() + val repo = ProjectsRepository(ffs, settingsRepo, projectsMetaDatasource) val projectName = projectNames[0] val newProjectName = projectNames[1] diff --git a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositorySyncBaselineTest.kt b/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositorySyncBaselineTest.kt deleted file mode 100644 index 00ffba0cc..000000000 --- a/common/src/desktopTest/kotlin/repositories/projectsrepository/ProjectsRepositorySyncBaselineTest.kt +++ /dev/null @@ -1,216 +0,0 @@ -package repositories.projectsrepository - -import PROJECT_1_NAME -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.createProjectScope -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData -import com.darkrockstudios.apps.hammer.common.data.projectdata.readStoredProjectData -import com.darkrockstudios.apps.hammer.common.data.projectdata.saveStoredProjectData -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.EntityOriginalState -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ProjectSynchronizationData -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncDataDatasource -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import createProject -import getProjectDef -import kotlinx.coroutines.test.runTest -import okio.Path -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNull -import kotlin.test.assertTrue -import kotlin.time.Instant - -/** - * A project's sync baseline (the entity journal's confirmed hashes and `lastSyncedHash`) records - * what a *specific* server has already confirmed. Carrying it onto a different server makes an - * untouched project look "already in sync", so its content is never pushed and the local copy - * fast-forwards to the new server's empty one. Local pending work must survive the clear, though: - * the new server has never seen it either. - */ -class ProjectsRepositorySyncBaselineTest : ProjectsRepositoryBaseTest() { - - private val projectDef = getProjectDef(PROJECT_1_NAME) - - private fun syncJournalPath(): Path = - projectDef.path.toOkioPath() / SyncDataDatasource.SYNC_FILE_NAME - - private val seededJournal = ProjectSynchronizationData( - currentSyncId = "session-on-the-old-server", - lastId = 42, - newIds = listOf(41, 42), - lastSync = Instant.fromEpochSeconds(1_000_000), - dirty = listOf(EntityOriginalState(5, "hash-agreed-with-the-old-server")), - deletedIds = setOf(7), - syncedHashes = mapOf(5 to "hash-agreed-with-the-old-server"), - cachedProjectHash = "project-hash-agreed-with-the-old-server", - hashAlgoVersion = 3, - ) - - private fun seedBaseline() { - ffs.write(syncJournalPath()) { writeUtf8(json.encodeToString(seededJournal)) } - saveStoredProjectData( - projectDef, - ffs, - toml, - StoredProjectData( - data = ProjectData(authorName = "Author"), - lastSyncedHash = "hash-agreed-with-the-old-server", - ), - ) - } - - private fun readJournal(): ProjectSynchronizationData = - ffs.read(syncJournalPath()) { json.decodeFromString(readUtf8()) } - - private fun storedProjectData(): StoredProjectData = - readStoredProjectData(projectDef, ffs, toml) - - @Test - fun `Moving a project to a different server id drops what the old server confirmed`() = - scope.runTest { - createProject(ffs, PROJECT_1_NAME) - seedBaseline() - val repo = projectsRepository() - - repo.setProjectId(projectDef, ProjectId("id-on-the-new-server")) - - val journal = readJournal() - assertEquals(emptyMap(), journal.syncedHashes, "confirmed hashes were the old server's") - assertNull(journal.cachedProjectHash) - assertEquals(0, journal.hashAlgoVersion) - assertNull(journal.currentSyncId, "the sync session belonged to the old server") - assertEquals(Instant.DISTANT_PAST, journal.lastSync) - assertNull( - storedProjectData().lastSyncedHash, - "the project-data baseline must not survive the move", - ) - } - - @Test - fun `Moving a project keeps local work the new server has never seen`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - seedBaseline() - val repo = projectsRepository() - - repo.setProjectId(projectDef, ProjectId("id-on-the-new-server")) - - val journal = readJournal() - assertEquals(seededJournal.lastId, journal.lastId) - assertEquals(seededJournal.newIds, journal.newIds) - assertEquals( - seededJournal.deletedIds, - journal.deletedIds, - "a tombstone the old server never got must still be pushed to the new one", - ) - assertEquals( - listOf(EntityOriginalState(5, originalHash = null)), - journal.dirty, - "the edit is still pending, but its baseline was agreed with the old server", - ) - } - - @Test - fun `Clearing the sync baseline preserves the project data itself`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - seedBaseline() - val repo = projectsRepository() - - repo.setProjectId(projectDef, ProjectId("id-on-the-new-server")) - - assertEquals( - ProjectData(authorName = "Author"), - storedProjectData().data, - "only the baseline is stale; the user's data must be left alone so it can be uploaded", - ) - } - - @Test - fun `Re-writing the same project id leaves the sync baseline alone`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - val sameId = ProjectId("id-already-recorded") - val repo = projectsRepository() - repo.setProjectId(projectDef, sameId) - seedBaseline() - - repo.setProjectId(projectDef, sameId) - - assertEquals(seededJournal, readJournal(), "an unchanged id is not a server change") - assertEquals("hash-agreed-with-the-old-server", storedProjectData().lastSyncedHash) - } - - @Test - fun `Removing a project id clears its sync baseline`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - seedBaseline() - val repo = projectsRepository() - - // removeServer() and create-account both clear ids; whatever the project is uploaded to - // next has never seen it. - repo.removeProjectId(projectDef) - - assertEquals(emptyMap(), readJournal().syncedHashes) - assertNull(storedProjectData().lastSyncedHash) - assertEquals(ProjectData(authorName = "Author"), storedProjectData().data) - } - - @Test - fun `Clearing the baseline of a never-synced project is a no-op`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - val repo = projectsRepository() - - repo.setProjectId(projectDef, ProjectId("first-ever-id")) - - // No journal is fabricated, and no project_data.toml is written just to hold a null. - assertFalse(ffs.exists(syncJournalPath())) - assertFalse(ffs.exists(projectDef.path.toOkioPath() / ProjectDataDatasource.FILENAME)) - } - - @Test - fun `Clearing the baseline of an open project drops its cached copy too`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - seedBaseline() - val projectDataRepository = openProject() - // An open project serves project data from memory, so the stale hash has to go from there - // as well or the next sync still fast-forwards onto the new server's empty copy. - assertEquals("hash-agreed-with-the-old-server", projectDataRepository.load().lastSyncedHash) - - projectsRepository().setProjectId(projectDef, ProjectId("id-on-the-new-server")) - - assertNull(projectDataRepository.load().lastSyncedHash) - assertNull(storedProjectData().lastSyncedHash) - assertEquals(ProjectData(authorName = "Author"), projectDataRepository.load().data) - } - - /** Mirrors the project scope `mainModule` opens when a project is opened in the editor. */ - private fun openProject(): ProjectDataRepository { - setupKoin( - module { - scope { - scoped { get().projectDef } - scoped { ProjectDataDatasource(ffs, toml, get()) } - scoped { ProjectDataRepository(get(), get()) } - } - } - ) - return createProjectScope(projectDef).get() - } - - @Test - fun `A corrupt journal is discarded so the next sync rebuilds it`() = scope.runTest { - createProject(ffs, PROJECT_1_NAME) - ffs.write(syncJournalPath()) { writeUtf8("not json at all") } - val repo = projectsRepository() - - repo.setProjectId(projectDef, ProjectId("id-on-the-new-server")) - - assertFalse(ffs.exists(syncJournalPath())) - assertTrue(ffs.exists(projectDef.path.toOkioPath())) - } -} diff --git a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCountTest.kt b/common/src/desktopTest/kotlin/repositories/projectstatistics/WordCountTest.kt similarity index 51% rename from base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCountTest.kt rename to common/src/desktopTest/kotlin/repositories/projectstatistics/WordCountTest.kt index 3431daa06..b3d75b5ca 100644 --- a/base/src/commonTest/kotlin/com/darkrockstudios/apps/hammer/base/markdown/WordCountTest.kt +++ b/common/src/desktopTest/kotlin/repositories/projectstatistics/WordCountTest.kt @@ -1,6 +1,7 @@ -package com.darkrockstudios.apps.hammer.base.markdown +package repositories.projectstatistics -import kotlin.test.Test +import com.darkrockstudios.apps.hammer.common.data.projectstatistics.countWords +import org.junit.jupiter.api.Test import kotlin.test.assertEquals class WordCountTest { @@ -45,38 +46,4 @@ class WordCountTest { fun `mixed whitespace runs collapse to single separator`() { assertEquals(3, countWords("one \t two\n\n three")) } - - @Test - fun `a non-breaking space separates words`() { - assertEquals(2, countWords("hello world")) - } - - @Test - fun `horizontal rule is not a word`() { - assertEquals(2, countWords("one\n\n---\n\ntwo")) - assertEquals(0, countWords("***")) - assertEquals(0, countWords("___")) - } - - @Test - fun `heading marker is not a word`() { - assertEquals(1, countWords("# Heading")) - } - - @Test - fun `bullet markers are not words`() { - assertEquals(2, countWords("- a\n- b")) - } - - @Test - fun `blockquote marker is not a word`() { - assertEquals(2, countWords("> quoted text")) - } - - @Test - fun `attached punctuation stays part of the word`() { - assertEquals(1, countWords("**bold**")) - assertEquals(1, countWords("don't")) - assertEquals(1, countWords("end.")) - } } diff --git a/common/src/desktopTest/kotlin/repositories/references/AutoConfirmReferencesUseCaseTest.kt b/common/src/desktopTest/kotlin/repositories/references/AutoConfirmReferencesUseCaseTest.kt index 282409995..45b47be91 100644 --- a/common/src/desktopTest/kotlin/repositories/references/AutoConfirmReferencesUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/repositories/references/AutoConfirmReferencesUseCaseTest.kt @@ -77,11 +77,11 @@ class AutoConfirmReferencesUseCaseTest : BaseTest() { } returns listOf(EntrySuggestion(entryId = 42, matchedAlias = "Bob")) val storedSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id, any()) } returns Unit + coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id) } returns Unit useCase(sceneItem) - coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), sceneItem.id, any()) } + coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), sceneItem.id) } assertEquals(setOf(42), storedSlot.captured.confirmedReferences) } @@ -96,7 +96,7 @@ class AutoConfirmReferencesUseCaseTest : BaseTest() { } returns listOf(EntrySuggestion(entryId = 42, matchedAlias = "Bob")) val storedSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id, any()) } returns Unit + coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id) } returns Unit useCase(sceneItem) @@ -114,7 +114,7 @@ class AutoConfirmReferencesUseCaseTest : BaseTest() { useCase(sceneItem) - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -128,7 +128,7 @@ class AutoConfirmReferencesUseCaseTest : BaseTest() { coVerify(exactly = 0) { referenceIndexService.computeAutoReferencesForScene(any(), any(), any()) } - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -145,7 +145,7 @@ class AutoConfirmReferencesUseCaseTest : BaseTest() { } returns listOf(EntrySuggestion(entryId = 42, matchedAlias = "Bob")) val storedSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id, any()) } returns Unit + coEvery { sceneEditor.storeMetadata(capture(storedSlot), sceneItem.id) } returns Unit useCase(sceneItem) diff --git a/common/src/desktopTest/kotlin/repositories/references/BackfillEntryReferencesUseCaseTest.kt b/common/src/desktopTest/kotlin/repositories/references/BackfillEntryReferencesUseCaseTest.kt index b2393827b..0a0f4ab33 100644 --- a/common/src/desktopTest/kotlin/repositories/references/BackfillEntryReferencesUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/repositories/references/BackfillEntryReferencesUseCaseTest.kt @@ -70,7 +70,7 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { val storedById = mutableMapOf() val metaSlot = slot() val idSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(metaSlot), capture(idSlot), any()) } answers { + coEvery { sceneEditor.storeMetadata(capture(metaSlot), capture(idSlot)) } answers { storedById[idSlot.captured] = metaSlot.captured } @@ -81,30 +81,6 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { assertEquals(setOf(7, 42), storedById[11]?.confirmedReferences) } - @Test - fun `Backfills entries of every type under the default config`() = runTest(mainTestDispatcher) { - for ((index, type) in EntryType.entries.withIndex()) { - val id = 100 + index - val name = "Entry$id" - val entry = EntryContent( - id = id, - name = name, - type = type, - text = "", - tags = emptySet(), - aliases = emptyList(), - ) - coEvery { referenceIndexService.findScenesMatchingEntry(id, listOf(name)) } returns listOf(10) - coEvery { sceneEditor.loadSceneMetadata(10) } returns SceneMetadata() - val metaSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(metaSlot), 10, any()) } just Runs - - useCase(entry) - - assertEquals(setOf(id), metaSlot.captured.confirmedReferences, "type $type was not backfilled") - } - } - @Test fun `Skips entry types that are not enabled in config`() = runTest(mainTestDispatcher) { // Config gates which entry types participate in matching. A type that is @@ -125,7 +101,7 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { makeUseCase(config).invoke(placeEntry) coVerify(exactly = 0) { referenceIndexService.findScenesMatchingEntry(any(), any()) } - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -137,7 +113,7 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { useCase(entry) - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -170,7 +146,7 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { useCase(entry) - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -184,6 +160,6 @@ class BackfillEntryReferencesUseCaseTest : BaseTest() { useCase(entry) - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } } diff --git a/common/src/desktopTest/kotlin/repositories/references/CleanupReferencesOnEntryDeleteUseCaseTest.kt b/common/src/desktopTest/kotlin/repositories/references/CleanupReferencesOnEntryDeleteUseCaseTest.kt index 9343194a7..6b5504be6 100644 --- a/common/src/desktopTest/kotlin/repositories/references/CleanupReferencesOnEntryDeleteUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/repositories/references/CleanupReferencesOnEntryDeleteUseCaseTest.kt @@ -55,7 +55,7 @@ class CleanupReferencesOnEntryDeleteUseCaseTest : BaseTest() { val written = mutableMapOf() val metaSlot = slot() val idSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(metaSlot), capture(idSlot), any()) } answers { + coEvery { sceneEditor.storeMetadata(capture(metaSlot), capture(idSlot)) } answers { written[idSlot.captured] = metaSlot.captured } @@ -77,7 +77,7 @@ class CleanupReferencesOnEntryDeleteUseCaseTest : BaseTest() { ) val metaSlot = slot() - coEvery { sceneEditor.storeMetadata(capture(metaSlot), 10, any()) } returns Unit + coEvery { sceneEditor.storeMetadata(capture(metaSlot), 10) } returns Unit useCase(42) @@ -95,7 +95,7 @@ class CleanupReferencesOnEntryDeleteUseCaseTest : BaseTest() { useCase(42) coVerify(exactly = 0) { sceneEditor.loadSceneMetadata(any()) } - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -110,7 +110,7 @@ class CleanupReferencesOnEntryDeleteUseCaseTest : BaseTest() { useCase(42) - coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any(), any()) } + coVerify(exactly = 0) { sceneEditor.storeMetadata(any(), any()) } } @Test @@ -125,8 +125,8 @@ class CleanupReferencesOnEntryDeleteUseCaseTest : BaseTest() { useCase(42) - coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 10, any()) } - coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 11, any()) } - coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 12, any()) } + coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 10) } + coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 11) } + coVerify(exactly = 1) { sceneEditor.storeMetadata(any(), 12) } } } diff --git a/common/src/desktopTest/kotlin/repositories/references/ReferenceIndexServiceTest.kt b/common/src/desktopTest/kotlin/repositories/references/ReferenceIndexServiceTest.kt index 3716c9b99..21d6f0b13 100644 --- a/common/src/desktopTest/kotlin/repositories/references/ReferenceIndexServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/references/ReferenceIndexServiceTest.kt @@ -136,9 +136,6 @@ class ReferenceIndexServiceTest : BaseTest() { private fun place(id: Int, name: String) = EntryContent(id = id, name = name, type = EntryType.PLACE, text = "", tags = emptySet()) - private fun entryOfType(id: Int, name: String, type: EntryType) = - EntryContent(id = id, name = name, type = type, text = "", tags = emptySet()) - @Test fun `recalculate builds inverted forward map from confirmed references`() = runTest(mainTestDispatcher) { stubSceneTree( @@ -271,24 +268,6 @@ class ReferenceIndexServiceTest : BaseTest() { assertEquals(1, suggestions[0].entryId) } - @Test - fun `computeAutoReferencesForScene matches every entry type under the default config`() = - runTest(mainTestDispatcher) { - val entries = EntryType.entries.mapIndexed { index, type -> - entryOfType(index + 1, "Entry${type.name}", type) - } - stubEntries(entries) - val service = makeService() - - val suggestions = service.computeAutoReferencesForScene( - sceneId = 10, - sceneText = entries.joinToString(" ") { it.name }, - metadata = SceneMetadata(), - ) - - assertEquals(entries.map { it.id }.toSet(), suggestions.map { it.entryId }.toSet()) - } - @Test fun `computeAutoReferencesForScene dedupes per entry on multiple hits`() = runTest(mainTestDispatcher) { stubEntries(listOf(person(1, "Bob"))) diff --git a/common/src/desktopTest/kotlin/repositories/references/WholeWordCaseSensitiveMatcherTest.kt b/common/src/desktopTest/kotlin/repositories/references/WholeWordCaseSensitiveMatcherTest.kt index bab9b10f2..de25962a0 100644 --- a/common/src/desktopTest/kotlin/repositories/references/WholeWordCaseSensitiveMatcherTest.kt +++ b/common/src/desktopTest/kotlin/repositories/references/WholeWordCaseSensitiveMatcherTest.kt @@ -114,90 +114,6 @@ class WholeWordCaseSensitiveMatcherTest { assertEquals("Mr. Smith", hits[0].matchedText) } - @Test - fun `Alias ending in punctuation matches`() { - val hits = matcher.findMatches("Smith Jr. arrived.", listOf(entry(1, "Smith Jr."))) - assertEquals(1, hits.size) - } - - @Test - fun `Accented letter after name blocks match`() { - val hits = matcher.findMatches("Anaïs and Anaé left.", listOf(entry(1, "Ana"))) - assertEquals(0, hits.size) - } - - @Test - fun `Accented letter before name blocks match`() { - val hits = matcher.findMatches("éBob and ñBob left.", listOf(entry(1, "Bob"))) - assertEquals(0, hits.size) - } - - @Test - fun `Name ending in accented letter matches whole word`() { - val hits = matcher.findMatches("Zoë smiled. Zoë's hat.", listOf(entry(1, "Zoë"))) - assertEquals(2, hits.size) - } - - @Test - fun `Name ending in accented letter does not match longer word`() { - val hits = matcher.findMatches("Zoëlle smiled.", listOf(entry(1, "Zoë"))) - assertEquals(0, hits.size) - } - - @Test - fun `Combining mark after name blocks match`() { - val hits = matcher.findMatches("Jose\u0301 arrived.", listOf(entry(1, "Jose"))) - assertEquals(0, hits.size) - } - - @Test - fun `Decomposed name matches decomposed text`() { - val hits = matcher.findMatches("Jose\u0301 arrived.", listOf(entry(1, "Jose\u0301"))) - assertEquals(1, hits.size) - } - - @Test - fun `Cyrillic name does not match inside longer word`() { - val hits = matcher.findMatches("Иванов пришёл.", listOf(entry(1, "Иван"))) - assertEquals(0, hits.size) - } - - @Test - fun `Cyrillic name matches whole word`() { - val hits = matcher.findMatches("Иван пришёл, и Иван ушёл.", listOf(entry(1, "Иван"))) - assertEquals(2, hits.size) - } - - @Test - fun `Greek name does not match inside longer word`() { - val hits = matcher.findMatches("Νίκοσα και αΝίκος", listOf(entry(1, "Νίκο"))) - assertEquals(0, hits.size) - } - - @Test - fun `Adjacent digits block match`() { - val hits = matcher.findMatches("Bob2 and 2Bob and Bob٣ left.", listOf(entry(1, "Bob"))) - assertEquals(0, hits.size) - } - - @Test - fun `Unicode punctuation and whitespace neighbors match`() { - val hits = matcher.findMatches( - "«Zoë» \u201cZoë\u201d Zoë\u00a0left ¿Zoë?", - listOf(entry(1, "Zoë")), - ) - assertEquals(4, hits.size) - } - - @Test - fun `Multi-token alias with accented letters matches whole word`() { - val hits = matcher.findMatches( - "Dr. Müller arrived. Dr. Müllers left.", - listOf(entry(1, "Dr. Müller")), - ) - assertEquals(1, hits.size) - } - @Test fun `Empty alias is skipped without crashing`() { val hits = matcher.findMatches("anything", listOf(entry(1, ""))) diff --git a/common/src/desktopTest/kotlin/repositories/scenedraft/SceneDraftNameTest.kt b/common/src/desktopTest/kotlin/repositories/scenedraft/SceneDraftNameTest.kt deleted file mode 100644 index 000d0529d..000000000 --- a/common/src/desktopTest/kotlin/repositories/scenedraft/SceneDraftNameTest.kt +++ /dev/null @@ -1,193 +0,0 @@ -package repositories.scenedraft - -import PROJECT_2_NAME -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.drafts.DraftDef -import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftRepository -import com.darkrockstudios.apps.hammer.common.data.drafts.SceneDraftsDatasource -import com.darkrockstudios.apps.hammer.common.data.id.IdAllocator -import com.darkrockstudios.apps.hammer.common.data.migrator.Migration2_3 -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneContentRepository -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import createProject -import getProjectDef -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNotNull -import kotlin.test.assertNull -import kotlin.test.assertTrue -import kotlin.time.Clock -import kotlin.time.Instant - -/** - * Covers the widened draft-name character set (data v3): what the repository accepts, what lands - * on disk, and that a name survives the round trip through the filename. - */ -class SceneDraftNameTest : BaseTest() { - - private val projectDef = getProjectDef(PROJECT_2_NAME) - - private lateinit var ffs: FakeFileSystem - private lateinit var datasource: SceneDraftsDatasource - private lateinit var sceneContentRepository: SceneContentRepository - private lateinit var idAllocator: IdAllocator - private lateinit var clock: Clock - - private val scene = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 1, - name = "Scene", - order = 0, - ) - - @BeforeEach - override fun setup() { - super.setup() - - sceneContentRepository = mockk() - idAllocator = mockk() - clock = mockk() - ffs = FakeFileSystem() - - setupKoin(module { - single { idAllocator } - single { clock } - }) - - createProject(ffs, PROJECT_2_NAME) - every { clock.now() } returns Instant.fromEpochSeconds(1_700_000_000) - coEvery { sceneContentRepository.getCurrentSceneContent(any()) } returns "content" - } - - private fun createRepository(nextId: Int = 900): SceneDraftRepository { - coEvery { idAllocator.claimNextId() } returns nextId - datasource = SceneDraftsDatasource(ffs, SceneDatasource(projectDef, ffs)) - return SceneDraftRepository(projectDef, sceneContentRepository, datasource, clock) - } - - @Test - fun `names with punctuation that used to be rejected are now accepted`() = runTest { - val names = listOf( - "Act 2, Take 3", - "Draft - final?", - "Editor's cut (v2)", - "Réécriture", - "Chapter 3: The Fall", - "Ready!", - ) - - names.forEachIndexed { index, name -> - val repo = createRepository(nextId = 900 + index) - assertNotNull(repo.saveDraft(scene, name), "'$name' should be a legal draft name") - } - } - - @Test - fun `the reserved filename delimiter is still rejected`() = runTest { - val repo = createRepository() - - assertNull(repo.saveDraft(scene, "bad~name")) - } - - @Test - fun `a blank name is still rejected`() = runTest { - val repo = createRepository() - - assertNull(repo.saveDraft(scene, " ")) - } - - @Test - fun `a name with OS-forbidden characters is stored under a safe filename and round-trips`() = - runTest { - val repo = createRepository() - val name = "Chapter 3: The Fall?" - - val def = repo.saveDraft(scene, name) - assertNotNull(def) - - val path = datasource.getDraftPath(def).toOkioPath() - assertTrue(ffs.exists(path)) - assertFalse(path.name.contains(':'), "Filename must not contain a forbidden char") - assertFalse(path.name.contains('?'), "Filename must not contain a forbidden char") - - assertEquals(name, repo.getDraftDef(def.id)?.draftName) - } - - @Test - fun `a draft stored under the legacy filename is still listed, loaded and deleted`() = runTest { - val repo = createRepository() - val draftsDir = datasource.getDraftsDirectory().toOkioPath() / "1" - ffs.createDirectories(draftsDir) - val legacyPath = draftsDir / "1-901-Old Draft-1729285670.md" - ffs.write(legacyPath) { writeUtf8("legacy content") } - - val def = repo.getDraftDef(901) - assertEquals( - DraftDef( - id = 901, - sceneId = 1, - draftTimestamp = Instant.fromEpochSeconds(1729285670), - draftName = "Old Draft", - ), - def, - ) - assertEquals("legacy content", repo.loadDraftContent(def!!)) - - assertTrue(repo.deleteDraft(901)) - assertFalse(ffs.exists(legacyPath), "The legacy file must actually be deleted") - } - - @Test - fun `a legacy draft whose name has a trailing space survives migration`() = runTest { - val repo = createRepository() - val draftsDir = datasource.getDraftsDirectory().toOkioPath() / "1" - ffs.createDirectories(draftsDir) - ffs.write(draftsDir / "1-902-My Draft -1729285670.md") { writeUtf8("legacy content") } - - Migration2_3(ffs).migrate(projectDef) - - val def = repo.getDraftDef(902) - assertNotNull(def) - assertEquals("My Draft", def.draftName, "The name must be canonicalised, not left padded") - assertEquals("legacy content", repo.loadDraftContent(def)) - - assertTrue(repo.deleteDraft(902)) - assertFalse( - ffs.list(draftsDir).any { it.name.contains("902") }, - "Delete must actually remove the file, not leave a ghost draft", - ) - } - - @Test - fun `a trailing space in a draft name is accepted and stored trimmed`() = runTest { - val repo = createRepository() - - val def = repo.saveDraft(scene, "My Draft ") - - assertNotNull(def) - assertEquals("My Draft", def.draftName) - assertTrue(ffs.exists(datasource.getDraftPath(def).toOkioPath())) - } - - @Test - fun `a new draft is written in the current filename format`() = runTest { - val repo = createRepository() - - val def = repo.saveDraft(scene, "Act 2, Take 3") - assertNotNull(def) - - val path = datasource.getDraftPath(def).toOkioPath() - assertEquals("1~900~Act 2, Take 3~1700000000.md", path.name) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneContentRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneContentRepositoryTest.kt index 9fe777d75..f753d22b3 100644 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneContentRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneContentRepositoryTest.kt @@ -305,149 +305,6 @@ class SceneContentRepositoryTest : BaseTest() { assertFalse(ffs.exists(temp2Path)) } - @Test - fun `Discard all dirty buffers`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - writeTempBuffer(3) - - service.initialize() - assertTrue(contentRepo.hasDirtyBuffers()) - - service.discardAllBuffers() - - assertFalse(contentRepo.hasDirtyBuffers()) - assertFalse(ffs.exists(getTempBufferPath(1))) - assertFalse(ffs.exists(getTempBufferPath(3))) - ffs.read(repo.getSceneFilePath(1).toOkioPath()) { - assertEquals("Content of scene id 1", readUtf8()) - } - } - - @Test - fun `Discard all drops the dirty buffer of an archived scene`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - writeTempBuffer(3) - - service.initialize() - assertTrue(service.archiveScene(SceneItem(projDef, SceneItem.Type.Scene, 1, "Scene ID 1", 0))) - assertTrue(contentRepo.hasDirtyBuffer(1)) - - service.discardAllBuffers() - - assertFalse(contentRepo.hasDirtyBuffers()) - assertNull(contentRepo.getSceneBuffer(1)) - assertFalse(ffs.exists(getTempBufferPath(1))) - assertFalse(ffs.exists(getTempBufferPath(3))) - } - - @Test - fun `Store all saves the dirty buffer of an archived scene into the archive`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - - service.initialize() - assertTrue(service.archiveScene(SceneItem(projDef, SceneItem.Type.Scene, 1, "Scene ID 1", 0))) - - service.storeAllBuffers() - - assertFalse(contentRepo.hasDirtyBuffers()) - assertFalse(ffs.exists(getTempBufferPath(1))) - val archivedPath = assertNotNull(repo.resolveScenePathFromFilesystemIncludingArchived(1)) - ffs.read(archivedPath.toOkioPath()) { - assertEquals(content(1), readUtf8()) - } - } - - @Test - fun `Store all drops the dirty buffer of a deleted scene`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - writeTempBuffer(3) - - service.initialize() - // Deleted behind the service's back, so the buffer outlives its scene. - assertTrue(repo.deleteScene(SceneItem(projDef, SceneItem.Type.Scene, 1, "Scene ID 1", 0))) - - service.storeAllBuffers() - - assertFalse(contentRepo.hasDirtyBuffers()) - assertFalse(ffs.exists(getTempBufferPath(1))) - ffs.read(repo.getSceneFilePath(3).toOkioPath()) { - assertEquals(content(3), readUtf8()) - } - } - - @Test - fun `Deleting a scene drops its unsaved buffer and temp file`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - writeTempBuffer(3) - - service.initialize() - assertTrue(service.deleteScene(SceneItem(projDef, SceneItem.Type.Scene, 1, "Scene ID 1", 0))) - - assertNull(contentRepo.getSceneBuffer(1)) - assertFalse(ffs.exists(getTempBufferPath(1))) - assertTrue(contentRepo.hasDirtyBuffer(3)) - assertTrue(ffs.exists(getTempBufferPath(3))) - } - - @Test - fun `Scope close keeps the temp file of an unsaved buffer`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - writeTempBuffer(3) - - service.initialize() - service.storeSceneBuffer(SceneItem(projDef, SceneItem.Type.Scene, 3, "Scene ID 3", 0)) - // A temp file whose buffer is clean, as a sync download leaves behind. - writeTempBuffer(3) - - contentRepo.onScopeClose(mockk()) - - ffs.read(getTempBufferPath(1)) { - assertEquals(content(1), readUtf8()) - } - assertFalse(ffs.exists(getTempBufferPath(3))) - } - - @Test - fun `Unsaved buffer survives a scope close and reopen`() = runTest(mainTestDispatcher) { - val projDef = getProject1Def() - createProject(ffs, PROJECT_1_NAME) - - createStack(projDef) - writeTempBuffer(1) - service.initialize() - contentRepo.onScopeClose(mockk()) - - createStack(projDef) - service.initialize() - - assertTrue(contentRepo.hasDirtyBuffer(1)) - assertEquals(content(1), contentRepo.getSceneBuffer(1)?.content?.markdown) - } - @Test fun `Store all dirty buffers`() = runTest(mainTestDispatcher) { val projDef = getProject1Def() diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneDatasourceCacheTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneDatasourceCacheTest.kt index 95f311235..7b68fd67f 100644 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneDatasourceCacheTest.kt +++ b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneDatasourceCacheTest.kt @@ -33,18 +33,11 @@ class SceneDatasourceCacheTest : BaseTest() { private class CountingFileSystem(delegate: FakeFileSystem) : ForwardingFileSystem(delegate) { var listRecursivelyCount = 0 private set - var listCount = 0 - private set override fun listRecursively(dir: Path, followSymlinks: Boolean): Sequence { listRecursivelyCount++ return super.listRecursively(dir, followSymlinks) } - - override fun list(dir: Path): List { - listCount++ - return super.list(dir) - } } @BeforeEach @@ -133,7 +126,7 @@ class SceneDatasourceCacheTest : BaseTest() { } @Test - fun `moveScene keeps the cache in step`() = runTest { + fun `moveScene invalidates the cache`() = runTest { val sourceId = 1 val sourcePath = sceneDatasource.resolveScenePathFromFilesystem(sourceId) assertNotNull(sourcePath) @@ -147,80 +140,5 @@ class SceneDatasourceCacheTest : BaseTest() { val paths = sceneDatasource.getAllScenePaths().map { it.toOkioPath() } assertTrue(paths.contains(targetPath.toOkioPath()), "Moved-to path must be present") assertTrue(!paths.contains(sourcePath.toOkioPath()), "Moved-from path must be gone") - assertEquals( - targetPath.toOkioPath(), - sceneDatasource.resolveScenePathFromFilesystem(sourceId)?.toOkioPath(), - "Moved scene must resolve to its new path", - ) - } - - @Test - fun `moving a scene to a new id re-indexes it`() = runTest { - // reIdScene moves a scene to a filename carrying a different id; the cached id index has to - // retire the old id rather than keep pointing it at the moved file. - val oldId = 1 - val newId = 997 - val sourcePath = sceneDatasource.resolveScenePathFromFilesystem(oldId) - assertNotNull(sourcePath) - - val targetPath = sourcePath.toOkioPath().parent!! - .div("1~Re-IDed~$newId.md").toHPath() - sceneDatasource.moveScene(sourcePath, targetPath) - - assertEquals( - targetPath.toOkioPath(), - sceneDatasource.resolveScenePathFromFilesystem(newId)?.toOkioPath(), - "Scene must resolve under its new id", - ) - assertEquals( - null, - sceneDatasource.resolveScenePathFromFilesystem(oldId), - "The retired id must no longer resolve", - ) - } - - @Test - fun `moving one of two files sharing a scene id keeps the winner resolvable`() = runTest { - // Duplicate ids on disk are tolerated, and the id resolves to the name-first of them. An - // incremental cache update cannot maintain that, so a move must fall back to a re-scan. - val sharedId = 1 - val winner = sceneDatasource.resolveScenePathFromFilesystem(sharedId) - assertNotNull(winner) - val loser = sceneDatasource.getSceneDirectory().toOkioPath() - .div("9~Duplicate~$sharedId.md").toHPath() - sceneDatasource.createNewGroup(loser) - assertEquals( - winner.toOkioPath(), - sceneDatasource.resolveScenePathFromFilesystem(sharedId)?.toOkioPath(), - "The name-first path owns the id", - ) - - val renamedLoser = sceneDatasource.getSceneDirectory().toOkioPath() - .div("09~Duplicate~$sharedId.md").toHPath() - sceneDatasource.moveScene(loser, renamedLoser) - - assertEquals( - winner.toOkioPath(), - sceneDatasource.resolveScenePathFromFilesystem(sharedId)?.toOkioPath(), - "Moving the duplicate must not steal the id from the winner", - ) - } - - @Test - fun `countScenes stays correct without re-listing the directory`() = runTest { - val sceneDir = sceneDatasource.getSceneDirectory() - val before = sceneDatasource.countScenes(sceneDir) - val listsBefore = countingFs.listCount - - val newId = 998 - val newPath = sceneDir.toOkioPath().div("6~Counted~$newId.md").toHPath() - sceneDatasource.createNewGroup(newPath) - - assertEquals(before + 1, sceneDatasource.countScenes(sceneDir), "New scene must be counted") - assertEquals( - listsBefore, - countingFs.listCount, - "Counting children must come from the cached scan, not a fresh directory listing", - ) } } diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneEditorServiceTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneEditorServiceTest.kt index eb02cbf38..c98b624c6 100644 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneEditorServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneEditorServiceTest.kt @@ -375,23 +375,6 @@ class SceneEditorServiceTest : BaseTest() { assertFalse(service.hasDirtyBuffers()) } - @Test - fun `Discard-all-buffers reverts every dirty buffer`() = runTest(mainTestDispatcher) { - val service = initializedService() - val sceneOne = service.getSceneItemFromId(1)!! - val sceneThree = service.getSceneItemFromId(3)!! - - service.onContentChanged(SceneContent(sceneOne, "Unsaved 1"), UpdateSource.Editor) - service.onContentChanged(SceneContent(sceneThree, "Unsaved 3"), UpdateSource.Editor) - advanceUntilIdle() - assertTrue(service.hasDirtyBuffers()) - - service.discardAllBuffers() - - assertFalse(service.hasDirtyBuffers()) - assertEquals("Content of scene id 3", service.getSceneBuffer(sceneThree)?.content?.markdown) - } - @Test fun `Discard scene buffer reverts to on-disk content`() = runTest(mainTestDispatcher) { val service = initializedService() @@ -483,7 +466,7 @@ class SceneEditorServiceTest : BaseTest() { val updated = service.loadSceneMetadata(sceneId).copy(notes = "flow notes") // metadataUpdateFlow has no replay, so subscribe before storing. - val received = mutableListOf() + val received = mutableListOf>() val job = scope.launch { service.metadataUpdateFlow.collect { received.add(it) } } advanceUntilIdle() @@ -491,7 +474,7 @@ class SceneEditorServiceTest : BaseTest() { advanceUntilIdle() job.cancelAndJoin() - assertTrue(received.any { it.sceneId == sceneId && it.metadata.notes == "flow notes" }) + assertTrue(received.any { it.first == sceneId && it.second.notes == "flow notes" }) } // endregion diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderPaddingWidthTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderPaddingWidthTest.kt deleted file mode 100644 index 620ee6280..000000000 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderPaddingWidthTest.kt +++ /dev/null @@ -1,165 +0,0 @@ -package repositories.sceneeditor - -import com.darkrockstudios.apps.hammer.common.data.InsertPosition -import com.darkrockstudios.apps.hammer.common.data.MoveRequest -import com.darkrockstudios.apps.hammer.common.data.SceneContent -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.random.Random -import kotlin.test.assertEquals - -/** - * Scene content is read and written through a path built from the tree, so a name the tree - * derives differently than the one on disk silently retargets every content operation: reads - * land on nothing and come back empty, writes create a rival file. - * - * Order numbers are a contiguous 0-based sequence, so the zero-padded order field must be as - * wide as the highest order, not as wide as the child count. Those two disagree at every power - * of ten, which left a directory of exactly ten children unreadable. - */ -class SceneOrderPaddingWidthTest : SceneRepositoryTestBase() { - - /** Scenes whose computed content path points at a file that is not there. */ - private fun unreadableScenes(): List = repo.getSceneTree() - .filter { !it.value.isRootScene } - .filter { !ffs.exists(repo.resolveSceneContentPath(it.value).toOkioPath()) } - .map { "id=${it.value.id} '${it.value.name}'" } - - private fun computedPathsMissingOnDisk(): List = repo.getSceneTree() - .filter { !it.value.isRootScene } - .filter { !ffs.exists(repo.getSceneFilePath(it.value.id).toOkioPath()) } - .map { "id=${it.value.id} '${it.value.name}'" } - - @Test - fun `every scene stays readable at each child count across a padding boundary`() = runBlocking { - // Project 1's Group 2 ships with 3 children; grow it one at a time well past ten. - val group = repo.getSceneItemFromId(2) ?: error("group 2 missing") - - val unreadableAtCount = mutableMapOf>() - repeat(10) { i -> - repo.createScene(group, "Added $i") - val childCount = 4 + i - val unreadable = computedPathsMissingOnDisk() - if (unreadable.isNotEmpty()) unreadableAtCount[childCount] = unreadable - } - - assertEquals(emptyMap(), unreadableAtCount, "child counts whose scenes became unreadable") - } - - @Test - fun `a group of exactly ten children keeps its content`() = runBlocking { - val group = repo.getSceneItemFromId(2) ?: error("group 2 missing") - repeat(7) { repo.createScene(group, "Added $it") } - - // Ten children is the count where the order width and the child width disagree. - val groupDir = sceneDatasource.resolveScenePathFromFilesystem(2)!!.toOkioPath() - assertEquals(10, ffs.list(groupDir).size, "group should hold exactly ten children") - - repo.getSceneTree() - .filter { it.value.type == SceneItem.Type.Scene } - .forEach { node -> - val path = sceneDatasource.resolveScenePathFromFilesystem(node.value.id)!! - ffs.write(path.toOkioPath()) { writeUtf8("content of ${node.value.id}") } - } - - val readBack = repo.getSceneTree() - .filter { it.value.type == SceneItem.Type.Scene } - .associate { it.value.id to repo.loadSceneMarkdownRaw(it.value) } - - val empty = readBack.filterValues { it.isBlank() }.keys - assertEquals(emptySet(), empty, "scenes that read back empty") - } - - @Test - fun `saving into a group of ten children does not create a rival file`() = runBlocking { - val group = repo.getSceneItemFromId(2) ?: error("group 2 missing") - repeat(7) { repo.createScene(group, "Added $it") } - - val groupDir = sceneDatasource.resolveScenePathFromFilesystem(2)!!.toOkioPath() - val before = ffs.list(groupDir).size - - val scene = repo.getSceneItemFromId(3) ?: error("scene 3 missing") - repo.storeSceneMarkdownRaw(SceneContent(scene, "newly written prose")) - - assertEquals(before, ffs.list(groupDir).size, "a save must overwrite, never add a file") - assertEquals("newly written prose", repo.loadSceneMarkdownRaw(scene)) - } - - @Test - fun `rationalizeTree and a reload resolve a duplicate id to the same file`() = runBlocking { - val group = repo.getSceneItemFromId(2) ?: error("group 2 missing") - repeat(7) { repo.createScene(group, "Added $it") } - - val groupDir = sceneDatasource.resolveScenePathFromFilesystem(2)!!.toOkioPath() - val realPath = sceneDatasource.resolveScenePathFromFilesystem(3)!!.toOkioPath() - ffs.write(realPath) { writeUtf8("the copy the tree was loaded from") } - - // A second file claiming scene 3, of the shape a mis-padded save used to leave behind. - ffs.write(groupDir.div("0${realPath.name}")) { writeUtf8("a rival copy") } - - // Both the sync pass and a fresh load must settle on the name-first path. The reload goes - // through a new datasource, the way relaunching the app rebuilds the index from disk. - val reloaded = SceneDatasource(projectDef, ffs) - val reloadResolved = reloaded.resolveScenePathFromFilesystem(3)!!.toOkioPath().name - val fromDir = reloaded.getGroupChildPathsById(groupDir.toHPath())[3]!! - .toOkioPath().name - - assertEquals(reloadResolved, fromDir, "every id lookup must agree on which file owns the id") - } - - @Test - fun `computed paths survive random editing sessions`() = runBlocking { - val rng = Random(20260815) - - repeat(400) { - val tree = repo.getSceneTree() - val all = tree.filter { !it.value.isRootScene } - val groups = tree.filter { it.value.type == SceneItem.Type.Group || it.value.isRootScene } - val scenes = all.filter { it.value.type == SceneItem.Type.Scene } - - when (rng.nextInt(10)) { - in 0..3 -> { - val target = groups.random(rng) - repo.createScene(if (target.value.isRootScene) null else target.value, "S$it") - } - - 4 -> { - val target = groups.random(rng) - repo.createGroup(if (target.value.isRootScene) null else target.value, "G$it") - } - - in 5..6 -> { - if (scenes.isNotEmpty()) repo.deleteScene(scenes.random(rng).value) - } - - else -> { - if (all.size >= 2) { - val mover = all.random(rng) - val candidates = all.filter { target -> - target.value.id != mover.value.id && - !tree.isAncestorOf(mover.index, target.index) - } - if (candidates.isNotEmpty()) { - val target = candidates.random(rng) - repo.moveScene( - MoveRequest( - id = mover.value.id, - toPosition = InsertPosition( - coords = tree.getCoordinatesFor(target), - before = rng.nextBoolean(), - ), - ) - ) - } - } - } - } - - assertEquals(emptyList(), unreadableScenes(), "unreadable after step $it") - } - } -} diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderRescanTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderRescanTest.kt deleted file mode 100644 index adf2760d7..000000000 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneOrderRescanTest.kt +++ /dev/null @@ -1,111 +0,0 @@ -package repositories.sceneeditor - -import PROJECT_1_NAME -import com.darkrockstudios.apps.hammer.common.data.id.IdAllocator -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncJournal -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import createProject -import getProjectDef -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import okio.ForwardingFileSystem -import okio.Path -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertTrue -import kotlin.time.Clock - -/** - * Re-padding a directory's order digits renames every sibling in turn. Each rename drops the path - * cache, so the loop stays linear only while it reads nothing from that cache between renames. This - * pins that: put a cache read back inside the loop and the scan count grows with the sibling count. - */ -class SceneOrderRescanTest : BaseTest() { - - private lateinit var ffs: FakeFileSystem - private lateinit var countingFs: CountingFileSystem - private lateinit var repository: SceneRepository - - private class CountingFileSystem(delegate: FakeFileSystem) : ForwardingFileSystem(delegate) { - var listRecursivelyCount = 0 - private set - - override fun listRecursively(dir: Path, followSymlinks: Boolean): Sequence { - listRecursivelyCount++ - return super.listRecursively(dir, followSymlinks) - } - } - - @BeforeEach - override fun setup() { - super.setup() - ffs = FakeFileSystem() - createProject(ffs, PROJECT_1_NAME) - countingFs = CountingFileSystem(ffs) - - val projectDef = getProjectDef(PROJECT_1_NAME) - val toml = createTomlSerializer() - val syncJournal: SyncJournal = mockk(relaxed = true) - every { syncJournal.isServerSynchronized() } returns false - val idAllocator: IdAllocator = mockk(relaxed = true) - coEvery { idAllocator.claimNextId() } returnsMany (100..400).toList() - - val datasource = SceneDatasource(projectDef, countingFs) - repository = SceneRepository( - projectDef = projectDef, - syncJournal = syncJournal, - idAllocator = idAllocator, - sceneMetadataDatasource = SceneMetadataDatasource(countingFs, toml, projectDef), - sceneDatasource = datasource, - clock = Clock.System, - ) - } - - @AfterEach - override fun tearDown() { - super.tearDown() - ffs.checkNoOpenFiles() - } - - @Test - fun `crossing the order-digit boundary does not re-scan once per renamed sibling`() = runTest { - repository.initializeSceneEditor() - - // Ten siblings means the next order is 10, which widens the field and re-pads all of them. - while (repository.rawTree.root().numChildrenImmedate() < 10) { - assertNotNull(repository.createScene(parent = null, sceneName = "Filler")) - } - val siblingsBefore = repository.rawTree.root().numChildrenImmedate() - val scansBefore = countingFs.listRecursivelyCount - - // This create takes the order to 10, re-padding every existing sibling to two digits. - assertNotNull(repository.createScene(parent = null, sceneName = "Boundary")) - - val scansForRepad = countingFs.listRecursivelyCount - scansBefore - assertTrue( - scansForRepad < siblingsBefore, - "Re-padding $siblingsBefore siblings took $scansForRepad scans; it must not scale with them", - ) - - // The renames still have to land correctly. - assertEquals( - siblingsBefore + 1, - repository.rawTree.root().numChildrenImmedate(), - "Every sibling survives the re-pad", - ) - assertTrue( - repository.getScenes().all { repository.resolveScenePathFromFilesystem(it.id) != null }, - "Every scene in the project resolves at its new name", - ) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/ScenePathIndexTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/ScenePathIndexTest.kt deleted file mode 100644 index a285d3774..000000000 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/ScenePathIndexTest.kt +++ /dev/null @@ -1,73 +0,0 @@ -package repositories.sceneeditor - -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.ScenePathIndex -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import okio.Path.Companion.toPath -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -/** - * Covers the two answers the index gives that its callers cannot check for themselves: which of two - * files claiming one scene id owns it, and whether a directory is empty or simply unseen. The rest - * of its behaviour is covered through the datasource in [SceneDatasourceCacheTest]. - */ -class ScenePathIndexTest { - - private val sceneDir = "/proj/.scenes".toPath() - - private fun scenePath(name: String): HPath = sceneDir.div(name).toHPath() - - @Test - fun `the name-first file owns a shared scene id`() { - val incumbent = scenePath("1~Alpha~5.md") - val index = ScenePathIndex { listOf(incumbent) } - index.paths() - - // A later arrival sorting before the incumbent takes the id; one sorting after does not. - index.onCreated(scenePath("0~Aardvark~5.md")) - assertEquals( - scenePath("0~Aardvark~5.md").toOkioPath(), - index.pathFor(5)?.toOkioPath(), - "The name-first duplicate owns the id", - ) - - index.onCreated(scenePath("9~Omega~5.md")) - assertEquals( - scenePath("0~Aardvark~5.md").toOkioPath(), - index.pathFor(5)?.toOkioPath(), - "A later-sorting duplicate does not take it", - ) - } - - @Test - fun `an unseen directory reports unknown rather than empty`() { - // countScenePathsIn reads the disk for these, because order numbers derive from the count - // and treating an unseen directory as empty would mis-number a real one. - val index = ScenePathIndex { listOf(scenePath("1~One~1.md")) } - index.paths() - - assertEquals(1, index.childCountOrNull(sceneDir.toHPath()), "A scanned directory is counted") - assertNull(index.childCountOrNull(scenePath("7~Unseen~7")), "An unseen one is unknown") - } - - @Test - fun `a created file is absorbed without re-scanning`() { - var scans = 0 - val existing = scenePath("1~One~1.md") - val index = ScenePathIndex { scans++; listOf(existing) } - index.paths() - index.pathFor(1) - index.childCountOrNull(sceneDir.toHPath()) - val scansBefore = scans - - index.onCreated(scenePath("2~Two~2.md")) - - assertEquals(2, index.paths().size, "The new file is listed") - assertEquals(scenePath("2~Two~2.md").toOkioPath(), index.pathFor(2)?.toOkioPath()) - assertEquals(2, index.childCountOrNull(sceneDir.toHPath()), "It is counted in its directory") - assertEquals(scansBefore, scans, "Creating a file must not cost a re-scan") - } -} diff --git a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneRepositoryRationalizeTreePaddingTest.kt b/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneRepositoryRationalizeTreePaddingTest.kt deleted file mode 100644 index da45a0dbd..000000000 --- a/common/src/desktopTest/kotlin/repositories/sceneeditor/SceneRepositoryRationalizeTreePaddingTest.kt +++ /dev/null @@ -1,127 +0,0 @@ -package repositories.sceneeditor - -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneDatasource -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import kotlinx.coroutines.runBlocking -import okio.Path -import org.junit.jupiter.api.Test -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -/** - * A sync that nests items can drop a directory's child count across a digit boundary - * (10 -> 9), changing the zero-padding width of every sibling's order number. The whole - * rationalize pass must agree on one padding width even though moves mutate the disk - * mid-pass. Reproduces GitHub-reported sync failure at the 9/10 boundary. - */ -class SceneRepositoryRationalizeTreePaddingTest : SceneRepositoryTestBase() { - - private fun writeScene(dir: Path, name: String) { - ffs.write(dir.div(name)) { writeUtf8("test content") } - } - - @Test - fun `Rationalize tree when root falls below 10 items mid-pass`() = runBlocking { - // 11 root items on disk: two-digit order padding - val scenesDir = projectPath.toOkioPath().div(SceneDatasource.SCENE_DIRECTORY) - ffs.deleteRecursively(scenesDir) - ffs.createDirectories(scenesDir) - - for (i in 0..5) { - writeScene(scenesDir, "0$i~Scene ${i + 1}~${i + 1}.md") - } - ffs.createDirectory(scenesDir.div("06~First Book~9")) - ffs.createDirectory(scenesDir.div("07~Beauty and the Beast~14")) - writeScene(scenesDir, "08~Dangerous Wish~10.md") - writeScene(scenesDir, "09~Scene D~13.md") - writeScene(scenesDir, "10~Scene E~11.md") - - sceneDatasource = SceneDatasource(projectDef, ffs) - repo = createRepository() - repo.initializeSceneEditor() - - // Simulate downloaded server entities: group 14 nests under group 9, - // scenes 10 and 13 nest under group 14. Root falls from 11 items to 8. - val tree = repo.rawTree - val root = tree.root() - val group9 = tree.find { it.id == 9 } - val group14 = tree.find { it.id == 14 } - val scene10 = tree.find { it.id == 10 } - val scene13 = tree.find { it.id == 13 } - val scene11 = tree.find { it.id == 11 } - - root.removeChild(group14) - root.removeChild(scene10) - root.removeChild(scene13) - group9.addChild(group14) - group14.addChild(scene10) - group14.addChild(scene13) - - group14.value = group14.value.copy(order = 0) - scene10.value = scene10.value.copy(order = 0) - scene13.value = scene13.value.copy(order = 1) - scene11.value = scene11.value.copy(order = 7) - - repo.rationalizeTree() - - // Root now has 8 children, so every root-level name uses single-digit padding - val group9Dir = scenesDir.div("6~First Book~9") - val group14Dir = group9Dir.div("0~Beauty and the Beast~14") - assertTrue(ffs.exists(group9Dir)) - assertTrue(ffs.exists(group14Dir)) - assertTrue(ffs.exists(group14Dir.div("0~Dangerous Wish~10.md"))) - assertTrue(ffs.exists(group14Dir.div("1~Scene D~13.md"))) - assertTrue(ffs.exists(scenesDir.div("7~Scene E~11.md"))) - for (i in 0..5) { - assertTrue(ffs.exists(scenesDir.div("$i~Scene ${i + 1}~${i + 1}.md"))) - } - assertFalse(ffs.exists(scenesDir.div("06~First Book~9"))) - - // Disk and computed paths must agree for every scene after the pass - tree.forEach { node -> - if (node.value.isRootScene) return@forEach - assertTrue( - ffs.exists(repo.getSceneFilePath(node.value.id).toOkioPath()), - "Scene ${node.value.id} not found at its computed path" - ) - } - } - - @Test - fun `Rationalize tree pads from disk-present children when a tree child is missing on disk`() = runBlocking { - // 9 scenes on disk: single-digit order padding - val scenesDir = projectPath.toOkioPath().div(SceneDatasource.SCENE_DIRECTORY) - ffs.deleteRecursively(scenesDir) - ffs.createDirectories(scenesDir) - - for (i in 0..8) { - writeScene(scenesDir, "$i~Scene ${i + 1}~${i + 1}.md") - } - - sceneDatasource = SceneDatasource(projectDef, ffs) - repo = createRepository() - repo.initializeSceneEditor() - - // A 10th tree child with no file on disk (e.g. a failed download) must not push - // padding to two digits, or computed paths diverge from disk afterwards - val tree = repo.rawTree - val phantom = SceneItem(projectDef, SceneItem.Type.Scene, 99, "Phantom", 9) - tree.root().addChild(TreeNode(phantom)) - - repo.rationalizeTree() - - for (i in 0..8) { - val path = scenesDir.div("$i~Scene ${i + 1}~${i + 1}.md") - assertTrue(ffs.exists(path), "Scene file unexpectedly renamed: $path") - } - tree.forEach { node -> - if (node.value.isRootScene || node.value.id == phantom.id) return@forEach - assertTrue( - ffs.exists(repo.getSceneFilePath(node.value.id).toOkioPath()), - "Scene ${node.value.id} not found at its computed path" - ) - } - } -} diff --git a/common/src/desktopTest/kotlin/repositories/spellcheck/LanguageMatchingTest.kt b/common/src/desktopTest/kotlin/repositories/spellcheck/LanguageMatchingTest.kt deleted file mode 100644 index c6eb7b6ab..000000000 --- a/common/src/desktopTest/kotlin/repositories/spellcheck/LanguageMatchingTest.kt +++ /dev/null @@ -1,70 +0,0 @@ -package repositories.spellcheck - -import com.darkrockstudios.apps.hammer.common.spellcheck.isSpellCheckAllowedForProject -import com.darkrockstudios.apps.hammer.common.spellcheck.localesMatchLeniently -import com.darkrockstudios.apps.hammer.common.util.Locale -import org.junit.jupiter.api.Test -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class LanguageMatchingTest { - - private fun locale(tag: String) = Locale.forLanguageTag(tag) - - @Test - fun `same language without regions matches`() { - assertTrue(localesMatchLeniently(locale("en"), locale("en"))) - } - - @Test - fun `region-less side matches any region of the same language`() { - assertTrue(localesMatchLeniently(locale("en"), locale("en-US"))) - assertTrue(localesMatchLeniently(locale("en-US"), locale("en"))) - } - - @Test - fun `matching language and region match`() { - assertTrue(localesMatchLeniently(locale("pt-BR"), locale("pt-BR"))) - } - - @Test - fun `differing regions of the same language do not match`() { - assertFalse(localesMatchLeniently(locale("en-US"), locale("en-GB"))) - } - - @Test - fun `different languages do not match`() { - assertFalse(localesMatchLeniently(locale("fr"), locale("en"))) - assertFalse(localesMatchLeniently(locale("fr-FR"), locale("en-US"))) - } - - @Test - fun `language-less locales never match`() { - assertFalse(localesMatchLeniently(Locale.root, Locale.root)) - assertFalse(localesMatchLeniently(Locale.root, locale("en"))) - } - - @Test - fun `matching is case-insensitive via tag normalization`() { - assertTrue(localesMatchLeniently(locale("EN-us"), locale("en-US"))) - } - - @Test - fun `unset project language always allows spell check`() { - assertTrue(isSpellCheckAllowedForProject(null, locale("en-US"))) - assertTrue(isSpellCheckAllowedForProject("", locale("en-US"))) - assertTrue(isSpellCheckAllowedForProject(" ", locale("en-US"))) - } - - @Test - fun `matching project language allows spell check`() { - assertTrue(isSpellCheckAllowedForProject("en", locale("en-US"))) - assertTrue(isSpellCheckAllowedForProject("en-US", locale("en-US"))) - } - - @Test - fun `mismatched project language blocks spell check`() { - assertFalse(isSpellCheckAllowedForProject("fr", locale("en-US"))) - assertFalse(isSpellCheckAllowedForProject("en-GB", locale("en-US"))) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectDictionaryServiceTest.kt b/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectDictionaryServiceTest.kt deleted file mode 100644 index e6f95e617..000000000 --- a/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectDictionaryServiceTest.kt +++ /dev/null @@ -1,371 +0,0 @@ -package repositories.spellcheck - -import PROJECT_EMPTY_NAME -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.GlobalSettingsDatasource -import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.ServerSettingsDatasource -import com.darkrockstudios.apps.hammer.common.data.id.IdAllocator -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncDataDatasource -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncJournal -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.fileio.ExternalFileIo -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectDictionaryService -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository -import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository -import com.darkrockstudios.apps.hammer.common.util.Locale -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory -import createProject -import getProjectDef -import io.mockk.coEvery -import io.mockk.every -import io.mockk.just -import io.mockk.clearMocks -import io.mockk.coVerify -import io.mockk.mockk -import io.mockk.spyk -import io.mockk.Runs -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.test.advanceUntilIdle -import kotlinx.coroutines.test.runTest -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -/** - * Classical-style: a real [ProjectDictionaryService] over a real [EncyclopediaRepository], - * [ProjectDataRepository], [GlobalSettingsStore] and [SpellCheckRepository] (FakeFileSystem-backed). - * Only the platform spell checker factory and settings/sync persistence are mocked. - */ -@OptIn(ExperimentalCoroutinesApi::class) -class ProjectDictionaryServiceTest : BaseTest() { - - private val projectDef = getProjectDef(PROJECT_EMPTY_NAME) - - private lateinit var globalSettingsDatasource: GlobalSettingsDatasource - private lateinit var serverSettingsDatasource: ServerSettingsDatasource - private lateinit var factory: PlatformSpellCheckerFactory - private lateinit var fileSystem: FakeFileSystem - private lateinit var idAllocator: IdAllocator - private lateinit var syncJournal: SyncJournal - private lateinit var encyclopediaRepository: EncyclopediaRepository - private lateinit var projectDataRepository: ProjectDataRepository - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var spellCheckRepository: SpellCheckRepository - - /** Words applied per created checker, in creation order. Empty set = checker created with no session words. */ - private val appliedPerChecker = mutableListOf>() - - private var nextId = 1 - - @BeforeEach - override fun setup() { - super.setup() - globalSettingsDatasource = mockk() - serverSettingsDatasource = mockk() - factory = mockk() - idAllocator = mockk() - syncJournal = mockk() - appliedPerChecker.clear() - nextId = 1 - - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } answers { - val index = appliedPerChecker.size - appliedPerChecker.add(emptySet()) - val checker = mockk() - coEvery { checker.isWordCorrect(any()) } returns false - coEvery { checker.setUserDictionary(any()) } answers { - appliedPerChecker[index] = firstArg>().toSet() - } - checker - } - coEvery { globalSettingsDatasource.loadSettings() } returns GlobalSettings( - projectsDirectory = "/projects", - spellCheckSettings = SpellCheckerSettings( - enabled = true, - locale = Locale.forLanguageTag("en"), - ), - ) - coEvery { globalSettingsDatasource.storeSettings(any()) } just Runs - coEvery { serverSettingsDatasource.loadServerSettings(any()) } returns null - every { syncJournal.isServerSynchronized() } returns false - coEvery { idAllocator.claimNextId() } answers { nextId++ } - - val syncDataDatasource = mockk(relaxed = true) - setupKoin(module { - scope { - scoped { projectDef } - scoped { syncDataDatasource } - } - }) - - fileSystem = FakeFileSystem() - createProject(fileSystem, PROJECT_EMPTY_NAME) - - val toml = createTomlSerializer() - encyclopediaRepository = spyk( - EncyclopediaRepository( - projectDef = projectDef, - idAllocator = idAllocator, - datasource = EncyclopediaDatasource( - projectDef = projectDef, - toml = toml, - fileSystem = fileSystem, - externalFileIo = mockk(), - ), - syncJournal = syncJournal, - ) - ) - projectDataRepository = ProjectDataRepository( - ProjectDataDatasource(fileSystem, toml, projectDef), - projectDef, - ) - globalSettingsStore = GlobalSettingsStore(globalSettingsDatasource, serverSettingsDatasource) - spellCheckRepository = SpellCheckRepository(globalSettingsStore, factory) - } - - private fun createService() = ProjectDictionaryService( - projectDef = projectDef, - encyclopediaRepository = encyclopediaRepository, - projectSpellCheckRepository = ProjectSpellCheckRepository( - spellCheckRepository = spellCheckRepository, - globalSettingsStore = globalSettingsStore, - projectDataRepository = projectDataRepository, - projectDef = projectDef, - ), - spellCheckRepository = spellCheckRepository, - ).also { it.initialize() } - - private suspend fun createEntry( - name: String, - type: EntryType = EntryType.PERSON, - aliases: List = emptyList(), - excludeFromDictionary: Boolean = false, - ) { - encyclopediaRepository.createEntry( - name = name, - type = type, - text = "text", - tags = emptySet(), - imagePath = null, - aliases = aliases, - excludeFromDictionary = excludeFromDictionary, - ) - } - - @Test - fun `entry names and aliases of all types are tokenized and pushed on start`() = scope.runTest { - createEntry("Zaltharion", type = EntryType.PERSON, aliases = listOf("Mr. Zal")) - createEntry("Kastle Rock", type = EntryType.PLACE) - createEntry("Vorpal Sword", type = EntryType.THING) - createEntry("The Sundering", type = EntryType.EVENT) - createEntry("Weirding", type = EntryType.IDEA) - - createService() - advanceUntilIdle() - - assertEquals( - setOf( - "zaltharion", "mr", "zal", - "kastle", "rock", - "vorpal", "sword", - "the", "sundering", - "weirding", - ), - appliedPerChecker.last(), - ) - } - - @Test - fun `entry changes after start push an updated word set`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - - createEntry("Kastle") - advanceUntilIdle() - - assertEquals(setOf("zaltharion", "kastle"), appliedPerChecker.last()) - } - - @Test - fun `text-only entry edits do not recreate the checker`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - val checkersAfterStart = appliedPerChecker.size - - val def = encyclopediaRepository.ensureEntriesLoaded().single() - encyclopediaRepository.updateEntry( - oldEntryDef = def, - name = def.name, - text = "new text", - tags = emptySet(), - excludeFromDictionary = false, - ) - advanceUntilIdle() - - assertEquals(checkersAfterStart, appliedPerChecker.size) - } - - @Test - fun `disabling the global setting clears the words and re-enabling restores them`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - - globalSettingsStore.updateSettings { - it.copy(spellCheckSettings = it.spellCheckSettings.copy(includeEncyclopediaNames = false)) - } - advanceUntilIdle() - assertEquals(emptySet(), appliedPerChecker.last()) - - globalSettingsStore.updateSettings { - it.copy(spellCheckSettings = it.spellCheckSettings.copy(includeEncyclopediaNames = true)) - } - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - } - - @Test - fun `disabling spell check entirely clears the words and re-enable restores them`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - - globalSettingsStore.updateSettings { - it.copy(spellCheckSettings = it.spellCheckSettings.copy(enabled = false)) - } - advanceUntilIdle() - - globalSettingsStore.updateSettings { - it.copy(spellCheckSettings = it.spellCheckSettings.copy(enabled = true)) - } - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - } - - @Test - fun `disabling the per-project setting clears the words`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - - projectDataRepository.updateData { it.copy(encyclopediaDictionary = false) } - advanceUntilIdle() - - assertEquals(emptySet(), appliedPerChecker.last()) - } - - @Test - fun `an excluded entry contributes no words`() = scope.runTest { - createEntry("Zaltharion") - createEntry("Secretname", excludeFromDictionary = true, aliases = listOf("Hiddenalias")) - - createService() - advanceUntilIdle() - - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - } - - @Test - fun `user dictionary words are pushed exactly and lowercased`() = scope.runTest { - projectDataRepository.updateData { it.copy(dictionaryWords = setOf("McKinley")) } - - createService() - advanceUntilIdle() - - assertEquals(setOf("McKinley", "mckinley"), appliedPerChecker.last()) - } - - @Test - fun `user dictionary words do not depend on the encyclopedia feature`() = scope.runTest { - createEntry("Zaltharion") - projectDataRepository.updateData { - it.copy(dictionaryWords = setOf("kvothe"), encyclopediaDictionary = false) - } - - createService() - advanceUntilIdle() - - assertEquals(setOf("kvothe"), appliedPerChecker.last()) - } - - @Test - fun `adding and removing a user word after start updates the checker`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - - projectDataRepository.updateData { it.copy(dictionaryWords = setOf("kvothe")) } - advanceUntilIdle() - assertEquals(setOf("zaltharion", "kvothe"), appliedPerChecker.last()) - - projectDataRepository.updateData { it.copy(dictionaryWords = emptySet()) } - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - } - - @Test - fun `a user word edit does not reload the encyclopedia`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - clearMocks(encyclopediaRepository, answers = false, recordedCalls = true, childMocks = false) - - projectDataRepository.updateData { it.copy(dictionaryWords = setOf("kvothe")) } - advanceUntilIdle() - - assertEquals(setOf("zaltharion", "kvothe"), appliedPerChecker.last()) - coVerify(exactly = 0) { encyclopediaRepository.loadEntriesImperative() } - } - - @Test - fun `closing the project scope clears the words`() = scope.runTest { - createEntry("Zaltharion") - val service = createService() - advanceUntilIdle() - assertEquals(setOf("zaltharion"), appliedPerChecker.last()) - - service.projectScope.scope.close() - advanceUntilIdle() - - assertEquals(emptySet(), appliedPerChecker.last()) - } - - @Test - fun `renaming an entry replaces its old tokens`() = scope.runTest { - createEntry("Zaltharion") - createService() - advanceUntilIdle() - - val def = encyclopediaRepository.ensureEntriesLoaded().single() - encyclopediaRepository.updateEntry( - oldEntryDef = def, - name = "Velcaryn", - text = "text", - tags = emptySet(), - excludeFromDictionary = false, - ) - advanceUntilIdle() - - assertEquals(setOf("velcaryn"), appliedPerChecker.last()) - assertTrue(appliedPerChecker.none { "zaltharion" in it && "velcaryn" in it }) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectSpellCheckRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectSpellCheckRepositoryTest.kt deleted file mode 100644 index b67899511..000000000 --- a/common/src/desktopTest/kotlin/repositories/spellcheck/ProjectSpellCheckRepositoryTest.kt +++ /dev/null @@ -1,198 +0,0 @@ -package repositories.spellcheck - -import app.cash.turbine.test -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.SpellCheckerSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.GlobalSettingsDatasource -import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.ServerSettingsDatasource -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository -import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncDataDatasource -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.fileio.okio.toHPath -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository -import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository -import com.darkrockstudios.apps.hammer.common.util.Locale -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory -import io.mockk.Runs -import io.mockk.coEvery -import io.mockk.every -import io.mockk.just -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.test.assertSame - -/** - * Classical-style: a real [ProjectSpellCheckRepository] over a real [SpellCheckRepository], - * [GlobalSettingsStore] and [ProjectDataRepository] (FakeFileSystem-backed). Only the - * platform spell checker factory and settings persistence are mocked. - */ -class ProjectSpellCheckRepositoryTest : BaseTest() { - - private val projectDef = ProjectDef( - name = "Test Project", - path = "/projects/Test Project".toPath().toHPath(), - ) - - private lateinit var globalSettingsDatasource: GlobalSettingsDatasource - private lateinit var serverSettingsDatasource: ServerSettingsDatasource - private lateinit var factory: PlatformSpellCheckerFactory - private lateinit var checker: PlatformSpellChecker - private lateinit var fileSystem: FakeFileSystem - private lateinit var projectDataRepository: ProjectDataRepository - private lateinit var projectDataDatasource: ProjectDataDatasource - - @BeforeEach - override fun setup() { - super.setup() - globalSettingsDatasource = mockk() - serverSettingsDatasource = mockk() - factory = mockk() - checker = mockk() - - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } returns checker - coEvery { globalSettingsDatasource.storeSettings(any()) } just Runs - coEvery { serverSettingsDatasource.loadServerSettings(any()) } returns null - - fileSystem = FakeFileSystem() - fileSystem.createDirectories("/projects/Test Project".toPath()) - - val syncDataDatasource = mockk(relaxed = true) - setupKoin(module { - scope { - scoped { projectDef } - scoped { syncDataDatasource } - } - }) - - projectDataDatasource = ProjectDataDatasource(fileSystem, createTomlSerializer(), projectDef) - projectDataRepository = ProjectDataRepository(projectDataDatasource, projectDef) - } - - private fun settingsStore(dictionary: Locale): GlobalSettingsStore { - coEvery { globalSettingsDatasource.loadSettings() } returns GlobalSettings( - projectsDirectory = "/projects", - spellCheckSettings = SpellCheckerSettings(enabled = true, locale = dictionary), - ) - return GlobalSettingsStore(globalSettingsDatasource, serverSettingsDatasource) - } - - private fun repository(store: GlobalSettingsStore) = ProjectSpellCheckRepository( - spellCheckRepository = SpellCheckRepository(store, factory), - globalSettingsStore = store, - projectDataRepository = projectDataRepository, - projectDef = projectDef, - ) - - @Test - fun `unset project language passes the global dictionary through`() = scope.runTest { - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.dictionaryFlow.test { - assertSame(checker, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `matching project language passes the dictionary through`() = scope.runTest { - projectDataDatasource.save(StoredProjectData(ProjectData(language = "en"), null)) - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.dictionaryFlow.test { - assertSame(checker, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `mismatched project language withholds the dictionary`() = scope.runTest { - projectDataDatasource.save(StoredProjectData(ProjectData(language = "fr"), null)) - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.dictionaryFlow.test { - assertEquals(null, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `changing the dictionary to a matching language re-enables spell check`() = scope.runTest { - projectDataDatasource.save(StoredProjectData(ProjectData(language = "fr"), null)) - val store = settingsStore(Locale.forLanguageTag("en-US")) - val repo = repository(store) - - repo.dictionaryFlow.test { - assertEquals(null, awaitItem()) - - store.updateSettings { settings -> - settings.copy( - spellCheckSettings = settings.spellCheckSettings.copy( - locale = Locale.forLanguageTag("fr") - ) - ) - } - - assertSame(checker, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `setting the project language to a mismatch disables spell check`() = scope.runTest { - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.dictionaryFlow.test { - assertSame(checker, awaitItem()) - - projectDataRepository.updateData { it.copy(language = "de") } - - assertEquals(null, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `userDictionaryWords follows the stored project data`() = scope.runTest { - projectDataDatasource.save(StoredProjectData(ProjectData(dictionaryWords = setOf("Kvothe")), null)) - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.userDictionaryWords.test { - assertEquals(setOf("Kvothe"), awaitItem()) - - projectDataRepository.updateData { it.copy(dictionaryWords = it.dictionaryWords + "Denna") } - - assertEquals(setOf("Kvothe", "Denna"), awaitItem()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `spellCheckAllowed reflects the language gate`() = scope.runTest { - projectDataDatasource.save(StoredProjectData(ProjectData(language = "fr"), null)) - val repo = repository(settingsStore(Locale.forLanguageTag("en-US"))) - - repo.spellCheckAllowed.test { - assertEquals(false, awaitItem()) - - projectDataRepository.updateData { it.copy(language = "en") } - - assertEquals(true, awaitItem()) - cancelAndConsumeRemainingEvents() - } - } -} diff --git a/common/src/desktopTest/kotlin/repositories/spellcheck/SpellCheckRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/spellcheck/SpellCheckRepositoryTest.kt index b452b20cc..536ead0e2 100644 --- a/common/src/desktopTest/kotlin/repositories/spellcheck/SpellCheckRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/repositories/spellcheck/SpellCheckRepositoryTest.kt @@ -12,8 +12,6 @@ import com.darkrockstudios.apps.hammer.common.util.Locale import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory import com.darkrockstudios.libs.platformspellchecker.SpLocale -import getProject1Def -import getProjectDef import io.mockk.Runs import io.mockk.coEvery import io.mockk.coVerify @@ -191,209 +189,6 @@ class SpellCheckRepositoryTest : BaseTest() { } } - private fun sessionCapableChecker(correctWords: Set = emptySet()): Pair>> { - val applied = mutableListOf>() - val checker = mockk() - coEvery { checker.isWordCorrect(any()) } answers { firstArg() in correctWords } - coEvery { checker.setUserDictionary(any()) } answers { applied.add(firstArg()); Unit } - return checker to applied - } - - @Test - fun `setSessionWords emits a new checker carrying the words`() = scope.runTest { - val (first, _) = sessionCapableChecker() - val (second, secondApplied) = sessionCapableChecker() - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } returnsMany listOf(first, second) - - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - - repo.dictionaryFlow.test { - assertSame(first, awaitItem()) - - repo.setSessionWords(getProject1Def(), setOf("zaltharion", "kastle")) - - assertSame(second, awaitItem()) - assertEquals(setOf("zaltharion", "kastle"), secondApplied.single().toSet()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `words the base dictionary already accepts are not added`() = scope.runTest { - val (first, _) = sessionCapableChecker() - val (second, secondApplied) = sessionCapableChecker(correctWords = setOf("paris")) - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } returnsMany listOf(first, second) - - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - - repo.dictionaryFlow.test { - assertSame(first, awaitItem()) - - repo.setSessionWords(getProject1Def(), setOf("paris", "zaltharion")) - - assertSame(second, awaitItem()) - assertEquals(setOf("zaltharion"), secondApplied.single().toSet()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `locale change re-applies session words to the new checker`() = scope.runTest { - val (en, _) = sessionCapableChecker() - val (enWithWords, _) = sessionCapableChecker() - val (fr, frApplied) = sessionCapableChecker() - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(SpLocale("en")) } returnsMany listOf(en, enWithWords) - coEvery { factory.createSpellChecker(SpLocale("fr")) } returns fr - coEvery { globalSettingsDatasource.storeSettings(any()) } just Runs - - val store = settingsStore(Locale.forLanguageTag("en")) - val repo = SpellCheckRepository(store, factory) - - repo.dictionaryFlow.test { - assertSame(en, awaitItem()) - - repo.setSessionWords(getProject1Def(), setOf("zaltharion")) - assertSame(enWithWords, awaitItem()) - - store.updateSettings { settings -> - settings.copy( - spellCheckSettings = settings.spellCheckSettings.copy( - locale = Locale.forLanguageTag("fr") - ) - ) - } - - assertSame(fr, awaitItem()) - assertEquals(setOf("zaltharion"), frApplied.single().toSet()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `session words set while disabled are applied on re-enable`() = scope.runTest { - val (checker, applied) = sessionCapableChecker() - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(SpLocale("en")) } returns checker - coEvery { globalSettingsDatasource.storeSettings(any()) } just Runs - - val store = settingsStore(Locale.forLanguageTag("en"), enabled = false) - val repo = SpellCheckRepository(store, factory) - advanceUntilIdle() - - repo.setSessionWords(getProject1Def(), setOf("zaltharion")) - advanceUntilIdle() - coVerify(exactly = 0) { factory.createSpellChecker(any()) } - - repo.dictionaryFlow.test { - assertEquals(null, awaitItem()) - - store.updateSettings { settings -> - settings.copy( - spellCheckSettings = settings.spellCheckSettings.copy(enabled = true) - ) - } - - assertSame(checker, awaitItem()) - assertEquals(setOf("zaltharion"), applied.single().toSet()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `clearSessionWords emits a fresh checker without the words`() = scope.runTest { - val (first, _) = sessionCapableChecker() - val (second, secondApplied) = sessionCapableChecker() - val (third, thirdApplied) = sessionCapableChecker() - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } returnsMany listOf(first, second, third) - - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - - repo.dictionaryFlow.test { - assertSame(first, awaitItem()) - - repo.setSessionWords(getProject1Def(), setOf("zaltharion")) - assertSame(second, awaitItem()) - assertEquals(setOf("zaltharion"), secondApplied.single().toSet()) - - repo.clearSessionWords(getProject1Def()) - assertSame(third, awaitItem()) - assertTrue(thirdApplied.isEmpty()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `clearing an owner that contributed nothing does not recreate the checker`() = scope.runTest { - val (checker, _) = sessionCapableChecker() - var loadCount = 0 - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } answers { loadCount++; checker } - - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - advanceUntilIdle() - val loadsAfterInit = loadCount - - repo.clearSessionWords(getProject1Def()) - advanceUntilIdle() - - assertEquals(loadsAfterInit, loadCount) - } - - @Test - fun `session words are unioned across owners and cleared per-owner`() = scope.runTest { - val (first, _) = sessionCapableChecker() - val (second, secondApplied) = sessionCapableChecker() - val (third, thirdApplied) = sessionCapableChecker() - val (fourth, fourthApplied) = sessionCapableChecker() - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } returnsMany listOf(first, second, third, fourth) - - val projectA = getProject1Def() - val projectB = getProjectDef("Project B") - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - - repo.dictionaryFlow.test { - assertSame(first, awaitItem()) - - repo.setSessionWords(projectA, setOf("zaltharion")) - assertSame(second, awaitItem()) - assertEquals(setOf("zaltharion"), secondApplied.single().toSet()) - - repo.setSessionWords(projectB, setOf("kastle")) - assertSame(third, awaitItem()) - assertEquals(setOf("zaltharion", "kastle"), thirdApplied.single().toSet()) - - repo.clearSessionWords(projectA) - assertSame(fourth, awaitItem()) - assertEquals(setOf("kastle"), fourthApplied.single().toSet()) - cancelAndConsumeRemainingEvents() - } - } - - @Test - fun `pushing an identical word set does not recreate the checker`() = scope.runTest { - val (checker, _) = sessionCapableChecker() - var loadCount = 0 - every { factory.hasLanguage(any()) } returns true - coEvery { factory.createSpellChecker(any()) } answers { loadCount++; checker } - - val repo = SpellCheckRepository(settingsStore(Locale.forLanguageTag("en")), factory) - advanceUntilIdle() - - repo.setSessionWords(getProject1Def(), setOf("zaltharion")) - advanceUntilIdle() - val loadsAfterFirstPush = loadCount - - repo.setSessionWords(getProject1Def(), setOf("zaltharion")) - advanceUntilIdle() - - assertEquals(loadsAfterFirstPush, loadCount) - } - @Test fun `toSpLocale maps language and region`() { val spLocale = Locale.forLanguage("en", "US").toSpLocale() diff --git a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsDatasourceTest.kt b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsDatasourceTest.kt index 7aeaca6c8..1b156bed5 100644 --- a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsDatasourceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsDatasourceTest.kt @@ -10,6 +10,7 @@ import com.darkrockstudios.apps.hammer.common.getCacheDirectory import getProject1Def import getProjectDef import kotlinx.coroutines.test.runTest +import kotlinx.datetime.Instant import net.peanuuutz.tomlkt.Toml import okio.Path.Companion.toPath import okio.fakefilesystem.FakeFileSystem @@ -21,7 +22,6 @@ import kotlin.test.assertEquals import kotlin.test.assertFalse import kotlin.test.assertNull import kotlin.test.assertTrue -import kotlin.time.Instant class StatisticsDatasourceTest : BaseTest() { diff --git a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsRepositoryTest.kt b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsRepositoryTest.kt index 781ed9388..354549709 100644 --- a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsRepositoryTest.kt +++ b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsRepositoryTest.kt @@ -8,13 +8,13 @@ import io.mockk.* import io.mockk.impl.annotations.MockK import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest +import kotlinx.datetime.Instant import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Test import utils.BaseTest import kotlin.test.assertEquals import kotlin.test.assertFalse import kotlin.test.assertTrue -import kotlin.time.Instant /** * Pins the dirty-flag mechanics of [StatisticsRepository.markDirty]: synchronous in-memory diff --git a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsServiceTest.kt b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsServiceTest.kt index 34ce589f6..84d0fb512 100644 --- a/common/src/desktopTest/kotlin/repositories/statistics/StatisticsServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/statistics/StatisticsServiceTest.kt @@ -3,8 +3,6 @@ package repositories.statistics import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesRepository import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataRepository import com.darkrockstudios.apps.hammer.common.data.projectdata.StoredProjectData @@ -210,29 +208,6 @@ class StatisticsServiceTest : BaseTest() { assertFalse(service.isCalculating.value) } - @Test - fun `recalculateStatistics limits top appearances to people but counts connections for all types`() = - runTest(mainTestDispatcher) { - // Scenes reference entries of every type. The "Characters by Appearances" - // chart is people-only; the connections total spans the whole encyclopedia. - val entries = EntryType.entries.mapIndexed { index, type -> - EntryDef(projectDef, index + 1, type, "Entry${type.name}") - } - every { encyclopediaRepository.entryListFlow } returns MutableStateFlow(entries) - coEvery { referenceIndexService.loadIndex() } returns ReferenceIndex( - entryToScenes = entries.associate { it.id to setOf(100, 200) }, - ) - coEvery { statisticsRepository.loadStatistics() } returns null - - val stats = makeService().recalculateStatistics() - - assertEquals( - listOf(EntryType.PERSON), - stats.topAppearances.map { it.type }.distinct(), - ) - assertEquals(entries.size * 2, stats.totalEntryConnections) - } - @Test fun `recalculateStatistics counts unsealed sessions in daily totals and per-device`() = runTest(mainTestDispatcher) { diff --git a/common/src/desktopTest/kotlin/repositories/syncdata/PendingEntityCountTest.kt b/common/src/desktopTest/kotlin/repositories/syncdata/PendingEntityCountTest.kt deleted file mode 100644 index c68385efb..000000000 --- a/common/src/desktopTest/kotlin/repositories/syncdata/PendingEntityCountTest.kt +++ /dev/null @@ -1,87 +0,0 @@ -package repositories.syncdata - -import PROJECT_2_NAME -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer -import com.darkrockstudios.apps.hammer.base.http.writeJson -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.EntityOriginalState -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ProjectSynchronizationData -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncDataDatasource.Companion.SYNC_FILE_NAME -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.loadPendingEntityCount -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import createProject -import getProjectDef -import kotlinx.coroutines.test.runTest -import kotlinx.serialization.SerializationException -import kotlinx.serialization.json.Json -import okio.Path -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.junit.jupiter.api.assertThrows -import utils.BaseTest -import kotlin.test.assertEquals -import kotlin.time.Instant - -/** - * The scope-less count exists so a caller that only needs the number does not have to open a whole - * project scope for it. - */ -class PendingEntityCountTest : BaseTest() { - - private lateinit var ffs: FakeFileSystem - private lateinit var json: Json - - @BeforeEach - override fun setup() { - super.setup() - ffs = FakeFileSystem() - json = createJsonSerializer() - } - - private fun syncPath(projectDef: ProjectDef): Path = projectDef.path.toOkioPath() / SYNC_FILE_NAME - - @Test - fun `A project that has never synced has nothing pending`() = runTest { - createProject(ffs, PROJECT_2_NAME) - val projectDef = getProjectDef(PROJECT_2_NAME) - ffs.delete(syncPath(projectDef)) - - assertEquals(0, loadPendingEntityCount(projectDef, ffs, json)) - // Asking must not be what creates the journal. - assertFalse(ffs.exists(syncPath(projectDef))) - } - - @Test - fun `Pending entities are the new ones plus the changed ones`() = runTest { - createProject(ffs, PROJECT_2_NAME) - val projectDef = getProjectDef(PROJECT_2_NAME) - ffs.writeJson( - syncPath(projectDef), - json, - ProjectSynchronizationData( - currentSyncId = null, - lastId = 6, - newIds = listOf(5, 6), - lastSync = Instant.DISTANT_PAST, - dirty = listOf(EntityOriginalState(1, "hash"), EntityOriginalState(5, null)), - deletedIds = setOf(3), - ), - ) - - // Entity 5 is both new and dirty, and a deleted id is not writing waiting to upload. - assertEquals(3, loadPendingEntityCount(projectDef, ffs, json)) - } - - @Test - fun `A journal that cannot be read is not reported as nothing pending`() = runTest { - createProject(ffs, PROJECT_2_NAME) - val projectDef = getProjectDef(PROJECT_2_NAME) - ffs.write(syncPath(projectDef)) { writeUtf8("{ this is not json") } - - // Callers use this to decide whether local writing is safe to delete, and a corrupt - // journal is not evidence that it is. - assertThrows { loadPendingEntityCount(projectDef, ffs, json) } - } -} diff --git a/common/src/desktopTest/kotlin/repositories/tagindex/AccountTagServiceTest.kt b/common/src/desktopTest/kotlin/repositories/tagindex/AccountTagServiceTest.kt index 391d8fe98..04caeffa5 100644 --- a/common/src/desktopTest/kotlin/repositories/tagindex/AccountTagServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/tagindex/AccountTagServiceTest.kt @@ -108,16 +108,6 @@ class AccountTagServiceTest : BaseTest() { assertEquals(listOf(TagCount("gothic", 1)), service.suggest("#go")) } - /** Text entered on iOS/macOS can arrive decomposed: base letter plus a combining mark. */ - @Test - fun `Prefix matching composes decomposed accents`() = runTest { - advanceUntilIdle() - ideasRepository.createIdea(content = "a", tags = setOf("th\u00e8me")) - advanceUntilIdle() - - assertEquals(listOf(TagCount("th\u00e8me", 1)), service.suggest("the\u0300")) - } - @Test fun `Blank prefix suggests nothing`() = runTest { advanceUntilIdle() diff --git a/common/src/desktopTest/kotlin/repositories/tagindex/TagIndexServiceTest.kt b/common/src/desktopTest/kotlin/repositories/tagindex/TagIndexServiceTest.kt index 118b51978..c4c76ece9 100644 --- a/common/src/desktopTest/kotlin/repositories/tagindex/TagIndexServiceTest.kt +++ b/common/src/desktopTest/kotlin/repositories/tagindex/TagIndexServiceTest.kt @@ -9,9 +9,7 @@ import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesReposito import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContainer import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository -import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMetadataRepository -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMetadataUpdate import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata import com.darkrockstudios.apps.hammer.common.data.tagindex.BuildTagIndexUseCase import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndexService @@ -51,7 +49,7 @@ class TagIndexServiceTest : BaseTest() { private lateinit var eventContentChangedFlow: MutableSharedFlow private lateinit var notesListFlow: MutableSharedFlow> private lateinit var timelineFlow: MutableSharedFlow - private lateinit var sceneMetadataUpdateFlow: MutableSharedFlow + private lateinit var sceneMetadataUpdateFlow: MutableSharedFlow> @BeforeEach override fun setup() { @@ -264,49 +262,6 @@ class TagIndexServiceTest : BaseTest() { assertTrue(empty.isEmpty()) } - /** Text entered on iOS/macOS can arrive decomposed: base letter plus a combining mark. */ - @Test - fun `suggest matches a decomposed accented prefix`() = runTest(mainTestDispatcher) { - stubNotes(note(1, "th\u00e8me")) - stubTimeline() - stubEntries() - - val service = makeService() - advanceUntilIdle() - - assertEquals(listOf("th\u00e8me" to 1), service.suggest("the\u0300").map { it.tag to it.count }) - } - - /** A tag can reach disk unnormalized (hand-edited project file, import); the index composes it. */ - @Test - fun `index keys are normalized so an unnormalized stored tag is still found`() = - runTest(mainTestDispatcher) { - stubNotes(note(1, "the\u0300me")) - stubTimeline() - stubEntries() - - val service = makeService() - advanceUntilIdle() - - assertEquals( - setOf(TaggedEntityRef(TaggedEntityType.Note, 1)), - service.getEntitiesWithTag("th\u00e8me"), - ) - assertEquals(listOf("th\u00e8me" to 1), service.suggest("th\u00e8me").map { it.tag to it.count }) - } - - @Test - fun `suggest ignores a leading hash`() = runTest(mainTestDispatcher) { - stubNotes(note(1, "arwen")) - stubTimeline() - stubEntries() - - val service = makeService() - advanceUntilIdle() - - assertEquals(listOf("arwen" to 1), service.suggest("#ar").map { it.tag to it.count }) - } - @Test fun `rebuild fires when a content-changed signal is emitted`() = runTest(mainTestDispatcher) { stubNotes(note(1, "alpha")) @@ -366,9 +321,7 @@ class TagIndexServiceTest : BaseTest() { assertEquals(1, service.tagIndex.value.tagToEntities["alpha"]?.size) stubScenes(1 to setOf("alpha"), 2 to setOf("alpha")) - sceneMetadataUpdateFlow.tryEmit( - SceneMetadataUpdate(2, SceneMetadata(tags = setOf("alpha")), UpdateSource.Editor) - ) + sceneMetadataUpdateFlow.tryEmit(2 to SceneMetadata(tags = setOf("alpha"))) advanceUntilIdle() assertEquals(2, service.tagIndex.value.tagToEntities["alpha"]?.size) diff --git a/common/src/desktopTest/kotlin/repositories/tagindex/TagNormalizerTest.kt b/common/src/desktopTest/kotlin/repositories/tagindex/TagNormalizerTest.kt deleted file mode 100644 index 59034ed00..000000000 --- a/common/src/desktopTest/kotlin/repositories/tagindex/TagNormalizerTest.kt +++ /dev/null @@ -1,136 +0,0 @@ -package repositories.tagindex - -import com.darkrockstudios.apps.hammer.common.data.tagindex.cleanTags -import com.darkrockstudios.apps.hammer.common.data.tagindex.parseTagInput -import com.darkrockstudios.apps.hammer.common.data.tagindex.replaceTagPrefix -import com.darkrockstudios.apps.hammer.common.data.tagindex.tagPrefixOf -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -class TagNormalizerTest { - - @Test - fun `Clean tags keeps accented letters`() { - val tags = setOf("th\u00e8me", "caf\u00e9", "a\u00f1o", "\u00c6r\u00f8") - - assertEquals(tags, cleanTags(tags)) - } - - @Test - fun `Clean tags keeps non-latin scripts`() { - val tags = setOf("\u043f\u0435\u0440\u0441\u043e\u043d\u0430\u0436", "\u4eba\u7269", "\u3061\u304b\u3089") - - assertEquals(tags, cleanTags(tags)) - } - - @Test - fun `Clean tags keeps supplementary plane letters`() { - val rareKanji = "\uD842\uDFB7\u7530" - val adlam = "\uD83A\uDD00\uD83A\uDD22" - - assertEquals(setOf(rareKanji, adlam), cleanTags(setOf(rareKanji, adlam))) - } - - @Test - fun `Clean tags keeps word joiners`() { - val withZwnj = "\u0645\u06cc\u200c\u0631\u0648\u062f" - - assertEquals(setOf(withZwnj), cleanTags(setOf(withZwnj))) - } - - @Test - fun `Clean tags keeps ascii word characters`() { - val tags = setOf("animal", "side-quest", "act_two", "chapter3") - - assertEquals(tags, cleanTags(tags)) - } - - /** Text entered on iOS/macOS can arrive decomposed: base letter plus a combining mark. */ - @Test - fun `Clean tags composes decomposed accents`() { - val decomposed = "the\u0300me" - - assertEquals(setOf("th\u00e8me"), cleanTags(setOf(decomposed))) - } - - @Test - fun `Clean tags treats both spellings of a tag as one`() { - val composed = "th\u00e8me" - val decomposed = "the\u0300me" - - assertEquals(setOf(composed), cleanTags(setOf(composed, decomposed))) - } - - @Test - fun `Clean tags strips leading hash and surrounding whitespace`() { - assertEquals(setOf("th\u00e8me"), cleanTags(setOf(" #th\u00e8me "))) - } - - @Test - fun `Clean tags strips a fullwidth hash`() { - assertEquals(setOf("\u4eba\u7269"), cleanTags(setOf("\uff03\u4eba\u7269"))) - } - - @Test - fun `Clean tags drops separators and punctuation`() { - val tags = setOf("two words", "comma,tag", "quote\"tag", "slash/tag", "") - - assertEquals(emptySet(), cleanTags(tags)) - } - - @Test - fun `Clean tags drops tags with no letter or digit`() { - val tags = setOf("\u0301", "---", "___", "\u200c") - - assertEquals(emptySet(), cleanTags(tags)) - } - - @Test - fun `Parse tag input splits on whitespace and commas`() { - val input = " #th\u00e8me, guerre \u00e9t\u00e9,h\u00e9ros " - - assertEquals(setOf("th\u00e8me", "guerre", "\u00e9t\u00e9", "h\u00e9ros"), parseTagInput(input)) - } - - @Test - fun `Parse tag input splits on ideographic separators`() { - val input = "\u4eba\u7269\u3000\u5834\u6240\u3001\u9b54\u6cd5" - - assertEquals(setOf("\u4eba\u7269", "\u5834\u6240", "\u9b54\u6cd5"), parseTagInput(input)) - } - - @Test - fun `Tag prefix is the run after the last separator`() { - assertEquals("\u00e9t\u00e9", tagPrefixOf("guerre,\u00e9t\u00e9")) - assertEquals("\u9b54\u6cd5", tagPrefixOf("\u4eba\u7269\u3001\u9b54\u6cd5")) - assertEquals("\u5834\u6240", tagPrefixOf("\u4eba\u7269\u3000\u5834\u6240")) - } - - @Test - fun `Tag prefix composes decomposed accents`() { - assertEquals("th\u00e8", tagPrefixOf("guerre #the\u0300")) - } - - @Test - fun `Tag prefix is empty when the input ends on a separator`() { - assertEquals("", tagPrefixOf("guerre ")) - assertEquals("", tagPrefixOf("")) - assertEquals("", tagPrefixOf("#")) - } - - @Test - fun `Replace tag prefix swaps only the tag being typed`() { - assertEquals("alice bob", replaceTagPrefix("alice bo", "bob")) - assertEquals("alice,bob", replaceTagPrefix("alice,bo", "bob")) - assertEquals("alice bob", replaceTagPrefix("alice ", "bob")) - assertEquals("bob", replaceTagPrefix("", "bob")) - assertEquals("bob", replaceTagPrefix("#bo", "bob")) - } - - @Test - fun `Parse tag input splits on non-breaking spaces`() { - val input = "one\u00a0two" - - assertEquals(setOf("one", "two"), parseTagInput(input)) - } -} \ No newline at end of file diff --git a/common/src/desktopTest/kotlin/repositories/timeline/TimeLineTestBase.kt b/common/src/desktopTest/kotlin/repositories/timeline/TimeLineTestBase.kt index b3a6dc1d1..8315bc4c1 100644 --- a/common/src/desktopTest/kotlin/repositories/timeline/TimeLineTestBase.kt +++ b/common/src/desktopTest/kotlin/repositories/timeline/TimeLineTestBase.kt @@ -13,10 +13,8 @@ import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineEv import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository import io.mockk.* import kotlinx.coroutines.flow.FlowCollector -import kotlinx.coroutines.flow.emptyFlow import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.launch @@ -121,11 +119,6 @@ abstract class TimeLineTestBase : BaseTest() { scoped { timelineRepo } bind TimeLineRepository::class scoped { idRepo } bind IdAllocator::class } - single { - mockk(relaxed = true) { - every { spellCheckAllowed } returns emptyFlow() - } - } } setupKoin(testModule) } diff --git a/common/src/desktopTest/kotlin/repositories/tree/SceneChaptersTest.kt b/common/src/desktopTest/kotlin/repositories/tree/SceneChaptersTest.kt deleted file mode 100644 index a2102f193..000000000 --- a/common/src/desktopTest/kotlin/repositories/tree/SceneChaptersTest.kt +++ /dev/null @@ -1,67 +0,0 @@ -package repositories.tree - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.tree.ChapterScenes -import com.darkrockstudios.apps.hammer.common.data.tree.ImmutableTree -import com.darkrockstudios.apps.hammer.common.data.tree.Tree -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode -import com.darkrockstudios.apps.hammer.common.data.tree.collectChapters -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class SceneChaptersTest { - - private val projectDef = ProjectDef("Test", HPath("/projects/Test", "Test", false)) - - private fun item(id: Int, type: SceneItem.Type) = - SceneItem(projectDef = projectDef, type = type, id = id, name = "Item $id", order = id) - - private fun scene(id: Int) = TreeNode(item(id, SceneItem.Type.Scene)) - - private fun group(id: Int, vararg children: TreeNode) = - TreeNode(item(id, SceneItem.Type.Group)).apply { children.forEach { addChild(it) } } - - private fun tree(vararg topLevel: TreeNode): ImmutableTree { - val root = TreeNode(item(SceneItem.ROOT_ID, SceneItem.Type.Root)) - topLevel.forEach { root.addChild(it) } - return Tree().apply { setRoot(root) }.toImmutableTree() - } - - @Test - fun `a top-level scene is a one-scene chapter`() { - val chapters = tree(scene(1), scene(2)).collectChapters() - - assertEquals(listOf(1, 2), chapters.map { it.chapter.id }) - assertEquals(listOf(listOf(1), listOf(2)), chapters.map { c -> c.scenes.map { it.id } }) - } - - @Test - fun `a group is flattened depth-first to its descendant scenes`() { - val chapters = tree( - group(10, scene(11), group(12, scene(13), scene(14)), scene(15)), - scene(20), - ).collectChapters() - - assertEquals(listOf(10, 20), chapters.map { it.chapter.id }) - assertEquals(listOf(11, 13, 14, 15), chapters[0].scenes.map { it.id }) - assertTrue(chapters[0].scenes.all { it.type == SceneItem.Type.Scene }) - } - - @Test - fun `an empty group is still a chapter`() { - val chapters = tree(group(10), group(20, group(21))).collectChapters() - - assertEquals( - listOf(emptyList(), emptyList()), - chapters.map(ChapterScenes::scenes), - ) - } - - @Test - fun `an empty tree has no chapters`() { - assertTrue(tree().collectChapters().isEmpty()) - } -} diff --git a/common/src/desktopTest/kotlin/repositories/writingactivity/WritingActivitySyncOperationTest.kt b/common/src/desktopTest/kotlin/repositories/writingactivity/WritingActivitySyncOperationTest.kt index 40247782d..fe76186b6 100644 --- a/common/src/desktopTest/kotlin/repositories/writingactivity/WritingActivitySyncOperationTest.kt +++ b/common/src/desktopTest/kotlin/repositories/writingactivity/WritingActivitySyncOperationTest.kt @@ -52,7 +52,7 @@ class WritingActivitySyncOperationTest : BaseTest() { private val onProgress: suspend (Float, SyncLogMessage?) -> Unit = mockk(relaxed = true) private val onLog: OnSyncLog = mockk(relaxed = true) private val onConflict: EntityConflictHandler = mockk(relaxed = true) - private val onComplete: suspend (Boolean) -> Unit = mockk(relaxed = true) + private val onComplete: suspend () -> Unit = mockk(relaxed = true) private val ownDeviceId = "device-self" private val deviceLabel = "My Desktop" diff --git a/common/src/desktopTest/kotlin/server/ApiFailureBodyTest.kt b/common/src/desktopTest/kotlin/server/ApiFailureBodyTest.kt deleted file mode 100644 index c60c286f3..000000000 --- a/common/src/desktopTest/kotlin/server/ApiFailureBodyTest.kt +++ /dev/null @@ -1,137 +0,0 @@ -package server - -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.base.http.ApiErrorCode -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.server.HttpFailureException -import com.darkrockstudios.apps.hammer.common.server.ServerAccountApi -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.sync_general_error -import com.darkrockstudios.apps.hammer.sync_unauthorized -import io.ktor.client.HttpClient -import io.ktor.client.engine.mock.MockEngine -import io.ktor.client.engine.mock.respond -import io.ktor.client.plugins.contentnegotiation.ContentNegotiation -import io.ktor.http.HttpHeaders -import io.ktor.http.HttpStatusCode -import io.ktor.http.headersOf -import io.ktor.serialization.kotlinx.json.json -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import kotlinx.serialization.json.Json -import org.junit.jupiter.api.BeforeEach -import org.koin.dsl.module -import utils.BaseTest -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertIs -import kotlin.test.assertTrue - -/** - * What the server said about a failure has to survive the trip to the user. A 401 - * explaining that the password was wrong used to be replaced by the generic sync - * message before anyone could read it (#835). - */ -class ApiFailureBodyTest : BaseTest() { - - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var strRes: RecordingStrRes - - @BeforeEach - override fun setup() { - super.setup() - - strRes = RecordingStrRes() - globalSettingsStore = mockk(relaxed = true) - every { globalSettingsStore.serverSettings } returns ServerSettings( - url = "example.com", - email = "user@example.com", - userId = -1L, - bearerToken = null, - refreshToken = null, - ) - - setupKoin( - module { - single { DeviceLocaleResolver() } - } - ) - } - - @Test - fun `a 401 carrying a message reaches the caller as that message`() = runTest { - val api = createApi( - status = HttpStatusCode.Unauthorized, - body = """{"error":"Failed to authenticate","displayMessage":"Invalid email or password",""" + - """"errorCode":"${ApiErrorCode.INVALID_CREDENTIALS}"}""", - contentType = "application/json", - ) - - val failure = api.login("user@example.com", "password", "install-id").exceptionOrNull() - - val httpFailure = assertIs(failure) - assertEquals("Invalid email or password", httpFailure.error.displayMessage) - assertEquals(ApiErrorCode.INVALID_CREDENTIALS, httpFailure.error.errorCode) - assertFalse( - strRes.requested.contains(Res.string.sync_unauthorized), - "A message from the server must not be replaced by the generic one", - ) - } - - @Test - fun `a 403 naming the allowed-users list keeps its own message`() = runTest { - val api = createApi( - status = HttpStatusCode.Forbidden, - body = """{"error":"Failed to authenticate","displayMessage":"Not allowed on this server",""" + - """"errorCode":"${ApiErrorCode.NOT_WHITELISTED}"}""", - contentType = "application/json", - ) - - val failure = api.login("user@example.com", "password", "install-id").exceptionOrNull() - - val httpFailure = assertIs(failure) - assertEquals(HttpStatusCode.Forbidden, httpFailure.statusCode) - assertEquals(ApiErrorCode.NOT_WHITELISTED, httpFailure.error.errorCode) - } - - @Test - fun `a 401 with nothing usable falls back to the unauthorized message`() = runTest { - val api = createApi(status = HttpStatusCode.Unauthorized, body = "") - - val failure = api.login("user@example.com", "password", "install-id").exceptionOrNull() - - assertIs(failure) - assertTrue(strRes.requested.contains(Res.string.sync_unauthorized)) - } - - @Test - fun `another status with nothing usable falls back to the general message`() = runTest { - val api = createApi(status = HttpStatusCode.InternalServerError, body = "") - - val failure = api.login("user@example.com", "password", "install-id").exceptionOrNull() - - assertIs(failure) - assertTrue(strRes.requested.contains(Res.string.sync_general_error)) - } - - private fun createApi( - status: HttpStatusCode, - body: String, - contentType: String? = null, - ): ServerAccountApi { - val engine = MockEngine { - respond( - content = body, - status = status, - headers = contentType?.let { headersOf(HttpHeaders.ContentType, it) } ?: headersOf(), - ) - } - val client = HttpClient(engine) { - install(ContentNegotiation) { json(Json { ignoreUnknownKeys = true }) } - } - return ServerAccountApi(client, globalSettingsStore, strRes) - } -} diff --git a/common/src/desktopTest/kotlin/server/ApiTlsFailureTest.kt b/common/src/desktopTest/kotlin/server/ApiTlsFailureTest.kt deleted file mode 100644 index 0398b2382..000000000 --- a/common/src/desktopTest/kotlin/server/ApiTlsFailureTest.kt +++ /dev/null @@ -1,143 +0,0 @@ -package server - -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.server.HttpFailureException -import com.darkrockstudios.apps.hammer.common.server.ServerAccountApi -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.server_error_connection_generic -import com.darkrockstudios.apps.hammer.server_error_network_unavailable -import com.darkrockstudios.apps.hammer.server_error_tls -import io.ktor.client.HttpClient -import io.ktor.client.engine.mock.MockEngine -import io.ktor.client.plugins.contentnegotiation.ContentNegotiation -import io.ktor.serialization.kotlinx.json.json -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import kotlinx.serialization.json.Json -import org.junit.jupiter.api.BeforeEach -import org.koin.dsl.module -import utils.BaseTest -import java.io.UncheckedIOException -import java.net.ConnectException -import javax.net.ssl.SSLHandshakeException -import kotlin.test.Test -import kotlin.test.assertFailsWith -import kotlin.test.assertFalse -import kotlin.test.assertIs -import kotlin.test.assertTrue - -/** - * A server reachable only over plain HTTP fails the client's TLS handshake, which needs to read as - * "this server isn't serving HTTPS" rather than as a generic connectivity problem. Covers the rest - * of the network failure mapping too, including the unchecked wrappers the JDK throws. - */ -class ApiTlsFailureTest : BaseTest() { - - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var strRes: RecordingStrRes - - @BeforeEach - override fun setup() { - super.setup() - - strRes = RecordingStrRes() - globalSettingsStore = mockk(relaxed = true) - every { globalSettingsStore.serverSettings } returns ServerSettings( - url = "homeserver:8080", - email = "user@example.com", - userId = -1L, - bearerToken = null, - refreshToken = null, - ) - - setupKoin( - module { - single { DeviceLocaleResolver() } - } - ) - } - - private fun createApi(failure: Throwable): ServerAccountApi { - val client = HttpClient(MockEngine { throw failure }) { - install(ContentNegotiation) { json(Json { ignoreUnknownKeys = true }) } - } - return ServerAccountApi(client, globalSettingsStore, strRes) - } - - @Test - fun `a handshake failure reports the server is not serving https`() = runTest { - val api = createApi(SSLHandshakeException("Remote host terminated the handshake")) - - val result = api.createAccount("user@example.com", "password", "install-id") - - assertIs(result.exceptionOrNull()) - assertTrue(strRes.requested.contains(Res.string.server_error_tls)) - } - - @Test - fun `a wrapped handshake failure is still recognised`() = runTest { - val api = createApi( - java.io.IOException("request failed", SSLHandshakeException("unable to find valid certification path")) - ) - - val result = api.createAccount("user@example.com", "password", "install-id") - - assertIs(result.exceptionOrNull()) - assertTrue(strRes.requested.contains(Res.string.server_error_tls)) - } - - /** - * `java.net.http.HttpClient`'s constructor wraps a failed `Selector.open()` this way, which is - * how a Windows machine that cannot open the JDK's loopback socket pair fails. Nothing reached - * the network, so it must not read as a server or connectivity problem. - */ - @Test - fun `an unchecked io wrapper reports the network being unavailable`() = runTest { - val api = createApi( - UncheckedIOException(java.io.IOException("Unable to establish loopback connection")) - ) - - val result = api.createAccount("user@example.com", "password", "install-id") - - assertIs(result.exceptionOrNull()) - assertTrue(strRes.requested.contains(Res.string.server_error_network_unavailable)) - assertFalse(strRes.requested.contains(Res.string.server_error_connection_generic)) - } - - @Test - fun `an unchecked io wrapper still recognises a tls failure`() = runTest { - val api = createApi( - UncheckedIOException( - java.io.IOException("request failed", SSLHandshakeException("bad certificate")) - ) - ) - - val result = api.createAccount("user@example.com", "password", "install-id") - - assertIs(result.exceptionOrNull()) - assertTrue(strRes.requested.contains(Res.string.server_error_tls)) - } - - @Test - fun `an unchecked non-io failure propagates`() = runTest { - val api = createApi(IllegalStateException("boom")) - - assertFailsWith { - api.createAccount("user@example.com", "password", "install-id") - } - } - - @Test - fun `an ordinary connection failure keeps the generic message`() = runTest { - val api = createApi(ConnectException("Connection refused")) - - val result = api.createAccount("user@example.com", "password", "install-id") - - assertIs(result.exceptionOrNull()) - assertTrue(strRes.requested.contains(Res.string.server_error_connection_generic)) - assertFalse(strRes.requested.contains(Res.string.server_error_network_unavailable)) - } -} diff --git a/common/src/desktopTest/kotlin/server/NetworkJsonForwardCompatTest.kt b/common/src/desktopTest/kotlin/server/NetworkJsonForwardCompatTest.kt deleted file mode 100644 index 40c25d01c..000000000 --- a/common/src/desktopTest/kotlin/server/NetworkJsonForwardCompatTest.kt +++ /dev/null @@ -1,102 +0,0 @@ -package server - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.createNetworkJsonSerializer -import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectDataDto -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.server.ProjectDataApi -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import io.ktor.client.HttpClient -import io.ktor.client.engine.mock.MockEngine -import io.ktor.client.engine.mock.respond -import io.ktor.client.plugins.contentnegotiation.ContentNegotiation -import io.ktor.http.ContentType -import io.ktor.http.HttpHeaders -import io.ktor.http.HttpStatusCode -import io.ktor.http.headersOf -import io.ktor.serialization.kotlinx.json.json -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.koin.dsl.module -import utils.BaseTest -import utils.TestStrRes -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -/** - * Synced models gain fields without a protocol bump, so a client has to drop fields a newer build - * wrote rather than failing the decode. See "Server storage is shape-agnostic" in - * `SYNCING-PROTOCOL.md`. - */ -class NetworkJsonForwardCompatTest : BaseTest() { - - private val userId = 42L - private val json = createNetworkJsonSerializer() - private lateinit var globalSettingsStore: GlobalSettingsStore - - /** A payload written by a build that knows fields this one does not. */ - private val futurePayload = """ - {"data":{"authorName":"Ada","theme":null,"wordCountGoal":null,"tags":[],"language":"nb", - "encyclopediaDictionary":true,"unknownFutureField":"whatever"},"hash":"CJjmUTfFWaIl8YePLhBLSQ"} - """.trimIndent().replace("\n", "") - - @BeforeEach - override fun setup() { - super.setup() - - globalSettingsStore = mockk(relaxed = true) - every { globalSettingsStore.serverSettings } returns ServerSettings( - ssl = false, - url = "example.com", - email = "user@example.com", - userId = userId, - bearerToken = "token", - refreshToken = "refresh", - ) - - setupKoin( - module { - single { DeviceLocaleResolver() } - } - ) - } - - @Test - fun `the network serializer drops fields it does not know`() { - val dto = json.decodeFromString(futurePayload) - - assertEquals("Ada", dto.data.authorName) - assertEquals("CJjmUTfFWaIl8YePLhBLSQ", dto.hash) - } - - @Test - fun `downloading project data written by a newer build succeeds`() = runTest { - val engine = MockEngine { - respond( - content = futurePayload, - status = HttpStatusCode.OK, - headers = headersOf(HttpHeaders.ContentType, ContentType.Application.Json.toString()), - ) - } - val client = HttpClient(engine) { - install(ContentNegotiation) { json(json) } - } - val api = ProjectDataApi(client, globalSettingsStore, json, TestStrRes()) - - val result = api.getProjectData(userId, ProjectId("project-uuid")) - - assertTrue(result.isSuccess) - assertEquals("Ada", result.getOrThrow()?.data?.authorName) - } - - /** prettyPrint would put tabs and newlines in every request body. */ - @Test - fun `the network serializer does not pretty print`() { - assertFalse(json.configuration.prettyPrint) - } -} diff --git a/common/src/desktopTest/kotlin/server/RecordingStrRes.kt b/common/src/desktopTest/kotlin/server/RecordingStrRes.kt deleted file mode 100644 index 2dc26f86f..000000000 --- a/common/src/desktopTest/kotlin/server/RecordingStrRes.kt +++ /dev/null @@ -1,19 +0,0 @@ -package server - -import com.darkrockstudios.apps.hammer.common.util.StrRes -import org.jetbrains.compose.resources.StringResource - -/** Records which string resources a failure path asked for. */ -internal class RecordingStrRes : StrRes { - val requested = mutableListOf() - - override suspend fun get(str: StringResource): String { - requested += str - return "test" - } - - override suspend fun get(str: StringResource, vararg args: Any): String { - requested += str - return "test" - } -} diff --git a/common/src/desktopTest/kotlin/server/ServerAccountApiTest.kt b/common/src/desktopTest/kotlin/server/ServerAccountApiTest.kt index 195cac076..715205299 100644 --- a/common/src/desktopTest/kotlin/server/ServerAccountApiTest.kt +++ b/common/src/desktopTest/kotlin/server/ServerAccountApiTest.kt @@ -10,7 +10,6 @@ import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver import io.ktor.client.HttpClient import io.ktor.client.engine.mock.MockEngine import io.ktor.client.engine.mock.respond -import io.ktor.client.request.forms.FormDataContent import io.ktor.client.plugins.contentnegotiation.ContentNegotiation import io.ktor.http.HttpHeaders import io.ktor.http.HttpStatusCode @@ -99,36 +98,6 @@ class ServerAccountApiTest : BaseTest() { assertEquals(challenge, exception.challenge) } - @Test - fun `pairInstall posts the new install id for the signed-in user`() = runTest { - every { globalSettingsStore.serverSettings } returns ServerSettings( - ssl = false, - url = "example.com", - email = "user@example.com", - userId = 7L, - bearerToken = "bearer", - refreshToken = "refresh", - ) - var requestPath: String? = null - var sentInstallId: String? = null - val engine = MockEngine { request -> - requestPath = request.url.encodedPath - sentInstallId = (request.body as FormDataContent).formData["installId"] - respond( - content = """{"userId":7,"auth":"watch-auth","refresh":"watch-refresh"}""", - status = HttpStatusCode.Created, - headers = jsonHeaders, - ) - } - val api = createApi(engine) - - val result = api.pairInstall("watch-install") - - assertEquals("/api/account/pair_install/7", requestPath) - assertEquals("watch-install", sentInstallId) - assertEquals("watch-auth", result.getOrThrow().auth) - } - @Test fun `a 451 with a malformed body falls through to the default failure`() = runTest { val engine = MockEngine { diff --git a/common/src/desktopTest/kotlin/synchronizer/ClientAccountSynchronizerTest.kt b/common/src/desktopTest/kotlin/synchronizer/ClientAccountSynchronizerTest.kt index 4467dc223..3b9acd8a6 100644 --- a/common/src/desktopTest/kotlin/synchronizer/ClientAccountSynchronizerTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/ClientAccountSynchronizerTest.kt @@ -25,12 +25,6 @@ import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath import com.darkrockstudios.apps.hammer.common.server.HttpFailureException import com.darkrockstudios.apps.hammer.common.server.ServerProjectsApi import com.darkrockstudios.apps.hammer.common.util.NetworkConnectivity -import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.sync_log_account_project_create_local_failure -import com.darkrockstudios.apps.hammer.sync_log_account_project_create_server_success -import com.darkrockstudios.apps.hammer.sync_log_account_project_id_save_failure -import org.jetbrains.compose.resources.StringResource import io.ktor.http.* import io.mockk.* import kotlinx.coroutines.test.runTest @@ -96,7 +90,7 @@ class ClientAccountSynchronizerTest { error = HttpResponseError(error = "Unauthorized", displayMessage = "nope"), ) - private fun createSynchronizer(strRes: StrRes = TestStrRes()) = ClientAccountSynchronizer( + private fun createSynchronizer() = ClientAccountSynchronizer( fileSystem = ffs, globalSettingsStore = globalSettingsStore, projectsRepository = projectsRepository, @@ -105,23 +99,9 @@ class ClientAccountSynchronizerTest { networkConnectivity = networkConnectivity, json = json, toml = Toml, - strRes = strRes, + strRes = TestStrRes(), ) - private class RecordingStrRes : StrRes { - val calls = mutableListOf>>() - - override suspend fun get(str: StringResource): String { - calls.add(str to emptyList()) - return "test" - } - - override suspend fun get(str: StringResource, vararg args: Any): String { - calls.add(str to args.toList()) - return "test" - } - } - @BeforeEach fun setup() { ffs = FakeFileSystem() @@ -454,97 +434,10 @@ class ClientAccountSynchronizerTest { assertTrue(result) coVerify { serverProjectsApi.createProject("LocalNovel", "sync-1") } - coVerify { projectsRepository.setProjectId(def, newId) } + verify { projectsRepository.setProjectId(def, newId) } assertTrue(readSyncData().projectsToCreate.isEmpty()) } - @Test - fun `syncProjects keeps the queued creation and logs an id-save failure when saving the new id fails`() = runTest { - writeSyncData(emptySyncData().copy(projectsToCreate = setOf("LocalNovel"))) - val def = projectDef("LocalNovel") - val newId = ProjectId.randomUUID() - - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns null - every { projectsRepository.getProjectDefinition("LocalNovel") } returns def - coEvery { serverProjectsApi.createProject("LocalNovel", "sync-1") } returns - Result.success(CreateProjectResponse(newId, alreadyExisted = false)) - coEvery { projectsRepository.setProjectId(def, newId) } throws IllegalStateException("disk error") - - val strRes = RecordingStrRes() - val result = createSynchronizer(strRes).syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // The entry must survive so the next sync can retry saving the id. - assertEquals(setOf("LocalNovel"), readSyncData().projectsToCreate) - val resources = strRes.calls.map { it.first } - assertTrue(resources.contains(Res.string.sync_log_account_project_id_save_failure)) - assertFalse(resources.contains(Res.string.sync_log_account_project_create_server_success)) - } - - @Test - fun `syncProjects recreates a project whose cached id the server neither holds nor tombstoned`() = runTest { - writeSyncData(emptySyncData()) - val staleId = ProjectId.randomUUID() - val freshId = ProjectId.randomUUID() - val def = projectDef("ResetServerNovel") - - // The server has no record of this id at all: not a live project, not a tombstone. - // This is what a client sees after syncing against a different or since-reset server. - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns staleId - every { projectsRepository.getProjectDefinition("ResetServerNovel") } returns def - coEvery { serverProjectsApi.createProject("ResetServerNovel", "sync-1") } returns - Result.success(CreateProjectResponse(freshId, alreadyExisted = false)) - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - coVerify { serverProjectsApi.createProject("ResetServerNovel", "sync-1") } - coVerify { projectsRepository.setProjectId(def, freshId) } - } - - @Test - fun `syncProjects does not recreate a project whose cached id the server still lists`() = runTest { - writeSyncData(emptySyncData()) - val id = ProjectId.randomUUID() - val def = projectDef("KnownNovel") - - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy(projects = setOf(ApiProjectDefinition("KnownNovel", id))) - ) - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns id - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - } - - @Test - fun `syncProjects does not resurrect a project queued for deletion that is still on disk`() = runTest { - val id = ProjectId.randomUUID() - val def = projectDef("DoomedNovel") - writeSyncData(emptySyncData().copy(projectsToDelete = setOf(id))) - - // processProjectSyncData strips a queued-for-deletion project out of the server list, so - // liveness has to be judged against the raw begin_sync response. The local folder is still - // present here (restored by a file-sync tool), which is what puts it back in getProjects. - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy(projects = setOf(ApiProjectDefinition("DoomedNovel", id))) - ) - coEvery { serverProjectsApi.deleteProject(id, "sync-1") } returns Result.success("ok") - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns id - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - coVerify { serverProjectsApi.deleteProject(id, "sync-1") } - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - } - @Test fun `syncProjects deletes a server project this client marked for deletion`() = runTest { val id = ProjectId.randomUUID() @@ -574,51 +467,13 @@ class ClientAccountSynchronizerTest { val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) assertTrue(result) - coVerify { projectsRepository.deleteProject(def) } - } - - @Test - fun `syncProjects drops a rename queued against an id the server never knew`() = runTest { - val deadId = ProjectId.randomUUID() - writeSyncData(emptySyncData().copy(projectsToRename = setOf(RenamedProject(deadId, "NewName")))) - every { projectsRepository.getProjects(any()) } returns emptyList() - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // Attempting it would fail every session forever and log an error each time. - coVerify(exactly = 0) { serverProjectsApi.renameProject(any(), any(), any()) } - assertTrue(readSyncData().projectsToRename.isEmpty()) - } - - @Test - fun `syncProjects withdraws a queued creation whose local project is gone`() = runTest { - writeSyncData(emptySyncData().copy(projectsToCreate = setOf("DeletedBeforeSync"))) - every { projectsRepository.getProjects(any()) } returns emptyList() - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - assertTrue(readSyncData().projectsToCreate.isEmpty()) - } - - @Test - fun `deleteUnsyncedProject withdraws the queued creation`() { - writeSyncData(emptySyncData().copy(projectsToCreate = setOf("Draft", "Keeper"))) - - createSynchronizer().deleteUnsyncedProject("Draft") - - assertEquals(setOf("Keeper"), readSyncData().projectsToCreate) + verify { projectsRepository.deleteProject(def) } } @Test fun `syncProjects renames a project on the server`() = runTest { val id = ProjectId.randomUUID() writeSyncData(emptySyncData().copy(projectsToRename = setOf(RenamedProject(id, "NewName")))) - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy(projects = setOf(ApiProjectDefinition("OldName", id))) - ) every { projectsRepository.getProjects(any()) } returns emptyList() coEvery { serverProjectsApi.renameProject(id, "sync-1", "NewName") } returns Result.success("ok") @@ -629,61 +484,6 @@ class ClientAccountSynchronizerTest { assertTrue(readSyncData().projectsToRename.isEmpty()) } - @Test - fun `syncProjects frees a deleted project's name before renaming another project into it`() = runTest { - val deletedId = ProjectId.randomUUID() - val keptId = ProjectId.randomUUID() - val keptDef = projectDef("FooBar") - - writeSyncData( - emptySyncData().copy( - projectsToDelete = setOf(deletedId), - projectsToRename = setOf(RenamedProject(keptId, "FooBar")), - ) - ) - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy( - projects = setOf( - ApiProjectDefinition("FooBar", deletedId), - ApiProjectDefinition("FooBar V2", keptId), - ) - ) - ) - coEvery { serverProjectsApi.deleteProject(deletedId, "sync-1") } returns Result.success("ok") - coEvery { serverProjectsApi.renameProject(keptId, "sync-1", "FooBar") } returns Result.success("ok") - every { projectsRepository.getProjects(any()) } returns listOf(keptDef) - every { projectsRepository.getProjectId(keptDef) } returns keptId - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // A project name is unique per account on the server, so renaming first collides with - // the project this same sync is about to delete. - coVerifyOrder { - serverProjectsApi.deleteProject(deletedId, "sync-1") - serverProjectsApi.renameProject(keptId, "sync-1", "FooBar") - } - assertTrue(readSyncData().projectsToRename.isEmpty()) - } - - @Test - fun `syncProjects drops a rename queued against a project the server has deleted`() = runTest { - val id = ProjectId.randomUUID() - val def = projectDef("GoneNovel") - writeSyncData(emptySyncData().copy(projectsToRename = setOf(RenamedProject(id, "NewName")))) - coEvery { serverProjectsApi.beginProjectsSync() } returns - Result.success(emptyServerResponse().copy(deletedProjects = setOf(id))) - every { projectsRepository.findProject(id) } returns def - every { projectsRepository.getProjects(any()) } returns emptyList() - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // The project is gone on both sides; the rename could only 404 and requeue forever. - coVerify(exactly = 0) { serverProjectsApi.renameProject(any(), any(), any()) } - assertTrue(readSyncData().projectsToRename.isEmpty()) - } - @Test fun `syncProjects does not recreate a project deleted locally that the server still lists`() = runTest { val id = ProjectId.randomUUID() @@ -696,14 +496,14 @@ class ClientAccountSynchronizerTest { coEvery { serverProjectsApi.deleteProject(id, "sync-1") } returns Result.success("ok") every { projectsRepository.getProjects(any()) } returns emptyList() every { projectsRepository.findProject(any()) } returns null - every { projectsRepository.createProject(any(), any()) } returns CResult.success(projectDef("DeadNovel")) + every { projectsRepository.createProject(any()) } returns CResult.success(projectDef("DeadNovel")) val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) assertTrue(result) coVerify { serverProjectsApi.deleteProject(id, "sync-1") } - coVerify(exactly = 0) { projectsRepository.createProject(any(), any()) } - coVerify(exactly = 0) { projectsRepository.setProjectId(any(), any()) } + verify(exactly = 0) { projectsRepository.createProject(any()) } + verify(exactly = 0) { projectsRepository.setProjectId(any(), any()) } } @Test @@ -717,148 +517,13 @@ class ClientAccountSynchronizerTest { Result.success(emptyServerResponse().copy(projects = setOf(serverProject))) every { projectsRepository.getProjects(any()) } returns emptyList() every { projectsRepository.findProject("ServerNovel") } returns null - every { projectsRepository.createProject("ServerNovel", any()) } returns CResult.success(createdDef) + every { projectsRepository.createProject("ServerNovel") } returns CResult.success(createdDef) val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) assertTrue(result) - coVerify { projectsRepository.createProject("ServerNovel", any()) } - coVerify { projectsRepository.setProjectId(createdDef, serverId) } - } - - @Test - fun `syncProjects logs the project name when local creation from a server project fails`() = runTest { - writeSyncData(emptySyncData()) - val serverId = ProjectId.randomUUID() - val serverProject = ApiProjectDefinition(name = "ServerNovel", uuid = serverId) - - coEvery { serverProjectsApi.beginProjectsSync() } returns - Result.success(emptyServerResponse().copy(projects = setOf(serverProject))) - every { projectsRepository.getProjects(any()) } returns emptyList() - every { projectsRepository.findProject("ServerNovel") } returns null - every { projectsRepository.createProject("ServerNovel", any()) } returns - CResult.failure(error = "creation failed") - - val strRes = RecordingStrRes() - val result = createSynchronizer(strRes).syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - val logged = strRes.calls.single { it.first == Res.string.sync_log_account_project_create_local_failure } - assertEquals(listOf("ServerNovel"), logged.second) - } - - @Test - fun `syncProjects adopts a same-named server project instead of uploading a duplicate`() = runTest { - writeSyncData(emptySyncData()) - val serverId = ProjectId.randomUUID() - val duplicateId = ProjectId.randomUUID() - val def = projectDef("MyNovel") - - // Same name on both sides, and the local copy has never been synced anywhere. - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy(projects = setOf(ApiProjectDefinition("MyNovel", serverId))) - ) - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns null - every { projectsRepository.findProject("MyNovel") } returns def - every { projectsRepository.getProjectDefinition("MyNovel") } returns def - coEvery { serverProjectsApi.createProject("MyNovel", "sync-1") } returns - Result.success(CreateProjectResponse(duplicateId, alreadyExisted = false)) - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // Uploading first would leave an orphan second "MyNovel" on the server that every - // other device then downloads as an empty duplicate. - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - coVerify { projectsRepository.setProjectId(def, serverId) } - coVerify(exactly = 0) { projectsRepository.setProjectId(def, duplicateId) } - } - - @Test - fun `syncProjects withdraws a queued creation the server already holds under that name`() = runTest { - writeSyncData(emptySyncData().copy(projectsToCreate = setOf("MyNovel"))) - val serverId = ProjectId.randomUUID() - val duplicateId = ProjectId.randomUUID() - val def = projectDef("MyNovel") - - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy(projects = setOf(ApiProjectDefinition("MyNovel", serverId))) - ) - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns null - every { projectsRepository.findProject("MyNovel") } returns def - every { projectsRepository.getProjectDefinition("MyNovel") } returns def - coEvery { serverProjectsApi.createProject("MyNovel", "sync-1") } returns - Result.success(CreateProjectResponse(duplicateId, alreadyExisted = false)) - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - coVerify { projectsRepository.setProjectId(def, serverId) } - // Left queued, it would try to duplicate the project again on every future sync. - assertTrue(readSyncData().projectsToCreate.isEmpty()) - } - - @Test - fun `syncProjects leaves a project bound to a live server project alone when another shares its name`() = runTest { - writeSyncData(emptySyncData()) - val liveId = ProjectId.randomUUID() - val orphanId = ProjectId.randomUUID() - val def = projectDef("My Novel") - - // An account that still carries an orphan duplicate from the old upload-first ordering: - // its name sanitizes to the name of a local project already bound to a different server - // project. - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy( - projects = setOf( - ApiProjectDefinition("My Novel", liveId), - ApiProjectDefinition("My#Novel", orphanId), - ) - ) - ) - every { projectsRepository.getProjects(any()) } returns listOf(def) - every { projectsRepository.getProjectId(def) } returns liveId - every { projectsRepository.findProject("My Novel") } returns def - every { projectsRepository.getProjectDefinition("My Novel") } returns def - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - // Adopting the orphan abandons the server project actually holding the manuscript. - coVerify(exactly = 0) { projectsRepository.setProjectId(def, orphanId) } - coVerify(exactly = 0) { serverProjectsApi.createProject(any(), any()) } - } - - @Test - fun `syncProjects binds only the first of two server projects sharing one local name`() = runTest { - writeSyncData(emptySyncData()) - val firstId = ProjectId.randomUUID() - val secondId = ProjectId.randomUUID() - val createdDef = projectDef("My Novel") - - coEvery { serverProjectsApi.beginProjectsSync() } returns Result.success( - emptyServerResponse().copy( - projects = setOf( - ApiProjectDefinition("My Novel", firstId), - ApiProjectDefinition("My#Novel", secondId), - ) - ) - ) - every { projectsRepository.getProjects(any()) } returns emptyList() - every { projectsRepository.findProject("My Novel") } returnsMany listOf(null, createdDef) - every { projectsRepository.createProject("My Novel", any()) } returns CResult.success(createdDef) - every { projectsRepository.getProjectId(createdDef) } returns firstId - - val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) - - assertTrue(result) - verify(exactly = 1) { projectsRepository.createProject("My Novel", any()) } - coVerify { projectsRepository.setProjectId(createdDef, firstId) } - // The second one would silently steal the only local project the first just claimed. - coVerify(exactly = 0) { projectsRepository.setProjectId(createdDef, secondId) } + verify { projectsRepository.createProject("ServerNovel") } + verify { projectsRepository.setProjectId(createdDef, serverId) } } @Test @@ -874,13 +539,13 @@ class ClientAccountSynchronizerTest { Result.success(emptyServerResponse().copy(projects = setOf(serverProject))) every { projectsRepository.getProjects(any()) } returns emptyList() every { projectsRepository.findProject(safeName) } returns null - every { projectsRepository.createProject(safeName, any()) } returns CResult.success(createdDef) + every { projectsRepository.createProject(safeName) } returns CResult.success(createdDef) val result = createSynchronizer().syncProjects(onLog = {}, onUnauthorized = {}) assertTrue(result) - coVerify { projectsRepository.createProject(safeName, any()) } - coVerify(exactly = 0) { projectsRepository.createProject(mangledName, any()) } - coVerify { projectsRepository.setProjectId(createdDef, serverId) } + verify { projectsRepository.createProject(safeName) } + verify(exactly = 0) { projectsRepository.createProject(mangledName) } + verify { projectsRepository.setProjectId(createdDef, serverId) } } } diff --git a/common/src/desktopTest/kotlin/synchronizer/ClientEncyclopediaSynchronizerTest.kt b/common/src/desktopTest/kotlin/synchronizer/ClientEncyclopediaSynchronizerTest.kt index 2406d5178..407e98f37 100644 --- a/common/src/desktopTest/kotlin/synchronizer/ClientEncyclopediaSynchronizerTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/ClientEncyclopediaSynchronizerTest.kt @@ -271,9 +271,7 @@ class ClientEncyclopediaSynchronizerTest : BaseTest() { assertTrue(stored) assertEquals("Stored anyway", repository.loadEntry(entry1().id).entry.text) - // Storing rewrites the entry file itself, so count files rather than compare paths. - assertEquals(before.size, allRegularFiles().size, "No file may be created anywhere") - assertNull(datasource.findEntryImagePath(entry1().toDef(projectDef))) + assertEquals(before, allRegularFiles()) } @Test @@ -289,8 +287,7 @@ class ClientEncyclopediaSynchronizerTest : BaseTest() { val before = allRegularFiles() sync.storeEntity(serverEntity, syncId = "sync", onLog = {}) - assertEquals(before.size, allRegularFiles().size, "No file may be created anywhere") - assertNull(datasource.findEntryImagePath(entry1().toDef(projectDef))) + assertEquals(before, allRegularFiles()) } @Test diff --git a/common/src/desktopTest/kotlin/synchronizer/ClientProjectSynchronizerTest.kt b/common/src/desktopTest/kotlin/synchronizer/ClientProjectSynchronizerTest.kt index 570b664ec..223158ada 100644 --- a/common/src/desktopTest/kotlin/synchronizer/ClientProjectSynchronizerTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/ClientProjectSynchronizerTest.kt @@ -205,7 +205,7 @@ class ClientProjectSynchronizerTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val success = syncer.sync( onProgress = onProgress, @@ -322,7 +322,7 @@ class ClientProjectSynchronizerTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val success = syncer.sync( onProgress = onProgress, @@ -448,7 +448,7 @@ class ClientProjectSynchronizerTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val onUnauthorized = mockk Unit>(relaxed = true) val success = syncer.sync( diff --git a/common/src/desktopTest/kotlin/synchronizer/ClientSceneDraftSynchronizerSecurityTest.kt b/common/src/desktopTest/kotlin/synchronizer/ClientSceneDraftSynchronizerSecurityTest.kt index 14b04397f..d8da9ec5e 100644 --- a/common/src/desktopTest/kotlin/synchronizer/ClientSceneDraftSynchronizerSecurityTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/ClientSceneDraftSynchronizerSecurityTest.kt @@ -106,51 +106,12 @@ class ClientSceneDraftSynchronizerSecurityTest : BaseTest() { .toSet() @Test - fun `a traversal draft name escaping with dot-dot cannot leave the drafts directory`() = runTest { - val before = allFiles() - - val stored = newSynchronizer().storeEntity( - draftEntity("../../../../evil"), - syncId = "sync", - onLog = {}, - ) - - assertTrue(stored) - assertEquals( - setOf(datasource.getDraftPath(repository.getDraftDef(500)!!).path), - allFiles() - before, - "The only new file must be the draft, inside the drafts directory", - ) - } - - @Test - fun `a draft name with an embedded slash is stored as a single file`() = runTest { - val before = allFiles() - - val stored = newSynchronizer().storeEntity( - draftEntity("a/b"), - syncId = "sync", - onLog = {}, - ) - - assertTrue(stored) - val written = (allFiles() - before).single() - assertTrue( - written.startsWith(datasource.getDraftsDirectory().path), - "Draft must land inside the drafts directory, was: $written", - ) - // The separator survives as a lookalike, so the name round-trips without ever - // being a real path separator on disk. - assertEquals("a/b", repository.getDraftDef(500)?.draftName) - } - - @Test - fun `a draft name using the reserved delimiter is rejected and writes no file`() = runTest { + fun `a traversal draft name escaping with dot-dot is rejected and writes no file`() = runTest { val before = allFiles() val logs = mutableListOf() val stored = newSynchronizer().storeEntity( - draftEntity("evil~name"), + draftEntity("../../../../evil"), syncId = "sync", onLog = { logs.add(it) }, ) @@ -161,19 +122,17 @@ class ClientSceneDraftSynchronizerSecurityTest : BaseTest() { } @Test - fun `a name the old rules allowed still syncs, stored trimmed`() = runTest { - // Older clients let a trailing space through, so drafts named this way already exist on - // the server. Rejecting them here would strand them permanently. + fun `a draft name with an embedded slash is rejected and writes no file`() = runTest { + val before = allFiles() + val stored = newSynchronizer().storeEntity( - draftEntity("My Draft "), + draftEntity("a/b"), syncId = "sync", onLog = {}, ) - assertTrue(stored) - val def = repository.getDraftDef(500) - assertEquals("My Draft", def?.draftName) - assertEquals("PWNED", repository.loadDraftContent(def!!)) + assertFalse(stored) + assertEquals(before, allFiles()) } @Test diff --git a/common/src/desktopTest/kotlin/synchronizer/SceneSynchronizerTest.kt b/common/src/desktopTest/kotlin/synchronizer/SceneSynchronizerTest.kt index e92171f5a..18dc04a48 100644 --- a/common/src/desktopTest/kotlin/synchronizer/SceneSynchronizerTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/SceneSynchronizerTest.kt @@ -365,16 +365,6 @@ class SceneSynchronizerTest : BaseTest() { coVerify(exactly = 1) { sceneEditorService.createGroup(any(), any(), any(), any()) } } - @Test - fun `prepare and finalize never persist unsaved buffers`() = runTest { - val sync = defaultSceneSynchronizer() - - sync.prepareForSync() - sync.finalizeSync() - - coVerify(exactly = 0) { sceneEditorService.storeAllBuffers() } - } - @Test fun `ownsEntity - includes archived scenes`() = runTest { //////////////////// @@ -529,7 +519,6 @@ class SceneSynchronizerTest : BaseTest() { sceneEditorService.storeMetadata( match { it.tags == setOf("magic", "spoiler") }, sceneId, - UpdateSource.Sync, ) } } diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/BackupOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/BackupOperationTest.kt index 15f8b0a5b..0874249db 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/BackupOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/BackupOperationTest.kt @@ -63,7 +63,7 @@ class BackupOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, @@ -99,7 +99,7 @@ class BackupOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, @@ -135,7 +135,7 @@ class BackupOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/CollateIdsOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/CollateIdsOperationTest.kt index ac29dbec6..226a097ae 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/CollateIdsOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/CollateIdsOperationTest.kt @@ -50,7 +50,7 @@ class CollateIdsOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = FetchServerDataState( onlyNew = false, diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/EnsureProjectIdOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/EnsureProjectIdOperationTest.kt index 86a6c0508..b0303a6aa 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/EnsureProjectIdOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/EnsureProjectIdOperationTest.kt @@ -101,7 +101,7 @@ class EnsureProjectIdOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( @@ -146,7 +146,7 @@ class EnsureProjectIdOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( @@ -190,7 +190,7 @@ class EnsureProjectIdOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val logs = mutableListOf() val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( @@ -230,7 +230,7 @@ class EnsureProjectIdOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val logs = mutableListOf() val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/EntityDeleteOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/EntityDeleteOperationTest.kt index be319f4b0..5c5337e6d 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/EntityDeleteOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/EntityDeleteOperationTest.kt @@ -62,7 +62,7 @@ class EntityDeleteOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = IdConflictResolutionState( onlyNew = false, diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/EntityTransferOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/EntityTransferOperationTest.kt index 1283b896b..4817c47da 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/EntityTransferOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/EntityTransferOperationTest.kt @@ -140,7 +140,7 @@ class EntityTransferOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = EntityDeleteOperationState( onlyNew = false, diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/FetchLocalDataOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/FetchLocalDataOperationTest.kt index b01b55039..b533279b9 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/FetchLocalDataOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/FetchLocalDataOperationTest.kt @@ -110,7 +110,7 @@ class FetchLocalDataOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( @@ -206,7 +206,7 @@ class FetchLocalDataOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( @@ -240,7 +240,7 @@ class FetchLocalDataOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/FetchServerDataOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/FetchServerDataOperationTest.kt index 6c5ac5373..e9f35469c 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/FetchServerDataOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/FetchServerDataOperationTest.kt @@ -2,27 +2,22 @@ package synchronizer.operations import PROJECT_2_NAME import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.http.HttpResponseError import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings import com.darkrockstudios.apps.hammer.common.data.isSuccess import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.* import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.operations.FetchServerDataOperation import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.server.HttpFailureException import com.darkrockstudios.apps.hammer.common.server.ServerProjectApi import getProjectDef -import io.ktor.http.HttpStatusCode import io.mockk.MockKAnnotations import io.mockk.coEvery import io.mockk.coVerify import io.mockk.every import io.mockk.impl.annotations.MockK import io.mockk.mockk -import io.mockk.verify import kotlinx.coroutines.test.runTest import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Test @@ -50,9 +45,6 @@ class FetchServerDataOperationTest : BaseTest() { @MockK(relaxed = true) private lateinit var serverProjectApi: ServerProjectApi - @MockK(relaxed = true) - private lateinit var projectsRepository: ProjectsRepository - private lateinit var strRes: TestStrRes @BeforeEach @@ -81,7 +73,6 @@ class FetchServerDataOperationTest : BaseTest() { strRes = strRes, projectMetadataDatasource = projectMetadataDatasource, globalSettingsStore = globalSettingsStore, - projectsRepository = projectsRepository, serverProjectApi = serverProjectApi, ) } @@ -110,7 +101,7 @@ class FetchServerDataOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = FetchLocalDataState( onlyNew = false, @@ -168,7 +159,7 @@ class FetchServerDataOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = FetchLocalDataState( onlyNew = false, @@ -186,67 +177,4 @@ class FetchServerDataOperationTest : BaseTest() { assertFalse(isSuccess(result)) } - - @Test - fun `A generic failure leaves the cached project id alone`() = runTest { - val projectDef = getProjectDef(PROJECT_2_NAME) - val op = createOperation(projectDef) - - stubSettingsAndMetadata() - coEvery { serverProjectApi.beginProjectSync(any(), any(), any(), any()) } returns - Result.failure(Exception("Test Failure")) - - val result = execute(op) - - assertFalse(isSuccess(result)) - // Only a 410 proves the id is dead; a transient failure must not discard it. - coVerify(exactly = 0) { projectsRepository.removeProjectId(any()) } - } - - @Test - fun `A 410 Gone drops the dead project id so the next sync can recreate it`() = runTest { - val projectDef = getProjectDef(PROJECT_2_NAME) - val op = createOperation(projectDef) - - stubSettingsAndMetadata() - coEvery { serverProjectApi.beginProjectSync(any(), any(), any(), any()) } returns - Result.failure( - HttpFailureException( - statusCode = HttpStatusCode.Gone, - error = HttpResponseError( - error = "Project Not Found", - displayMessage = "Project does not exist", - ), - ) - ) - - val result = execute(op) - - assertFalse(isSuccess(result)) - coVerify { projectsRepository.removeProjectId(projectDef) } - } - - private suspend fun stubSettingsAndMetadata() { - coEvery { globalSettingsStore.serverSettingsUpdates } returns sharedFlow { - emit( - mockk().apply { - every { userId } returns 1L - } - ) - } - coEvery { projectMetadataDatasource.loadMetadata(any()) } returns metadata - } - - private suspend fun execute(op: FetchServerDataOperation) = op.execute( - state = FetchLocalDataState( - onlyNew = false, - clientSyncData = projectData, - entityState = entityState, - serverProjectId = projId, - ), - onProgress = mockk(relaxed = true), - onLog = mockk(relaxed = true), - onConflict = mockk(relaxed = true), - onComplete = mockk(relaxed = true), - ) } \ No newline at end of file diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/FinalizeSyncOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/FinalizeSyncOperationTest.kt index 1fb459da5..bd6bf2a1c 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/FinalizeSyncOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/FinalizeSyncOperationTest.kt @@ -121,7 +121,7 @@ class FinalizeSyncOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = EntityTransferState( onlyNew = false, @@ -153,7 +153,7 @@ class FinalizeSyncOperationTest : BaseTest() { coVerify { serverProjectApi.endProjectSync(1L, projId, beganResponse.syncId, 12, clock.now()) } // Downloaded ids may sit above the allocator's sync-start snapshot; it must re-derive. coVerify { idAllocator.findNextId() } - coVerify { onComplete(true) } + coVerify { onComplete() } val saved = slot() coVerify { syncDataDatasource.saveSyncData(capture(saved)) } diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/IdConflictResolutionOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/IdConflictResolutionOperationTest.kt index fdac87e6f..e42325bba 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/IdConflictResolutionOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/IdConflictResolutionOperationTest.kt @@ -75,7 +75,7 @@ class IdConflictResolutionOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, @@ -155,7 +155,7 @@ class IdConflictResolutionOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, @@ -217,7 +217,7 @@ class IdConflictResolutionOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = CollateIdsState( onlyNew = false, diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/PrepareForSyncOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/PrepareForSyncOperationTest.kt index 1ea5bebc7..67c00c3ed 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/PrepareForSyncOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/PrepareForSyncOperationTest.kt @@ -70,7 +70,7 @@ class PrepareForSyncOperationTest : BaseTest() { val onProgress = mockk Unit>(relaxed = true) val onLog = mockk(relaxed = true) val onConflict = mockk>(relaxed = true) - val onComplete = mockk Unit>(relaxed = true) + val onComplete = mockk Unit>(relaxed = true) val initialState = InitialSyncOperationState(false) val result = op.execute( diff --git a/common/src/desktopTest/kotlin/synchronizer/operations/ProjectDataSyncOperationTest.kt b/common/src/desktopTest/kotlin/synchronizer/operations/ProjectDataSyncOperationTest.kt index c4d50b2d1..1578933ab 100644 --- a/common/src/desktopTest/kotlin/synchronizer/operations/ProjectDataSyncOperationTest.kt +++ b/common/src/desktopTest/kotlin/synchronizer/operations/ProjectDataSyncOperationTest.kt @@ -256,28 +256,6 @@ class ProjectDataSyncOperationTest : BaseTest() { coVerify(exactly = 1) { api.uploadProjectData(any(), any(), local, "stale-hash") } } - @Test - fun `a word added while the upload is in flight is kept and left pending`() = runTest { - val local = ProjectData(authorName = "Local Edit") - datasource.save(StoredProjectData(local, lastSyncedHash = "stale-hash")) - coEvery { api.getProjectData(any(), any()) } returns - Result.success(ProjectDataDto(ProjectData(authorName = "Server"), "server-hash")) - coEvery { - api.uploadProjectData(any(), any(), local, "stale-hash") - } coAnswers { - repository.updateData { it.copy(dictionaryWords = it.dictionaryWords + "kvothe") } - Result.success(ProjectDataDto(local, "new-hash")) - } - - val result = createOperation().run() - - assertTrue(isSuccess(result)) - val stored = repository.state.value - assertEquals(local.copy(dictionaryWords = setOf("kvothe")), stored?.data) - // The baseline is what the server holds, so the concurrent add uploads next time. - assertEquals("new-hash", stored?.lastSyncedHash) - } - @Test fun `a non-conflict upload failure fails the sync`() = runTest { val local = ProjectData(authorName = "Local Edit") @@ -333,61 +311,6 @@ class ProjectDataSyncOperationTest : BaseTest() { watcher.cancel() } - @Test - fun `a dictionary-only conflict merges both sides without a resolver`() = runTest { - val local = ProjectData(authorName = "Author", dictionaryWords = setOf("local")) - datasource.save(StoredProjectData(local, lastSyncedHash = "stale-hash")) - val server = ProjectData(authorName = "Author", dictionaryWords = setOf("server")) - coEvery { api.getProjectData(any(), any()) } returns - Result.success(ProjectDataDto(server, "server-hash")) - coEvery { - api.uploadProjectData(any(), any(), local, "stale-hash") - } returns Result.failure( - ProjectDataConflictException(ProjectDataConflictDto(server, "server-hash")) - ) - val merged = local.copy(dictionaryWords = setOf("local", "server")) - coEvery { - api.uploadProjectData(any(), any(), merged, "server-hash") - } returns Result.success(ProjectDataDto(merged, "merged-hash")) - - val result = createOperation().run() - - assertTrue(isSuccess(result)) - assertEquals(StoredProjectData(merged, "merged-hash"), repository.state.value) - assertTrue(broker.conflicts.tryReceive().isFailure, "no conflict should reach the resolver") - } - - @Test - fun `a conflict on another field still reaches the resolver`() = runTest { - val local = ProjectData(authorName = "Local Edit", dictionaryWords = setOf("local")) - datasource.save(StoredProjectData(local, lastSyncedHash = "stale-hash")) - val server = ProjectData(authorName = "Server", dictionaryWords = setOf("server")) - coEvery { api.getProjectData(any(), any()) } returns - Result.success(ProjectDataDto(server, "server-hash")) - coEvery { - api.uploadProjectData(any(), any(), local, "stale-hash") - } returns Result.failure( - ProjectDataConflictException(ProjectDataConflictDto(server, "server-hash")) - ) - val resolved = ProjectData(authorName = "Merged", dictionaryWords = setOf("local", "server")) - coEvery { - api.uploadProjectData(any(), any(), resolved, "server-hash") - } returns Result.success(ProjectDataDto(resolved, "resolved-hash")) - - var reported: ProjectData? = null - val watcher = launch { - reported = broker.conflicts.receive().local - broker.resolve(resolved) - } - - val result = createOperation().run() - - assertTrue(isSuccess(result)) - assertEquals(local, reported) - assertEquals(StoredProjectData(resolved, "resolved-hash"), repository.state.value) - watcher.cancel() - } - @Test fun `a failed conflict-resolution upload fails the sync`() = runTest { val local = ProjectData(authorName = "Local Edit") diff --git a/common/src/desktopTest/kotlin/usecases/AccountUseCaseTest.kt b/common/src/desktopTest/kotlin/usecases/AccountUseCaseTest.kt index 0379bfd04..81a76d463 100644 --- a/common/src/desktopTest/kotlin/usecases/AccountUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/usecases/AccountUseCaseTest.kt @@ -4,7 +4,6 @@ import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge import com.darkrockstudios.apps.hammer.base.http.Token import com.darkrockstudios.apps.hammer.common.data.ClientMessage -import com.darkrockstudios.apps.hammer.common.data.ClientResult import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase import com.darkrockstudios.apps.hammer.common.data.account.ServerSetupResult import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore @@ -197,99 +196,6 @@ class AccountUseCaseTest : BaseTest() { coVerify { accountApi.createAccount("test@example.com", "password", "test-uuid", "v1") } } - private val phoneSettings = ServerSettings( - url = "hammer.ink", - email = "test@example.com", - userId = 1, - bearerToken = "phone-auth", - refreshToken = "phone-refresh", - ) - - @Test - fun `Pairing another install returns its settings and leaves this install alone`() = runTest { - every { globalSettingsStore.serverSettings } returns phoneSettings - coEvery { accountApi.pairInstall("watch-install") } returns - Result.success(Token(1, "watch-auth", "watch-refresh")) - - val result = createSut().pairInstall("watch-install") - - assertIs>(result) - assertEquals( - phoneSettings.copy(bearerToken = "watch-auth", refreshToken = "watch-refresh"), - result.data, - ) - coVerify(exactly = 0) { httpClient.updateCredentials(any()) } - coVerify(exactly = 0) { globalSettingsStore.updateServerSettings(any()) } - } - - @Test - fun `Pairing without a signed-in server fails without calling the server`() = runTest { - every { globalSettingsStore.serverSettings } returns null - - val result = createSut().pairInstall("watch-install") - - assertIs>(result) - coVerify(exactly = 0) { accountApi.pairInstall(any()) } - } - - @Test - fun `A rejected pairing reports a failure`() = runTest { - every { globalSettingsStore.serverSettings } returns phoneSettings - coEvery { accountApi.pairInstall(any()) } returns Result.failure(IOException()) - coEvery { strRes.get(Res.string.server_setup_error_unknown) } returns "Unknown error message" - - val result = createSut().pairInstall("watch-install") - - assertIs>(result) - coVerify(exactly = 0) { globalSettingsStore.updateServerSettings(any()) } - } - - @Test - fun `Applying paired settings adopts the session and stores it`() = runTest { - val watchSettings = phoneSettings.copy(bearerToken = "watch-auth", refreshToken = "watch-refresh") - val bearerTokenSlot = slot() - every { httpClient.updateCredentials(credentials = capture(bearerTokenSlot)) } just Runs - val settingsSlot = slot() - every { globalSettingsStore.updateServerSettings(settings = capture(settingsSlot)) } just Runs - - val result = createSut().applyPairedSettings(watchSettings) - - assertIs>(result) - assertEquals("watch-auth", bearerTokenSlot.captured.accessToken) - assertEquals("watch-refresh", bearerTokenSlot.captured.refreshToken) - assertEquals(watchSettings, settingsSlot.captured) - } - - @Test - fun `Paired settings without a session are refused and nothing is stored`() = runTest { - val result = createSut().applyPairedSettings(phoneSettings.copy(bearerToken = null)) - - assertIs>(result) - coVerify(exactly = 0) { httpClient.updateCredentials(any()) } - coVerify(exactly = 0) { globalSettingsStore.updateServerSettings(any()) } - } - - @Test - fun `A plaintext server is stored as plaintext`() = runTest { - val token = Token(1, "test-auth", "test-refresh") - coEvery { accountApi.login(any(), any(), any()) } returns Result.success(token) - every { httpClient.updateCredentials(any()) } just Runs - val settingsSlot = slot() - every { globalSettingsStore.updateServerSettings(settings = capture(settingsSlot)) } just Runs - - val result = createSut().setupServer( - url = "192.168.1.50:8080", - email = "writer@example.com", - password = "password", - create = false, - ssl = false, - ) - - assertIs(result) - assertEquals(false, settingsSlot.captured.ssl) - assertEquals("192.168.1.50:8080", settingsSlot.captured.url) - } - @Test fun `Login account successfully`() = runTest { val token = Token(1, "test-auth", "test-refresh") diff --git a/common/src/desktopTest/kotlin/usecases/SyncAccountUseCaseTest.kt b/common/src/desktopTest/kotlin/usecases/SyncAccountUseCaseTest.kt deleted file mode 100644 index e3d5a8a7b..000000000 --- a/common/src/desktopTest/kotlin/usecases/SyncAccountUseCaseTest.kt +++ /dev/null @@ -1,289 +0,0 @@ -package usecases - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.isSuccess -import com.darkrockstudios.apps.hammer.common.data.projectdata.ProjectDataConflictBroker -import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneEditorService -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ClientAccountSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountListener -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountUseCase -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.ClientProjectSynchronizer -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.EntityConflictHandler -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage -import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.ProjectDefScope -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.common.util.Locale -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.test.runTest -import net.peanuuutz.tomlkt.Toml -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import utils.BaseTest -import utils.TestStrRes -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class SyncAccountUseCaseTest : BaseTest() { - - private lateinit var ffs: FakeFileSystem - private lateinit var toml: Toml - private lateinit var projectsRepository: ProjectsRepository - private lateinit var metadataDatasource: ProjectMetadataDatasource - private lateinit var accountSynchronizer: ClientAccountSynchronizer - private lateinit var listener: RecordingListener - - private val projectSynchronizers = mutableMapOf() - - private class RecordingListener : SyncAccountListener { - val logs = mutableListOf() - val outcomes = mutableMapOf() - var unauthorized = 0 - - override suspend fun onLog(message: SyncLogMessage) { - logs += message - } - - override suspend fun onProjectsDiscovered(projects: List) {} - - override suspend fun onProjectProgress(projectDef: ProjectDef, progress: Float?) {} - - override suspend fun onProjectOutcome(projectDef: ProjectDef, outcome: ProjectSyncOutcome) { - outcomes[projectDef.name] = outcome - } - - override suspend fun onUnauthorized() { - unauthorized++ - } - } - - @BeforeEach - override fun setup() { - super.setup() - ffs = FakeFileSystem() - ffs.createDirectories("/projects".toPath()) - toml = createTomlSerializer() - - val globalSettingsStore = mockk() - every { globalSettingsStore.globalSettings } returns GlobalSettings(projectsDirectory = "/projects") - every { globalSettingsStore.globalSettingsUpdates } returns MutableSharedFlow() - - val deviceLocaleResolver = mockk() - every { deviceLocaleResolver.getCurrentLocale() } returns Locale.forLanguage("en", "US") - - setupKoin(module { - scope { - scoped { params -> - projectSynchronizers.getValue(params.get().name) - } - scoped { params -> ProjectDataConflictBroker(params.get()) } - scoped { mockk(relaxed = true) } - scoped { mockk(relaxed = true) } - } - }) - - metadataDatasource = ProjectMetadataDatasource(ffs, toml) - projectsRepository = ProjectsRepository( - fileSystem = ffs, - globalSettingsStore = globalSettingsStore, - projectsMetadataDatasource = metadataDatasource, - toml = toml, - json = createJsonSerializer(), - deviceLocaleResolver = deviceLocaleResolver, - ) - - accountSynchronizer = mockk(relaxed = true) - coEvery { accountSynchronizer.syncProjects(any(), any(), any(), any()) } returns true - coEvery { accountSynchronizer.probeUnchangedProjects(any()) } returns emptySet() - - projectSynchronizers.clear() - listener = RecordingListener() - } - - private fun useCase() = SyncAccountUseCase( - projectsRepository = projectsRepository, - accountSynchronizer = accountSynchronizer, - projectMetadataDatasource = metadataDatasource, - strRes = TestStrRes(), - ) - - private fun localProject(name: String, serverId: String? = null): ProjectDef { - val result = projectsRepository.createProject(name, seedDefaultLanguage = false) - if (!isSuccess(result)) error("Failed to create $name") - val def = result.data - if (serverId != null) { - metadataDatasource.updateMetadata(def) { - it.copy(info = it.info.copy(serverProjectId = ProjectId(serverId))) - } - } - return def - } - - private fun projectSyncReturns(name: String, success: Boolean): ClientProjectSynchronizer { - val synchronizer = mockk() - coEvery { synchronizer.sync(any(), any(), any(), any(), any(), any()) } returns success - projectSynchronizers[name] = synchronizer - return synchronizer - } - - @Test - fun `account sync failure fails every project without syncing any`() = runTest { - localProject("Alpha", "a") - localProject("Beta", "b") - val alphaSync = projectSyncReturns("Alpha", true) - coEvery { accountSynchronizer.syncProjects(any(), any(), any(), any()) } returns false - - val result = useCase().execute(listener) - - assertFalse(result.accountSuccess) - assertFalse(result.allSuccess) - assertEquals( - mapOf("Alpha" to ProjectSyncOutcome.Failed, "Beta" to ProjectSyncOutcome.Failed), - result.projects, - ) - assertEquals(result.projects, listener.outcomes) - coVerify(exactly = 0) { alphaSync.sync(any(), any(), any(), any(), any(), any()) } - } - - @Test - fun `every synced project is synced and reported`() = runTest { - localProject("Alpha", "a") - localProject("Beta", "b") - projectSyncReturns("Alpha", true) - projectSyncReturns("Beta", true) - - val result = useCase().execute(listener) - - assertTrue(result.allSuccess) - assertEquals( - mapOf("Alpha" to ProjectSyncOutcome.Success, "Beta" to ProjectSyncOutcome.Success), - result.projects, - ) - assertEquals(result.projects, listener.outcomes) - } - - @Test - fun `projects the probe reports unchanged are not synced`() = runTest { - localProject("Alpha", "a") - val alphaSync = projectSyncReturns("Alpha", true) - coEvery { accountSynchronizer.probeUnchangedProjects(any()) } returns setOf(ProjectId("a")) - - val result = useCase().execute(listener) - - assertTrue(result.allSuccess) - assertEquals(ProjectSyncOutcome.Unchanged, result.projects["Alpha"]) - coVerify(exactly = 0) { alphaSync.sync(any(), any(), any(), any(), any(), any()) } - } - - @Test - fun `a project without a server id is reported but not synced`() = runTest { - localProject("Draft") - - val result = useCase().execute(listener) - - assertTrue(result.allSuccess) - assertEquals(ProjectSyncOutcome.NotOnServer, result.projects["Draft"]) - } - - @Test - fun `the filter skips excluded projects and keeps them out of the probe`() = runTest { - localProject("Alpha", "a") - localProject("Beta", "b") - projectSyncReturns("Alpha", true) - val betaSync = projectSyncReturns("Beta", true) - - val result = useCase().execute(listener) { it.projectId == ProjectId("a") } - - assertTrue(result.allSuccess) - assertEquals(ProjectSyncOutcome.Success, result.projects["Alpha"]) - assertEquals(ProjectSyncOutcome.Skipped, result.projects["Beta"]) - coVerify(exactly = 0) { betaSync.sync(any(), any(), any(), any(), any(), any()) } - coVerify { - accountSynchronizer.probeUnchangedProjects(match { list -> list.map { it.projectId } == listOf(ProjectId("a")) }) - } - } - - @Test - fun `an exception in one project fails only that project`() = runTest { - localProject("Alpha", "a") - localProject("Beta", "b") - projectSyncReturns("Alpha", true) - val betaSync = mockk() - coEvery { betaSync.sync(any(), any(), any(), any(), any(), any()) } throws IllegalStateException("boom") - projectSynchronizers["Beta"] = betaSync - - val result = useCase().execute(listener) - - assertFalse(result.allSuccess) - assertEquals(ProjectSyncOutcome.Success, result.projects["Alpha"]) - assertEquals(ProjectSyncOutcome.Failed, result.projects["Beta"]) - } - - @Test - fun `an entity conflict leaves the project needing resolution`() = runTest { - localProject("Alpha", "a") - val alphaSync = mockk() - coEvery { alphaSync.sync(any(), any(), any(), any(), any(), any()) } coAnswers { - arg>(2).invoke(mockk(relaxed = true)) - true - } - projectSynchronizers["Alpha"] = alphaSync - - val result = useCase().execute(listener) - - assertFalse(result.allSuccess) - assertEquals(ProjectSyncOutcome.NeedsResolution, result.projects["Alpha"]) - } - - @Test - fun `unauthorized from account and project sync both reach the listener`() = runTest { - localProject("Alpha", "a") - coEvery { accountSynchronizer.syncProjects(any(), any(), any(), any()) } coAnswers { - secondArg Unit>().invoke() - true - } - val alphaSync = mockk() - coEvery { alphaSync.sync(any(), any(), any(), any(), any(), any()) } coAnswers { - arg Unit>(5).invoke() - false - } - projectSynchronizers["Alpha"] = alphaSync - - useCase().execute(listener) - - assertEquals(2, listener.unauthorized) - } - - @Test - fun `an ideas failure fails the overall result but projects still sync`() = runTest { - localProject("Alpha", "a") - projectSyncReturns("Alpha", true) - coEvery { accountSynchronizer.syncProjects(any(), any(), any(), any()) } coAnswers { - arg<(Boolean) -> Unit>(3).invoke(false) - true - } - - val result = useCase().execute(listener) - - assertFalse(result.ideasSuccess) - assertFalse(result.allSuccess) - assertEquals(ProjectSyncOutcome.Success, result.projects["Alpha"]) - } -} diff --git a/common/src/desktopTest/kotlin/usecases/globalsearch/SearchProjectUseCaseTest.kt b/common/src/desktopTest/kotlin/usecases/globalsearch/SearchProjectUseCaseTest.kt index 509ec509d..c6cbb7087 100644 --- a/common/src/desktopTest/kotlin/usecases/globalsearch/SearchProjectUseCaseTest.kt +++ b/common/src/desktopTest/kotlin/usecases/globalsearch/SearchProjectUseCaseTest.kt @@ -20,13 +20,10 @@ import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneCo import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneMetadataRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.SceneRepository import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata -import com.darkrockstudios.apps.hammer.common.data.search.MarkdownProjector -import com.darkrockstudios.apps.hammer.common.data.search.markdownContains import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineContainer import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineEvent import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.util.ScanBuffers import io.mockk.coEvery import io.mockk.every import io.mockk.mockk @@ -81,29 +78,6 @@ class SearchProjectUseCaseTest : BaseTest() { timeLine = timeLine, ) - @Test - fun `global search agrees with the shared match rule`() { - // Global search needs offsets so it resolves separately; the two must not drift apart. - val cases = listOf( - "A well\\-known secret" to "well-known", - "A well\\-known secret" to "well\\-known", - "A well\\-known secret" to "unrelated", - "the user_name field" to "user_name", - "The cost is 5\\*4" to "5*4", - "a **Chapter** heading" to "**Chapter**", - "a **Chapter** heading" to "Chapter heading", - "path C:\\temp here" to "C:\\temp", - ) - - for ((content, query) in cases) { - assertEquals( - markdownContains(content, query), - SearchProjectUseCase.findMarkdownMatch(MarkdownProjector(), content, query) != null, - "disagreement on content=<$content> query=<$query>", - ) - } - } - @Test fun `findMatch returns null for empty text or query`() { assertNull(SearchProjectUseCase.findMatch("", "foo")) @@ -185,8 +159,8 @@ class SearchProjectUseCaseTest : BaseTest() { content = SceneContent(scene = scene, markdown = "Unsaved dragon attack"), source = UpdateSource.Editor, ) - // The on-disk read should not be consulted because the buffer wins - stubSceneMarkdown(scene, "On-disk text") + // loadSceneMarkdownRaw should not be consulted because buffer wins + every { sceneEditor.loadSceneMarkdownRaw(scene, any()) } returns "On-disk text" val results = createUseCase().search("dragon", GlobalSearchFilter.All) .filterIsInstance() @@ -214,19 +188,6 @@ class SearchProjectUseCaseTest : BaseTest() { assertEquals(9, results.first().sceneItem.id) } - /** - * Stubs the on-disk read for [scene]. Search decodes a scene into a buffer it owns rather than - * taking a string back, so the stub fills the buffer the use case handed in. - */ - private fun stubSceneMarkdown(scene: SceneItem, markdown: String) { - every { sceneEditor.readSceneMarkdownInto(eq(scene), any(), any()) } answers { - val sink = secondArg() - val buffer = sink.charBuffer(markdown.length) - markdown.forEachIndexed { index, char -> buffer[index] = char } - markdown.length - } - } - @Test fun `search matches encyclopedia entry name`() = runTest { val def = EntryDef(projectDef = projectDef, id = 11, type = EntryType.PERSON, name = "Aragorn") @@ -395,480 +356,6 @@ class SearchProjectUseCaseTest : BaseTest() { assertEquals(7, results.first().sceneItem.id) } - private fun note(id: Int, content: String) = - NoteContainer(NoteContent(id = id, created = Clock.System.now(), content = content)) - - @Test - fun `search matches across a backslash escape`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "A well\\-known secret")) - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - } - - @Test - fun `search matches a phrase spanning an emphasis boundary`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "**Chapter** One begins")) - - val results = createUseCase().search("Chapter One", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - } - - @Test - fun `search matches a phrase spanning italics and code spans`() = runTest { - every { notes.getNotes() } returns listOf( - note(1, "the _quick_ brown fox"), - note(2, "run the `build` script"), - ) - - val italic = createUseCase().search("quick brown", GlobalSearchFilter.All) - .filterIsInstance() - val code = createUseCase().search("the build script", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, italic.size) - assertEquals(1, code.size) - } - - @Test - fun `snippets render prose without markdown syntax`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "A well\\-known **Chapter** One secret")) - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - val snippet = results.first().snippet - assertEquals("A well-known Chapter One secret", snippet.text) - assertEquals("well-known", snippet.text.substring(snippet.matchStart, snippet.matchEnd)) - } - - @Test - fun `escaped literals survive the projection`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "the \\_shape\\_ of it")) - - val results = createUseCase().search("_shape_", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertTrue(results.first().snippet.text.contains("_shape_")) - } - - @Test - fun `typing markdown syntax does not find the markup it renders away`() = runTest { - // The query is literal text matched against the prose on screen; that prose reads "raw bold - // marker", so the asterisks are not there to be found. - every { notes.getNotes() } returns listOf(note(1, "raw **bold** marker")) - - val asTyped = createUseCase().search("**bold**", GlobalSearchFilter.All) - .filterIsInstance() - val asRead = createUseCase().search("raw bold marker", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(0, asTyped.size) - assertEquals(1, asRead.size) - } - - @Test - fun `scene bodies match across an emphasis boundary`() = runTest { - val scene = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 7, - name = "Opening", - order = 0, - ) - every { sceneEditor.getScenes() } returns listOf(scene) - every { sceneContentRepository.getSceneBuffer(scene) } returns null - stubSceneMarkdown(scene, "**Chapter** One begins") - - val results = createUseCase().search("Chapter One", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("Chapter One begins", results.first().snippet.text) - } - - @Test - fun `literal underscores in imported content are left alone`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "the user_name field and my_table_name")) - - val results = createUseCase().search("user_name", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertTrue(results.first().snippet.text.contains("my_table_name")) - } - - @Test - fun `a body of only markdown markers still previews in a tag search`() = runTest { - every { notes.getNotes() } returns listOf( - NoteContainer( - NoteContent( - id = 1, - created = Clock.System.now(), - content = "***", - tags = setOf("fantasy"), - ) - ), - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("***", results.first().snippet.text) - } - - @Test - fun `a heading does not leak into the title or the snippet`() = runTest { - every { notes.getNotes() } returns listOf( - NoteContainer( - NoteContent( - id = 1, - created = Clock.System.now(), - content = "# Chapter One\n\nThe body text", - tags = setOf("fantasy"), - ) - ), - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("Chapter One", results.first().title) - assertEquals("Chapter One The body text", results.first().snippet.text) - } - - @Test - fun `a note whose first line is only markers is not titled empty`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "***\nThe real body text")) - - val results = createUseCase().search("real body", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("***", results.first().title) - } - - @Test - fun `timeline dates are not projected`() = runTest { - coEvery { timeLine.loadTimeline() } returns TimeLineContainer( - listOf(TimeLineEvent(id = 21, order = 0, date = "1990 _to_ 2000", content = "A long war")), - ) - - val verbatim = createUseCase().search("1990 _to_ 2000", GlobalSearchFilter.All) - .filterIsInstance() - val projectedForm = createUseCase().search("1990 to 2000", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, verbatim.size) - assertTrue(verbatim.first().snippet.text.contains("1990 _to_ 2000")) - // Projecting the date would make this hit and would show a date the event does not have. - assertEquals(0, projectedForm.size) - } - - @Test - fun `tag-only search previews prose without markdown syntax`() = runTest { - every { notes.getNotes() } returns listOf( - NoteContainer( - NoteContent( - id = 1, - created = Clock.System.now(), - content = "A well\\-known **Chapter** One secret", - tags = setOf("fantasy"), - ) - ), - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("A well-known Chapter One secret", results.first().snippet.text) - } - - @Test - fun `snippets render escaped text the way it reads on screen`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "A well\\-known garden\\! at dusk")) - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - val snippet = results.first().snippet - assertEquals("A well-known garden! at dusk", snippet.text) - assertEquals("well-known", snippet.text.substring(snippet.matchStart, snippet.matchEnd)) - } - - @Test - fun `the title reads the same way as the snippet under it`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "Alice \\(the elder\\) is well\\-known\\!")) - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("Alice (the elder) is well-known!", results.first().title) - assertEquals("Alice (the elder) is well-known!", results.first().snippet.text) - } - - @Test - fun `escaped markers are searchable as literal characters`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "the \\_shape\\_ of it")) - - val results = createUseCase().search("_shape_", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertTrue(results.first().snippet.text.contains("_shape_")) - } - - @Test - fun `searching the storage form of text is not supported`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "raw well\\-known marker")) - - val asStored = createUseCase().search("well\\-known", GlobalSearchFilter.All) - .filterIsInstance() - val asRead = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(0, asStored.size) - assertEquals(1, asRead.size) - } - - @Test - fun `title and snippet render the same way`() = runTest { - every { notes.getNotes() } returns listOf(note(1, "Alice \\(the elder\\) is well\\-known")) - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("Alice (the elder) is well-known", results.first().title) - assertEquals("Alice (the elder) is well-known", results.first().snippet.text) - } - - @Test - fun `unescaped markup is left alone so literal text is not rewritten`() = runTest { - every { notes.getNotes() } returns listOf( - note(1, "The cost is 5*4"), - note(2, "the user_name field"), - ) - - val math = createUseCase().search("5*4", GlobalSearchFilter.All) - .filterIsInstance() - val identifier = createUseCase().search("user_name", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, math.size) - assertEquals("The cost is 5*4", math.first().snippet.text) - assertEquals(1, identifier.size) - assertTrue(identifier.first().snippet.text.contains("user_name")) - } - - @Test - fun `scene bodies match across a backslash escape`() = runTest { - val scene = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 7, - name = "Opening", - order = 0, - ) - every { sceneEditor.getScenes() } returns listOf(scene) - every { sceneContentRepository.getSceneBuffer(scene) } returns null - stubSceneMarkdown(scene, "A well\\-known road") - - val results = createUseCase().search("well-known", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("A well-known road", results.first().snippet.text) - } - - @Test - fun `timeline dates are not unescaped`() = runTest { - coEvery { timeLine.loadTimeline() } returns TimeLineContainer( - listOf(TimeLineEvent(id = 21, order = 0, date = "1990\\-2000", content = "A long war")), - ) - - val verbatim = createUseCase().search("1990\\-2000", GlobalSearchFilter.All) - .filterIsInstance() - val resolvedForm = createUseCase().search("1990-2000", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, verbatim.size) - // Unescaping the date would make this hit and would show a date the event does not have. - assertEquals(0, resolvedForm.size) - } - - @Test - fun `tag-only search previews escaped text as it reads`() = runTest { - every { notes.getNotes() } returns listOf( - NoteContainer( - NoteContent( - id = 1, - created = Clock.System.now(), - content = "A well\\-known secret", - tags = setOf("fantasy"), - ) - ), - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals("A well-known secret", results.first().snippet.text) - } - - @Test - fun `tag-only search returns a note with no content`() = runTest { - every { notes.getNotes() } returns listOf( - NoteContainer( - NoteContent( - id = 1, - created = Clock.System.now(), - content = "", - tags = setOf("fantasy"), - ) - ), - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals(1, results.first().noteId) - } - - @Test - fun `tag-only search returns an encyclopedia entry with no body text`() = runTest { - val def = EntryDef(projectDef = projectDef, id = 13, type = EntryType.PERSON, name = "Alice") - coEvery { encyclopedia.ensureEntriesLoaded() } returns listOf(def) - every { encyclopedia.loadEntry(def) } returns EntryContainer( - EntryContent( - id = 13, - name = "Alice", - type = EntryType.PERSON, - text = "", - tags = setOf("fantasy"), - ) - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals(13, results.first().entryDef.id) - assertTrue(results.first().title.contains("Alice")) - assertEquals("Alice", results.first().snippet.text) - } - - @Test - fun `tag-only search returns timeline events with and without content`() = runTest { - coEvery { timeLine.loadTimeline() } returns TimeLineContainer( - listOf( - TimeLineEvent(id = 21, order = 0, date = null, content = "", tags = setOf("fantasy")), - TimeLineEvent(id = 22, order = 1, date = "Year 3", content = "Coronation", tags = setOf("fantasy")), - ) - ) - - val results = createUseCase().search("#fantasy", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(listOf(21, 22), results.map { it.eventId }) - assertTrue(results.last().snippet.text.contains("Coronation")) - } - - @Test - fun `tag search combined with free text matches an encyclopedia entry name`() = runTest { - val def = EntryDef(projectDef = projectDef, id = 14, type = EntryType.PERSON, name = "Alice") - coEvery { encyclopedia.ensureEntriesLoaded() } returns listOf(def) - every { encyclopedia.loadEntry(def) } returns EntryContainer( - EntryContent( - id = 14, - name = "Alice", - type = EntryType.PERSON, - text = "A traveler from the north.", - tags = setOf("fantasy"), - ) - ) - - val results = createUseCase().search("#fantasy alice", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals(14, results.first().entryDef.id) - assertTrue(results.first().snippet.text.contains("Alice")) - } - - @Test - fun `tag search with free text falls through to the encyclopedia entry body`() = runTest { - val def = EntryDef(projectDef = projectDef, id = 15, type = EntryType.PLACE, name = "Mordor") - coEvery { encyclopedia.ensureEntriesLoaded() } returns listOf(def) - every { encyclopedia.loadEntry(def) } returns EntryContainer( - EntryContent( - id = 15, - name = "Mordor", - type = EntryType.PLACE, - text = "Sauron rules here.", - tags = setOf("fantasy"), - ) - ) - - val results = createUseCase().search("#fantasy sauron", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertTrue(results.first().snippet.text.contains("Sauron")) - } - - @Test - fun `tag search drops an encyclopedia entry when the free text matches neither name nor body`() = runTest { - val def = EntryDef(projectDef = projectDef, id = 16, type = EntryType.PERSON, name = "Alice") - coEvery { encyclopedia.ensureEntriesLoaded() } returns listOf(def) - every { encyclopedia.loadEntry(def) } returns EntryContainer( - EntryContent( - id = 16, - name = "Alice", - type = EntryType.PERSON, - text = "A traveler from the north.", - tags = setOf("fantasy"), - ) - ) - - val results = createUseCase().search("#fantasy dragon", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(0, results.size) - } - - @Test - fun `tag-only search returns a scene with a blank name`() = runTest { - val scene = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 7, - name = " ", - order = 0, - ) - every { sceneEditor.getScenes() } returns listOf(scene) - coEvery { sceneMetadataRepository.loadSceneMetadata(7) } returns SceneMetadata(tags = setOf("plot")) - - val results = createUseCase().search("#plot", GlobalSearchFilter.All) - .filterIsInstance() - - assertEquals(1, results.size) - assertEquals(7, results.first().sceneItem.id) - } - @Test fun `search honors filter to a single source`() = runTest { every { notes.getNotes() } returns listOf( diff --git a/common/src/desktopTest/kotlin/util/DesktopStartupInfoTest.kt b/common/src/desktopTest/kotlin/util/DesktopStartupInfoTest.kt deleted file mode 100644 index ecdfd36e1..000000000 --- a/common/src/desktopTest/kotlin/util/DesktopStartupInfoTest.kt +++ /dev/null @@ -1,54 +0,0 @@ -package util - -import com.darkrockstudios.apps.hammer.common.HostOs -import com.darkrockstudios.apps.hammer.common.desktopStartupInfo -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class DesktopStartupInfoTest { - - private val properties = mapOf( - "os.name" to "SomeOS", - "os.version" to "1.0", - "os.arch" to "amd64", - "java.vendor" to "Vendor", - "java.runtime.version" to "21", - ) - private val xdgEnvironment = mapOf( - "XDG_SESSION_TYPE" to "wayland", - "XDG_CURRENT_DESKTOP" to "GNOME", - ) - private val noEnvironment = emptyMap() - - @Test - fun `linux reports its display session`() { - val info = desktopStartupInfo(HostOs.Linux, properties::get, xdgEnvironment::get) - - assertTrue(info.contains(" | session: wayland/GNOME | ")) - } - - @Test - fun `linux without XDG variables still shows the session slot`() { - val info = desktopStartupInfo(HostOs.Linux, properties::get, noEnvironment::get) - - assertTrue(info.contains(" | session: n/a/n/a | ")) - } - - @Test - fun `windows and macOS leave the session out`() { - for (os in listOf(HostOs.Windows, HostOs.MacOs)) { - val info = desktopStartupInfo(os, properties::get, xdgEnvironment::get) - - assertFalse(info.contains("session"), "$os banner: $info") - } - } - - @Test - fun `the rest of the banner is unchanged off linux`() { - val info = desktopStartupInfo(HostOs.Windows, properties::get, noEnvironment::get) - - assertEquals("OS: SomeOS 1.0 (amd64) | JVM: Vendor 21 | renderApi: default", info) - } -} diff --git a/common/src/desktopTest/kotlin/util/DiagnosticsTest.kt b/common/src/desktopTest/kotlin/util/DiagnosticsTest.kt deleted file mode 100644 index 4a2654da3..000000000 --- a/common/src/desktopTest/kotlin/util/DiagnosticsTest.kt +++ /dev/null @@ -1,132 +0,0 @@ -package util - -import com.darkrockstudios.apps.hammer.base.BuildMetadata -import com.darkrockstudios.apps.hammer.common.DIAGNOSTICS_LOG_HEADER -import com.darkrockstudios.apps.hammer.common.buildDiagnosticsReport -import kotlinx.coroutines.test.runTest -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem -import kotlin.test.AfterTest -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.time.Clock -import kotlin.time.Instant - -private val LOG_DIR = "/logs".toPath() - -/** The real clock stamps both writes into the same millisecond, which hides the newest-log pick. */ -private class SteppingClock : Clock { - private var millis = 0L - - override fun now(): Instant { - millis += 1_000 - return Instant.fromEpochMilliseconds(millis) - } -} - -class DiagnosticsTest { - - private val fileSystem = FakeFileSystem(SteppingClock()).apply { createDirectories(LOG_DIR) } - - @AfterTest - fun tearDown() = fileSystem.checkNoOpenFiles() - - private fun writeLog(name: String, contents: String) { - fileSystem.write(LOG_DIR / name) { writeUtf8(contents) } - } - - private suspend fun report() = buildDiagnosticsReport(LOG_DIR.toString(), fileSystem) - - @Test - fun `the banner leads and the newest log follows`() = runTest { - writeLog("2026-01-01T000000Z.txt", "older\n") - writeLog("2026-01-02T000000Z.txt", "newer\n") - - val report = report() - - assertTrue(report.lines().first().startsWith("Hammer v${BuildMetadata.APP_VERSION}")) - assertTrue(report.endsWith("newer")) - assertFalse(report.contains("older")) - } - - @Test - fun `only the tail of a long log is taken`() = runTest { - writeLog("current.txt", (1..500).joinToString("\n") { "line $it" }) - - val logLines = report().substringAfter("$DIAGNOSTICS_LOG_HEADER\n").lines() - - assertEquals(200, logLines.size) - assertEquals("line 301", logLines.first()) - assertEquals("line 500", logLines.last()) - } - - @Test - fun `an empty log directory still yields the banner`() = runTest { - val report = report() - - assertTrue(report.startsWith("Hammer v${BuildMetadata.APP_VERSION}")) - assertTrue(report.endsWith("(no log file found)")) - } - - @Test - fun `a missing log directory still yields the banner`() = runTest { - val report = buildDiagnosticsReport("/nope", fileSystem) - - assertTrue(report.startsWith("Hammer v${BuildMetadata.APP_VERSION}")) - assertTrue(report.endsWith("(no log file found)")) - } - - @Test - fun `the latest crash is included even when a newer session log exists`() = runTest { - writeLog("crash-1000.txt", "java.lang.IllegalStateException: boom\n\tat Somewhere.kt:1") - writeLog("2026-01-02T000000Z.txt", "after the restart\n") - - val report = report() - - assertTrue(report.contains("crash-1000.txt")) - assertTrue(report.contains("java.lang.IllegalStateException: boom")) - assertTrue(report.endsWith("after the restart")) - } - - @Test - fun `only the newest crash is included`() = runTest { - writeLog("crash-2000.txt", "the newer crash") - writeLog("crash-1000.txt", "the older crash") - - val report = report() - - assertTrue(report.contains("the newer crash")) - assertFalse(report.contains("the older crash")) - } - - @Test - fun `a crash dump is never used as the current log`() = runTest { - writeLog("2026-01-01T000000Z.txt", "the session log\n") - writeLog("crash-1000.txt", "the crash") - - val logSection = report().substringAfter("$DIAGNOSTICS_LOG_HEADER\n") - - assertEquals("the session log", logSection) - } - - @Test - fun `there is no crash section without a crash dump`() = runTest { - writeLog("2026-01-01T000000Z.txt", "the session log\n") - - assertFalse(report().contains("crash", ignoreCase = true)) - } - - @Test - fun `only the head of a very long crash is taken`() = runTest { - writeLog("crash-1000.txt", (1..1000).joinToString("\n") { "frame $it" }) - - val report = report() - - assertTrue(report.contains("frame 1\n")) - assertTrue(report.contains("frame 300\n")) - assertFalse(report.contains("frame 301")) - assertTrue(report.contains("700 more lines")) - } -} diff --git a/common/src/desktopTest/kotlin/util/MsixPathsTest.kt b/common/src/desktopTest/kotlin/util/MsixPathsTest.kt deleted file mode 100644 index a0f86ffc1..000000000 --- a/common/src/desktopTest/kotlin/util/MsixPathsTest.kt +++ /dev/null @@ -1,53 +0,0 @@ -package util - -import com.darkrockstudios.apps.hammer.common.unredirectMsixPath -import kotlin.test.Test -import kotlin.test.assertEquals - -/** - * The literal path the app sees, and the container path Explorer needs, taken from the Store - * install that reported the broken open-logs button. - */ -private const val LOCAL_APP_DATA = "C:\\Users\\someone\\AppData\\Local" -private const val APP_VISIBLE = "$LOCAL_APP_DATA\\DarkrockStudios\\hammer\\0\\logs" -private const val CONTAINER = - "$LOCAL_APP_DATA\\Packages\\DarkRockStudios.HammerEditor_eee5gzg80tyea" + - "\\LocalCache\\Local\\DarkrockStudios\\hammer\\0\\logs" - -class MsixPathsTest { - - @Test - fun `a redirected path is rewritten into the package container`() { - assertEquals(CONTAINER, unredirectMsixPath(APP_VISIBLE, LOCAL_APP_DATA)) - } - - @Test - fun `a path already inside the container is left alone`() { - assertEquals(CONTAINER, unredirectMsixPath(CONTAINER, LOCAL_APP_DATA)) - } - - @Test - fun `a path outside local appdata is left alone`() { - val outside = "C:\\Users\\someone\\Documents\\Hammer" - assertEquals(outside, unredirectMsixPath(outside, LOCAL_APP_DATA)) - } - - @Test - fun `a trailing separator on local appdata does not double up`() { - assertEquals(CONTAINER, unredirectMsixPath(APP_VISIBLE, "$LOCAL_APP_DATA\\")) - } - - /** Windows paths are case-insensitive, and the env var's casing is not guaranteed to match. */ - @Test - fun `the local appdata prefix matches case insensitively`() { - val lowercased = LOCAL_APP_DATA.lowercase() - val expected = CONTAINER.replaceFirst(LOCAL_APP_DATA, lowercased) - assertEquals(expected, unredirectMsixPath(APP_VISIBLE, lowercased)) - } - - @Test - fun `a missing local appdata leaves the path alone`() { - assertEquals(APP_VISIBLE, unredirectMsixPath(APP_VISIBLE, null)) - assertEquals(APP_VISIBLE, unredirectMsixPath(APP_VISIBLE, "")) - } -} diff --git a/common/src/desktopTest/kotlin/utils/ComponentTest.kt b/common/src/desktopTest/kotlin/utils/ComponentTest.kt index dd68de6bb..e0285c972 100644 --- a/common/src/desktopTest/kotlin/utils/ComponentTest.kt +++ b/common/src/desktopTest/kotlin/utils/ComponentTest.kt @@ -10,10 +10,7 @@ import com.arkivanov.essenty.statekeeper.StateKeeperDispatcher import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.tagindex.TagIndexService import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.spellcheck.ProjectSpellCheckRepository -import io.mockk.every import io.mockk.mockk -import kotlinx.coroutines.flow.emptyFlow import org.junit.jupiter.api.AfterEach import org.junit.jupiter.api.BeforeEach import org.koin.core.module.Module @@ -96,23 +93,12 @@ open class ComponentTest : BaseTest() { /** * Like [setupKoin] but also registers the dependencies every project-scoped component injects * via [com.darkrockstudios.apps.hammer.common.components.ProjectComponentBase] — currently a - * relaxed [TagIndexService] and a [ProjectSpellCheckRepository] whose flows never emit (both - * lazy, so harmless when a component never uses them). A test that needs to control either - * should register its own via plain [setupKoin] instead. + * relaxed [TagIndexService] (lazy, so harmless when a component never uses it). A test that + * needs to control TagIndexService should register its own via plain [setupKoin] instead. */ protected fun setupComponentKoin(module: Module) { setupKoin( - module { - single { mockk(relaxed = true) } - single { - mockk(relaxed = true) { - every { spellCheckAllowed } returns emptyFlow() - every { dictionaryFlow } returns emptyFlow() - every { encyclopediaDictionaryEnabled } returns emptyFlow() - every { userDictionaryWords } returns emptyFlow() - } - } - }, + module { single { mockk(relaxed = true) } }, module, ) } diff --git a/common/src/desktopTest/kotlin/utils/FakeAppUpdater.kt b/common/src/desktopTest/kotlin/utils/FakeAppUpdater.kt deleted file mode 100644 index ff345b31b..000000000 --- a/common/src/desktopTest/kotlin/utils/FakeAppUpdater.kt +++ /dev/null @@ -1,25 +0,0 @@ -package utils - -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import kotlinx.coroutines.flow.MutableStateFlow - -class FakeAppUpdater(initial: AppUpdateState = AppUpdateState.Idle) : AppUpdater { - override val state = MutableStateFlow(initial) - - var checks = 0 - var updates = 0 - var dismissals = 0 - - override fun checkNow() { - checks++ - } - - override fun update() { - updates++ - } - - override fun dismiss() { - dismissals++ - } -} diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/NapierProxy.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/NapierProxy.kt index d318296e9..de2763161 100644 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/NapierProxy.kt +++ b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/NapierProxy.kt @@ -1,5 +1,6 @@ package com.darkrockstudios.apps.hammer.common +import com.darkrockstudios.apps.hammer.base.BuildMetadata import io.github.aakira.napier.Napier import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.Dispatchers @@ -43,7 +44,7 @@ private fun writeCrashDump(throwable: Throwable) { fileSystem.createDirectories(dir) val file = dir / "crash-${Clock.System.now().toEpochMilliseconds()}.txt" fileSystem.write(file) { - writeUtf8(startupBanner() + "\n") + writeUtf8("Hammer v${BuildMetadata.APP_VERSION} | ${platformStartupInfo()}\n") writeUtf8("Uncaught exception\n\n") writeUtf8(throwable.stackTraceToString()) } diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt deleted file mode 100644 index 1a46d6f19..000000000 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupport.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -actual val supportsInAppChangelog: Boolean = false diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.ios.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.ios.kt deleted file mode 100644 index 431a98f20..000000000 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.ios.kt +++ /dev/null @@ -1,14 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.tagindex - -import platform.Foundation.NSCharacterSet -import platform.Foundation.NSString -import platform.Foundation.precomposedStringWithCanonicalMapping - -internal actual fun normalizeTagForm(text: String): String = - (text as NSString).precomposedStringWithCanonicalMapping - -/** Foundation's alphanumeric set is Unicode categories L, M and N, which all read as tag content. */ -private val alphanumeric = NSCharacterSet.alphanumericCharacterSet - -internal actual fun isSupplementaryLetterOrDigit(codePoint: Int): Boolean = - alphanumeric.longCharacterIsMember(codePoint.toUInt()) diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt index 0da96c732..3939f209b 100644 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt +++ b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/dependencyinjection/platformModule.kt @@ -1,8 +1,5 @@ package com.darkrockstudios.apps.hammer.common.dependencyinjection -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.appupdate.NoOpAppUpdater - import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.IosSettingsComponent import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.PlatformSettings import com.darkrockstudios.apps.hammer.common.components.storyeditor.focusmode.FocusModeService @@ -21,7 +18,6 @@ actual val platformModule = module { single() single() bind StrRes::class single() - single() single() bind UrlLauncher::class single() factory { params -> IosSettingsComponent(componentContext = params.get()) } bind PlatformSettings::class @@ -29,5 +25,4 @@ actual val platformModule = module { factory() single() single() bind GlobalSettingsDatasource::class - single { NoOpAppUpdater } } \ No newline at end of file diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.ios.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.ios.kt deleted file mode 100644 index 9637178af..000000000 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.ios.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -import okio.IOException - -actual fun Throwable.asIoFailure(): IOException? = this as? IOException diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.ios.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.ios.kt deleted file mode 100644 index 2ccfb9fb2..000000000 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.ios.kt +++ /dev/null @@ -1,12 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -/** - * NSURLSession surfaces TLS problems as an `NSError` whose localized description names the - * failure, which is all the Darwin engine carries through into the exception message. - */ -private val TLS_MARKERS = listOf("ssl", "tls", "certificate", "secure connection") - -actual fun Throwable.isTlsFailure(): Boolean = causeChain().any { throwable -> - val text = "${throwable::class.simpleName.orEmpty()} ${throwable.message.orEmpty()}" - TLS_MARKERS.any { marker -> text.contains(marker, ignoreCase = true) } -} diff --git a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt b/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt deleted file mode 100644 index 1e5711e93..000000000 --- a/common/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/util/AvailableLocalesProvider.kt +++ /dev/null @@ -1,13 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.util - -import platform.Foundation.NSLocale -import platform.Foundation.availableLocaleIdentifiers - -actual class AvailableLocalesProvider { - actual fun allLocales(): List = - NSLocale.availableLocaleIdentifiers - .filterIsInstance() - .map { Locale.forLanguageTag(it) } - .filter { it.language != null } - .distinctBy { it.toLanguageTag() } -} diff --git a/common/src/iosTest/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupportTest.kt b/common/src/iosTest/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupportTest.kt deleted file mode 100644 index 7c5bf6452..000000000 --- a/common/src/iosTest/kotlin/com/darkrockstudios/apps/hammer/common/data/changelog/InAppChangelogSupportTest.kt +++ /dev/null @@ -1,13 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.changelog - -import kotlin.test.Test -import kotlin.test.assertFalse - -class InAppChangelogSupportTest { - - // Apple rejects the baked changelog under guideline 2.3.10 for naming other platforms. - @Test - fun `in-app changelog is never shown on iOS`() { - assertFalse(supportsInAppChangelog) - } -} diff --git a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.jvm.kt b/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.jvm.kt deleted file mode 100644 index 3452680f4..000000000 --- a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/data/tagindex/TagNormalizer.jvm.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.data.tagindex - -import java.text.Normalizer - -internal actual fun normalizeTagForm(text: String): String = - if (Normalizer.isNormalized(text, Normalizer.Form.NFC)) text - else Normalizer.normalize(text, Normalizer.Form.NFC) - -internal actual fun isSupplementaryLetterOrDigit(codePoint: Int): Boolean = - Character.isLetterOrDigit(codePoint) diff --git a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.jvm.kt b/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.jvm.kt deleted file mode 100644 index b5f799794..000000000 --- a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/IoFailure.jvm.kt +++ /dev/null @@ -1,15 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -import java.io.IOException -import java.io.UncheckedIOException - -/** - * `java.net.http.HttpClient`'s constructor wraps a failed `Selector.open()` in an - * [UncheckedIOException], so a machine that cannot open the JDK's internal loopback socket pair - * fails with an unchecked exception before a request is ever sent. - */ -actual fun Throwable.asIoFailure(): IOException? = when (this) { - is IOException -> this - is UncheckedIOException -> cause as? IOException - else -> null -} diff --git a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.jvm.kt b/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.jvm.kt deleted file mode 100644 index c4395cc25..000000000 --- a/common/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/common/server/TlsFailure.jvm.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.server - -import javax.net.ssl.SSLException - -actual fun Throwable.isTlsFailure(): Boolean = causeChain().any { it is SSLException } diff --git a/composeUi/build.gradle.kts b/composeUi/build.gradle.kts index 23c02036c..f324c4b2c 100644 --- a/composeUi/build.gradle.kts +++ b/composeUi/build.gradle.kts @@ -8,7 +8,7 @@ plugins { alias(libs.plugins.android.kotlin.multiplatform.library) alias(libs.plugins.jetbrains.kover) //alias(libs.plugins.compose.report.generator) - id("ee.schimke.composeai.preview") version "2.34.0" + id("ee.schimke.composeai.preview") version "0.16.44" } group = "com.darkrockstudios.apps.hammer.composeui" @@ -77,6 +77,7 @@ kotlin { api(libs.jetbrains.compose.animation) api(libs.jetbrains.compose.animation.graphics) api(libs.jetbrains.compose.material.icons.extended) + api(libs.multiplatform.window.size) api(libs.jetbrains.compose.ui.util) api(libs.jetbrains.compose.ui.text) api(libs.jetbrains.compose.ui.backhandler) @@ -91,11 +92,9 @@ kotlin { implementation(libs.colorpicker.compose) implementation(libs.material.kolor) implementation(libs.koalaplot.core) - implementation(libs.cairn) implementation(libs.aboutlibraries.core) implementation(libs.aboutlibraries.compose) implementation(libs.compose.texteditor) - implementation(libs.compose.texteditor.markdown) implementation(libs.compose.texteditor.find) implementation(libs.compose.texteditor.spellcheck) implementation(libs.platform.spellcheckerkt) diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.android.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.android.kt deleted file mode 100644 index adbc7a1ec..000000000 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.android.kt +++ /dev/null @@ -1,16 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import android.content.ClipData -import android.content.ClipboardManager -import android.content.Context -import androidx.compose.runtime.Composable -import androidx.compose.ui.platform.LocalContext - -@Composable -actual fun rememberClipboardCopier(): (String) -> Unit { - val context = LocalContext.current - return { text -> - val clipboard = context.getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager - clipboard.setPrimaryClip(ClipData.newPlainText(null, text)) - } -} diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt index 03537e682..169df5975 100644 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt @@ -3,13 +3,9 @@ package com.darkrockstudios.apps.hammer.common.compose import androidx.compose.animation.core.animateFloatAsState import androidx.compose.animation.core.tween import androidx.compose.foundation.Canvas -import androidx.compose.foundation.ScrollState import androidx.compose.foundation.layout.fillMaxHeight import androidx.compose.foundation.layout.width import androidx.compose.foundation.lazy.LazyListState -import androidx.compose.foundation.lazy.grid.LazyGridState -import androidx.compose.foundation.lazy.staggeredgrid.LazyStaggeredGridState -import androidx.compose.material3.MaterialTheme import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.ui.Modifier @@ -20,176 +16,209 @@ import androidx.compose.ui.graphics.Color import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp -// The Android bar fades in over the content, so it reserves no layout space. -actual val MpScrollBarGutter: Dp = 0.dp - @Composable actual fun MpScrollBarList( modifier: Modifier, state: LazyListState ) { - ScrollbarCanvas(modifier = modifier, isScrollInProgress = state.isScrollInProgress) { viewportSize -> - val firstVisibleItem = state.layoutInfo.visibleItemsInfo.firstOrNull() - val firstItemSize = firstVisibleItem?.size ?: 0 - // Estimated from the first visible item, so the knob drifts when item sizes are not uniform. - // A fixed knob size keeps it from visibly growing and shrinking as you scroll. - val estimatedContentSize = (firstItemSize * state.layoutInfo.totalItemsCount).toFloat() - if (estimatedContentSize <= 0f) { - null - } else { - val offset = state.firstVisibleItemIndex * firstItemSize + state.firstVisibleItemScrollOffset - ScrollbarKnob( - position = (viewportSize / estimatedContentSize) * offset, - size = viewportSize * FixedKnobRatio, - ) - } - } -} - -@Composable -actual fun MpScrollBarColumn( - modifier: Modifier, - state: ScrollState -) { - ScrollbarCanvas(modifier = modifier, isScrollInProgress = state.isScrollInProgress) { viewportSize -> - val scrollRange = state.maxValue - // A ScrollState that was never attached to a scrolling container reports Int.MAX_VALUE. - if (scrollRange <= 0 || scrollRange == Int.MAX_VALUE) { - null - } else { - val contentSize = viewportSize + scrollRange - ScrollbarKnob( - position = (viewportSize / contentSize) * state.value, - size = (viewportSize / contentSize) * viewportSize, - ) - } - } -} - -@Composable -actual fun MpScrollBarGrid( - modifier: Modifier, - state: LazyGridState -) { - ScrollbarCanvas(modifier = modifier, isScrollInProgress = state.isScrollInProgress) { viewportSize -> - itemCountKnob( - viewportSize = viewportSize, - firstVisibleIndex = state.firstVisibleItemIndex, - visibleCount = state.layoutInfo.visibleItemsInfo.size, - totalCount = state.layoutInfo.totalItemsCount, - ) - } -} - -@Composable -actual fun MpScrollBarStaggeredGrid( - modifier: Modifier, - state: LazyStaggeredGridState -) { - ScrollbarCanvas(modifier = modifier, isScrollInProgress = state.isScrollInProgress) { viewportSize -> - itemCountKnob( - viewportSize = viewportSize, - firstVisibleIndex = state.firstVisibleItemIndex, - visibleCount = state.layoutInfo.visibleItemsInfo.size, - totalCount = state.layoutInfo.totalItemsCount, - ) - } -} - -/** Knob ratio for lists, whose content extent can only be estimated. */ -private const val FixedKnobRatio = 0.1f - -/** - * Knob driven by item counts rather than pixel extents, so it works the same for uniform and - * staggered grids. It moves one item at a time, fine-grained enough for grids that hold more items - * than fit on screen. - */ -private fun itemCountKnob( - viewportSize: Float, - firstVisibleIndex: Int, - visibleCount: Int, - totalCount: Int, -): ScrollbarKnob? = if (totalCount <= 0 || visibleCount <= 0 || visibleCount >= totalCount) { - null -} else { - ScrollbarKnob( - position = viewportSize * (firstVisibleIndex.toFloat() / totalCount), - size = viewportSize * (visibleCount.toFloat() / totalCount), + AndroidScrollbar( + modifier = modifier, + state = state, + horizontal = false, + fixedKnobRatio = 0.1f ) } -/** Where the knob sits along the track and how long it is, both in pixels. */ -private data class ScrollbarKnob( - val position: Float, - val size: Float, -) /** - * Vertical scrollbar that appears when the user starts scrolling and fades out once they stop. - * It is composed of a track and a knob that moves across it; [knob] supplies the knob's position - * and length for a given viewport, and returns `null` when there is nothing to scroll. + * Renders a scrollbar. * - * The knob is measured inside the draw lambda, so scroll position reads invalidate draw only. + *
  • A scrollbar is composed of two components: a track and a knob. The knob moves across + * the track
  • The scrollbar appears automatically when the user starts scrolling and disappears + * after the scrolling is finished
* - * @param thickness how thick the track and knob should be - * @param trackColor colour of the track; [Color.Transparent] hides it - * @param padding edge padding, so the knob is not flush with the ends of the track - * @param hiddenAlpha use a non-zero value to keep the scrollbar from fading out completely + * @param state The [LazyListState] that has been passed into the lazy list or lazy row + * @param horizontal If `true`, this will be a horizontally-scrolling (left and right) scroll bar, + * if `false`, it will be vertically-scrolling (up and down) + * @param alignEnd If `true`, the scrollbar will appear at the "end" of the scrollable composable it + * is decorating (at the right-hand side in left-to-right locales or left-hand side in right-to-left + * locales, for the vertical scrollbars -or- the bottom for horizontal scrollbars). If `false`, the + * scrollbar will appear at the "start" of the scrollable composable it is decorating (at the + * left-hand side in left-to-right locales or right-hand side in right-to-left locales, for the + * vertical scrollbars -or- the top for horizontal scrollbars) + * @param thickness How thick/wide the track and knob should be + * @param fixedKnobRatio If not `null`, the knob will always have this size, proportional to the + * size of the track. You should consider doing this if the size of the items in the scrollable + * composable is not uniform, to avoid the knob from oscillating in size as you scroll through the + * list + * @param knobCornerRadius The corner radius for the knob + * @param trackCornerRadius The corner radius for the track + * @param knobColor The color of the knob + * @param trackColor The color of the track. Make it [Color.Transparent] to hide it + * @param padding Edge padding to "squeeze" the scrollbar start/end in so it's not flush with the + * contents of the scrollable composable it is decorating + * @param visibleAlpha The alpha when the scrollbar is fully faded-in + * @param hiddenAlpha The alpha when the scrollbar is fully faded-out. Use a non-`0` number to keep + * the scrollbar from ever fading out completely + * @param fadeInAnimationDurationMs The duration of the fade-in animation when the scrollbar appears + * once the user starts scrolling + * @param fadeOutAnimationDurationMs The duration of the fade-out animation when the scrollbar + * disappears after the user is finished scrolling + * @param fadeOutAnimationDelayMs Amount of time to wait after the user is finished scrolling before + * the scrollbar begins its fade-out animation */ @Composable -private fun ScrollbarCanvas( - modifier: Modifier, - isScrollInProgress: Boolean, +fun AndroidScrollbar( + modifier: Modifier = Modifier, + state: LazyListState, + horizontal: Boolean, + alignEnd: Boolean = true, thickness: Dp = 4.dp, + fixedKnobRatio: Float? = null, knobCornerRadius: Dp = 4.dp, trackCornerRadius: Dp = 2.dp, - knobColor: Color = MaterialTheme.colorScheme.outline, - trackColor: Color = Color.Transparent, + knobColor: Color = Color.Black, + trackColor: Color = Color.White, padding: Dp = 0.dp, visibleAlpha: Float = 1f, hiddenAlpha: Float = 0f, fadeInAnimationDurationMs: Int = 150, fadeOutAnimationDurationMs: Int = 500, fadeOutAnimationDelayMs: Int = 1000, - knob: (viewportSize: Float) -> ScrollbarKnob?, ) { - val targetAlpha = if (isScrollInProgress) visibleAlpha else hiddenAlpha - val animationDurationMs = - if (isScrollInProgress) fadeInAnimationDurationMs else fadeOutAnimationDurationMs - val animationDelayMs = if (isScrollInProgress) 0 else fadeOutAnimationDelayMs + check(thickness > 0.dp) { "Thickness must be a positive integer." } + check(fixedKnobRatio == null || fixedKnobRatio < 1f) { + "A fixed knob ratio must be smaller than 1." + } + check(knobCornerRadius >= 0.dp) { "Knob corner radius must be greater than or equal to 0." } + check(trackCornerRadius >= 0.dp) { "Track corner radius must be greater than or equal to 0." } + check(hiddenAlpha <= visibleAlpha) { "Hidden alpha cannot be greater than visible alpha." } + check(fadeInAnimationDurationMs >= 0) { + "Fade in animation duration must be greater than or equal to 0." + } + check(fadeOutAnimationDurationMs >= 0) { + "Fade out animation duration must be greater than or equal to 0." + } + check(fadeOutAnimationDelayMs >= 0) { + "Fade out animation delay must be greater than or equal to 0." + } - val alpha by animateFloatAsState( + val targetAlpha = + if (state.isScrollInProgress) { + visibleAlpha + } else { + hiddenAlpha + } + val animationDurationMs = + if (state.isScrollInProgress) { + fadeInAnimationDurationMs + } else { + fadeOutAnimationDurationMs + } + val animationDelayMs = + if (state.isScrollInProgress) { + 0 + } else { + fadeOutAnimationDelayMs + } + + val alpha by + animateFloatAsState( targetValue = targetAlpha, - animationSpec = tween(delayMillis = animationDelayMs, durationMillis = animationDurationMs), + animationSpec = + tween(delayMillis = animationDelayMs, durationMillis = animationDurationMs) ) - Canvas( + return Canvas( modifier = modifier .width(thickness) .fillMaxHeight() ) { - if (!isScrollInProgress && alpha <= 0f) return@Canvas + state.layoutInfo.visibleItemsInfo.firstOrNull()?.let { firstVisibleItem -> + if (state.isScrollInProgress || alpha > 0f) { + // Size of the viewport, the entire size of the scrollable composable we are decorating with + // this scrollbar. + val viewportSize = + if (horizontal) { + size.width + } else { + size.height + } - padding.toPx() * 2 - val thicknessPx = thickness.toPx() - val paddingPx = padding.toPx() - val trackLength = size.height - paddingPx * 2 - val measured = knob(trackLength) ?: return@Canvas - val left = size.width - thicknessPx + // The size of the first visible item. We use this to estimate how many items can fit in the + // viewport. Of course, this works perfectly when all items have the same size. When they + // don't, the scrollbar knob size will grow and shrink as we scroll. + val firstItemSize = firstVisibleItem.size - drawRoundRect( - color = trackColor, - topLeft = Offset(left, paddingPx), - size = Size(thicknessPx, trackLength), - alpha = alpha, - cornerRadius = CornerRadius(x = trackCornerRadius.toPx(), y = trackCornerRadius.toPx()), - ) + // The *estimated* size of the entire scrollable composable, as if it's all on screen at + // once. It is estimated because it's possible that the size of the first visible item does + // not represent the size of other items. This will cause the scrollbar knob size to grow + // and shrink as we scroll, if the item sizes are not uniform. + val estimatedFullListSize = firstItemSize * state.layoutInfo.totalItemsCount - drawRoundRect( - color = knobColor, - topLeft = Offset(left, measured.position + paddingPx), - size = Size(thicknessPx, measured.size), - alpha = alpha, - cornerRadius = CornerRadius(x = knobCornerRadius.toPx(), y = knobCornerRadius.toPx()), - ) + // The difference in position between the first pixels visible in our viewport as we scroll + // and the top of the fully-populated scrollable composable, if it were to show all the + // items at once. At first, the value is 0 since we start all the way to the top (or start + // edge). As we scroll down (or towards the end), this number will grow. + val viewportOffsetInFullListSpace = + state.firstVisibleItemIndex * firstItemSize + state.firstVisibleItemScrollOffset + + // Where we should render the knob in our composable. + val knobPosition = + (viewportSize / estimatedFullListSize) * viewportOffsetInFullListSpace + padding.toPx() + // How large should the knob be. + val knobSize = + fixedKnobRatio?.let { it * viewportSize } + ?: (viewportSize * viewportSize) / estimatedFullListSize + + // Draw the track + drawRoundRect( + color = trackColor, + topLeft = + when { + // When the scrollbar is horizontal and aligned to the bottom: + horizontal && alignEnd -> Offset(padding.toPx(), size.height - thickness.toPx()) + // When the scrollbar is horizontal and aligned to the top: + horizontal && !alignEnd -> Offset(padding.toPx(), 0f) + // When the scrollbar is vertical and aligned to the end: + alignEnd -> Offset(size.width - thickness.toPx(), padding.toPx()) + // When the scrollbar is vertical and aligned to the start: + else -> Offset(0f, padding.toPx()) + }, + size = + if (horizontal) { + Size(size.width - padding.toPx() * 2, thickness.toPx()) + } else { + Size(thickness.toPx(), size.height - padding.toPx() * 2) + }, + alpha = alpha, + cornerRadius = CornerRadius(x = trackCornerRadius.toPx(), y = trackCornerRadius.toPx()), + ) + + // Draw the knob + drawRoundRect( + color = knobColor, + topLeft = + when { + // When the scrollbar is horizontal and aligned to the bottom: + horizontal && alignEnd -> Offset(knobPosition, size.height - thickness.toPx()) + // When the scrollbar is horizontal and aligned to the top: + horizontal && !alignEnd -> Offset(knobPosition, 0f) + // When the scrollbar is vertical and aligned to the end: + alignEnd -> Offset(size.width - thickness.toPx(), knobPosition) + // When the scrollbar is vertical and aligned to the start: + else -> Offset(0f, knobPosition) + }, + size = + if (horizontal) { + Size(knobSize, thickness.toPx()) + } else { + Size(thickness.toPx(), knobSize) + }, + alpha = alpha, + cornerRadius = CornerRadius(x = knobCornerRadius.toPx(), y = knobCornerRadius.toPx()), + ) + } + } } -} +} \ No newline at end of file diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt new file mode 100644 index 000000000..3b943ef2b --- /dev/null +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt @@ -0,0 +1,20 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import androidx.compose.runtime.Composable +import androidx.compose.ui.graphics.painter.Painter +import kotlin.reflect.KClass + +@Composable +actual fun painterResource(res: String, drawableKlass: Any?): Painter { + val drawables = drawableKlass as KClass + val id = drawableId(res, drawables) + return androidx.compose.ui.res.painterResource(id) +} + +// TODO: improve resource loading +fun drawableId(res: String, drawableKlass: KClass): Int { + val imageName = res.substringAfterLast("/").substringBeforeLast(".") + val field = drawableKlass.java.getDeclaredField(imageName) + val idValue = field.get(drawableKlass) as Integer + return idValue.toInt() +} \ No newline at end of file diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt deleted file mode 100644 index 9257fe121..000000000 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.ui.input.pointer.PointerIcon - -actual fun horizontalResizePointerIcon(): PointerIcon = PointerIcon.Default diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt index 48413e566..2701d85e6 100644 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt @@ -17,17 +17,16 @@ import org.jetbrains.compose.resources.ExperimentalResourceApi internal actual fun EditorAction( icon: ImageVector, active: Boolean, - enabled: Boolean, onClick: () -> Unit ) { val painter = rememberVectorPainter(icon) - IconButton(onClick = onClick, enabled = enabled) { + IconButton(onClick = onClick) { Icon( modifier = Modifier.size(24.dp), painter = painter, - tint = editorActionColor(active, enabled), + tint = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, contentDescription = null ) } @@ -37,14 +36,13 @@ internal actual fun EditorAction( internal actual fun EditorTextAction( label: String, active: Boolean, - enabled: Boolean, onClick: () -> Unit, ) { - IconButton(onClick = onClick, enabled = enabled) { + IconButton(onClick = onClick) { Text( text = label, style = MaterialTheme.typography.labelLarge, - color = editorActionColor(active, enabled), + color = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, ) } } diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.android.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.android.kt deleted file mode 100644 index dedca9705..000000000 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.android.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.theme - -actual val oledBlackThemeAvailable: Boolean = true diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt index 2d4ea6974..4380988d4 100644 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt @@ -5,22 +5,17 @@ import androidx.activity.result.contract.ActivityResultContracts import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.projecthome.ProjectHome import com.darkrockstudios.apps.hammer.common.compose.rememberIoDispatcher import com.darkrockstudios.apps.hammer.common.compose.rememberKoinInject import com.darkrockstudios.apps.hammer.common.data.ExportFormat -import com.darkrockstudios.apps.hammer.common.data.ExportOptions import com.darkrockstudios.apps.hammer.common.fileio.ExternalFileIo import com.darkrockstudios.apps.hammer.common.getCacheDirectory import com.darkrockstudios.apps.hammer.project_home_action_export_toast_failure import com.darkrockstudios.apps.hammer.project_home_action_export_toast_success -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.launch import java.io.File @@ -35,39 +30,28 @@ actual fun ExportDirectoryPicker( val externalFileIo: ExternalFileIo = rememberKoinInject() val state by component.state.subscribeAsState() val format = state.exportOptions.format - // Snapshot of the confirmed options taken when the SAF picker launches; the - // picker does not block the app, so options must not be re-read afterwards. - var confirmedOptions by remember { mutableStateOf(null) } val launcher = rememberLauncherForActivityResult( remember(format) { ActivityResultContracts.CreateDocument(mimeTypeFor(format)) } ) { uri -> - val options = confirmedOptions - if (uri != null && options != null) { + if (uri != null) { + val options = state.exportOptions scope.launch(ioDispatcher) { - // A renderer failure must surface as a toast; an uncaught throw here takes down the app. - try { - val exportTempFile = getCacheDirectory() - val tempFilePath = component.exportProject(exportTempFile, options) - val tempFile = File(tempFilePath.path) - val bytes = tempFile.readBytes() - tempFile.delete() + val exportTempFile = getCacheDirectory() + val tempFilePath = component.exportProject(exportTempFile, options) + val tempFile = File(tempFilePath.path) + val bytes = tempFile.readBytes() + tempFile.delete() - val ok = externalFileIo.writeExternalFile( - path = uri.toString(), - content = bytes, - ) - val toast = if (ok) { - Res.string.project_home_action_export_toast_success - } else { - Res.string.project_home_action_export_toast_failure - } - component.showToast(toast) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - Napier.e("Story export failed", e) - component.showToast(Res.string.project_home_action_export_toast_failure) + val ok = externalFileIo.writeExternalFile( + path = uri.toString(), + content = bytes, + ) + val toast = if (ok) { + Res.string.project_home_action_export_toast_success + } else { + Res.string.project_home_action_export_toast_failure } + component.showToast(toast) } } else { component.endProjectExport() @@ -76,9 +60,7 @@ actual fun ExportDirectoryPicker( LaunchedEffect(show) { if (show) { - val options = component.state.value.exportOptions - confirmedOptions = options - launcher.launch(component.getExportStoryFileName(options.format)) + launcher.launch(component.getExportStoryFileName(format)) } } } diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.android.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.android.kt index 9fb1807a4..e8c1dba12 100644 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.android.kt +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.android.kt @@ -3,12 +3,8 @@ package com.darkrockstudios.apps.hammer.common.projectselection.about import android.content.Context import android.content.Intent import android.widget.Toast -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow import androidx.compose.runtime.* import androidx.compose.ui.platform.LocalContext -import androidx.compose.ui.unit.dp import androidx.core.content.FileProvider import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res @@ -26,7 +22,6 @@ import java.io.File import java.util.zip.ZipEntry import java.util.zip.ZipOutputStream -@OptIn(ExperimentalLayoutApi::class) @Composable actual fun PlatformAboutSection(component: AboutApp, section: Int) { val context = LocalContext.current @@ -39,29 +34,20 @@ actual fun PlatformAboutSection(component: AboutApp, section: Int) { section = section, title = Res.string.about_logs_header.get(), ) { - FlowRow( - horizontalArrangement = Arrangement.spacedBy(12.dp), - verticalArrangement = Arrangement.spacedBy(12.dp), - ) { - HdHairlineButton( - label = Res.string.about_logs_export_button.get(), - onClick = { - if (exporting) return@HdHairlineButton - exporting = true - scope.launch { - val success = exportAndShareLogs(context, state.logDirectoryPath) - if (!success) { - Toast.makeText(context, noLogsMessage, Toast.LENGTH_SHORT).show() - } - exporting = false + HdHairlineButton( + label = Res.string.about_logs_export_button.get(), + onClick = { + if (exporting) return@HdHairlineButton + exporting = true + scope.launch { + val success = exportAndShareLogs(context, state.logDirectoryPath) + if (!success) { + Toast.makeText(context, noLogsMessage, Toast.LENGTH_SHORT).show() } - }, - ) - CopyDiagnosticsButton( - logDirectoryPath = state.logDirectoryPath, - onStatus = { Toast.makeText(context, it, Toast.LENGTH_SHORT).show() }, - ) - } + exporting = false + } + }, + ) } } diff --git a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt index f7885d52a..d0994397c 100644 --- a/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt +++ b/composeUi/src/androidMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt @@ -6,7 +6,6 @@ import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.Spacer import androidx.compose.foundation.layout.width import androidx.compose.material.icons.Icons -import androidx.compose.material.icons.automirrored.filled.MenuBook import androidx.compose.material.icons.filled.Fullscreen import androidx.compose.material.icons.filled.Info import androidx.compose.material.icons.filled.Save @@ -14,7 +13,7 @@ import androidx.compose.material3.ExperimentalMaterial3Api import androidx.compose.material3.Icon import androidx.compose.material3.IconButton import androidx.compose.material3.MaterialTheme -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.derivedStateOf import androidx.compose.runtime.getValue @@ -42,7 +41,6 @@ import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.storyeditor.sceneTypeMeta import com.darkrockstudios.apps.hammer.scene_editor_cancel_button import com.darkrockstudios.apps.hammer.scene_editor_focus_mode_button -import com.darkrockstudios.apps.hammer.scene_editor_menu_item_read import com.darkrockstudios.apps.hammer.scene_editor_metadata_button import com.darkrockstudios.apps.hammer.scene_editor_name_hint import com.darkrockstudios.apps.hammer.scene_editor_rename_button @@ -111,16 +109,6 @@ actual fun EditorTopBar( } } - if (screen.windowWidthClass != WindowWidthSizeClass.Compact) { - IconButton(onClick = component::readScene) { - Icon( - imageVector = Icons.AutoMirrored.Filled.MenuBook, - contentDescription = Res.string.scene_editor_menu_item_read.get(), - tint = MaterialTheme.colorScheme.onSurface - ) - } - } - if (screen.windowWidthClass == WindowWidthSizeClass.Expanded) { IconButton(onClick = component::enterFocusMode) { Icon( diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/TextEditorDefaults.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/TextEditorDefaults.kt index 5c22c5678..ca71dbef9 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/TextEditorDefaults.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/TextEditorDefaults.kt @@ -3,6 +3,5 @@ package com.darkrockstudios.apps.hammer.common import androidx.compose.ui.unit.dp object TextEditorDefaults { - val MIN_WIDTH = 128.dp val MAX_WIDTH = 700.dp } \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.kt deleted file mode 100644 index 067c4aabb..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Composable - -/** - * Writes plain text to the system clipboard. Compose's own clipboard entries are platform-typed, - * so the seam sits here rather than at a shared call site. - */ -@Composable -expect fun rememberClipboardCopier(): (String) -> Unit diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ComposeRichText.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ComposeRichText.kt index 59329a103..ed8b1a175 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ComposeRichText.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ComposeRichText.kt @@ -1,7 +1,6 @@ package com.darkrockstudios.apps.hammer.common.compose import androidx.compose.ui.text.AnnotatedString -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration import com.darkrockstudios.apps.hammer.common.data.PlatformRichText import com.darkrockstudios.texteditor.markdown.MarkdownExtension import com.darkrockstudios.texteditor.markdown.toMarkdown @@ -17,12 +16,20 @@ data class ComposeRichText( override fun convertToMarkdown(): String { return when { - snapshot != null -> snapshot.toMarkdown(HammerMarkdownConfiguration) + snapshot != null -> snapshot.toMarkdown() state != null -> state.exportAsMarkdown() else -> error("ComposeRichText must contain non-null data ") } } + fun getAnnotatedString(): AnnotatedString { + return when { + snapshot != null -> snapshot + state != null -> state.editorState.getAllText() + else -> error("ComposeRichText must contain non-null data ") + } + } + override fun stateCompare(text: PlatformRichText?): Boolean { text as ComposeRichText return (snapshot != null && text.snapshot === snapshot) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/FileDialogRetry.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/FileDialogRetry.kt new file mode 100644 index 000000000..38636e2fb --- /dev/null +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/FileDialogRetry.kt @@ -0,0 +1,25 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import io.github.aakira.napier.Napier +import kotlin.coroutines.cancellation.CancellationException + +private const val FILE_DIALOG_ATTEMPTS = 4 + +// thar be dragons: FileKit's Windows backend calls CoInitializeEx on a shared Dispatchers.IO +// thread that may already be COM-initialized in a conflicting apartment, throwing +// "CoInitializeEx failed". Its teardown uninitializes that thread on failure, so retrying +// succeeds. Returns null rather than letting the dialog crash the app. +suspend fun retryingFileDialog(block: suspend () -> T?): T? { + var lastError: RuntimeException? = null + repeat(FILE_DIALOG_ATTEMPTS) { + try { + return block() + } catch (e: CancellationException) { + throw e + } catch (@Suppress("TooGenericExceptionCaught") e: RuntimeException) { + lastError = e + } + } + Napier.e("File dialog failed after $FILE_DIALOG_ATTEMPTS attempts", lastError) + return null +} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MarkdownConfig.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MarkdownConfig.kt new file mode 100644 index 000000000..79da0a400 --- /dev/null +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MarkdownConfig.kt @@ -0,0 +1,28 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import androidx.compose.runtime.Composable +import androidx.compose.runtime.CompositionLocalProvider +import androidx.compose.runtime.compositionLocalOf +import com.darkrockstudios.apps.hammer.common.compose.markdown.changeFontSize +import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings +import com.darkrockstudios.texteditor.markdown.MarkdownConfiguration + +val LocalMarkdownConfig = compositionLocalOf { + MarkdownConfiguration.DEFAULT +} + +@Composable +fun ProvideMarkdownConfig( + isDark: Boolean, + settings: GlobalSettings, + content: @Composable () -> Unit +) { + val baseMarkdownConfig = + if (isDark) MarkdownConfiguration.DEFAULT_DARK else MarkdownConfiguration.DEFAULT + val scaledMarkdownConfig = baseMarkdownConfig.changeFontSize(settings.editorFontSize) + + CompositionLocalProvider( + LocalMarkdownConfig provides scaledMarkdownConfig, + content = content + ) +} \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt index 003625877..37230f2a2 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt @@ -1,41 +1,12 @@ package com.darkrockstudios.apps.hammer.common.compose -import androidx.compose.foundation.ScrollState import androidx.compose.foundation.layout.fillMaxHeight import androidx.compose.foundation.lazy.LazyListState -import androidx.compose.foundation.lazy.grid.LazyGridState -import androidx.compose.foundation.lazy.staggeredgrid.LazyStaggeredGridState import androidx.compose.runtime.Composable import androidx.compose.ui.Modifier -import androidx.compose.ui.unit.Dp - -/** - * Width the scrollbar occupies at the scrollable edge. Screens whose content runs edge to edge - * should reserve this much trailing space so the bar does not sit on top of it. Zero on platforms - * whose scrollbar is a transient overlay. - */ -expect val MpScrollBarGutter: Dp @Composable expect fun MpScrollBarList( modifier: Modifier = Modifier.fillMaxHeight(), state: LazyListState ) - -@Composable -expect fun MpScrollBarColumn( - modifier: Modifier = Modifier.fillMaxHeight(), - state: ScrollState -) - -@Composable -expect fun MpScrollBarGrid( - modifier: Modifier = Modifier.fillMaxHeight(), - state: LazyGridState -) - -@Composable -expect fun MpScrollBarStaggeredGrid( - modifier: Modifier = Modifier.fillMaxHeight(), - state: LazyStaggeredGridState -) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHost.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHost.kt deleted file mode 100644 index 704cc49a7..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHost.kt +++ /dev/null @@ -1,38 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Stable - -/** - * Lets a platform host (Activity, view controller, window) fire the project shortcuts from its - * own key handling. Compose's key modifiers only see events routed along the focus path, so a - * screen with nothing focused never receives them. - * - * Each action returns false when no project UI is bound, so the host can pass the key on. - */ -@Stable -class ProjectShortcutHost { - private var startSync: (() -> Unit)? = null - private var saveAll: (() -> Unit)? = null - - fun bind(startSync: () -> Unit, saveAll: () -> Unit) { - this.startSync = startSync - this.saveAll = saveAll - } - - fun unbind() { - startSync = null - saveAll = null - } - - fun startProjectSync(): Boolean { - val action = startSync ?: return false - action() - return true - } - - fun saveAllBuffers(): Boolean { - val action = saveAll ?: return false - action() - return true - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt new file mode 100644 index 000000000..d8b827a9c --- /dev/null +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt @@ -0,0 +1,7 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import androidx.compose.runtime.Composable +import androidx.compose.ui.graphics.painter.Painter + +@Composable +expect fun painterResource(res: String, drawableKlass: Any? = null): Painter \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/RichTextStylesProvider.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/RichTextStylesProvider.kt deleted file mode 100644 index 41438a72d..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/RichTextStylesProvider.kt +++ /dev/null @@ -1,55 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.CompositionLocalProvider -import androidx.compose.runtime.compositionLocalOf -import androidx.compose.ui.text.SpanStyle -import androidx.compose.ui.text.TextStyle -import androidx.compose.ui.text.font.FontWeight -import androidx.compose.ui.text.style.TextIndent -import androidx.compose.ui.unit.em -import androidx.compose.ui.unit.sp -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.texteditor.RichTextStyles - -/** - * Heading sizes are relative to the editor's text style, so the body size lives in - * [LocalEditorTextStyle] alone and changing it rewrites no document. - */ -val HammerRichTextStyles = RichTextStyles( - defaultTextStyle = SpanStyle(), - header1Style = SpanStyle(fontSize = 2.em, fontWeight = FontWeight.Bold), - header2Style = SpanStyle(fontSize = 1.5.em, fontWeight = FontWeight.Bold), - header3Style = SpanStyle(fontSize = 1.17.em, fontWeight = FontWeight.Bold), - header4Style = SpanStyle(fontSize = 1.em, fontWeight = FontWeight.Bold), - header5Style = SpanStyle(fontSize = 0.83.em, fontWeight = FontWeight.Bold), - header6Style = SpanStyle(fontSize = 0.75.em, fontWeight = FontWeight.Bold), -) - -val HammerRichTextStylesDark = HammerRichTextStyles.copy( - codeStyle = RichTextStyles.DEFAULT_DARK.codeStyle, - highlightStyle = RichTextStyles.DEFAULT_DARK.highlightStyle, -) - -val LocalRichTextStyles = compositionLocalOf { HammerRichTextStyles } - -/** The editor's body text style; every rich text size scales from it. */ -val LocalEditorTextStyle = compositionLocalOf { - TextStyle(fontSize = GlobalSettings.DEFAULT_FONT_SIZE.sp) -} - -@Composable -fun ProvideRichTextStyles( - isDark: Boolean, - settings: GlobalSettings, - content: @Composable () -> Unit -) { - CompositionLocalProvider( - LocalRichTextStyles provides if (isDark) HammerRichTextStylesDark else HammerRichTextStyles, - LocalEditorTextStyle provides TextStyle(fontSize = settings.editorFontSize.sp), - content = content - ) -} - -/** A first-line indent that scales with the body size. */ -fun TextStyle.withParagraphIndent(): TextStyle = copy(textIndent = TextIndent(firstLine = 1.5.em)) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScreenCharacteristics.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScreenCharacteristics.kt index 0a8069c44..a2790e535 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScreenCharacteristics.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScreenCharacteristics.kt @@ -2,6 +2,10 @@ package com.darkrockstudios.apps.hammer.common.compose import androidx.compose.foundation.layout.BoxWithConstraints import androidx.compose.foundation.layout.BoxWithConstraintsScope +import androidx.compose.material3.windowsizeclass.ExperimentalMaterial3WindowSizeClassApi +import androidx.compose.material3.windowsizeclass.WindowHeightSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.calculateWindowSizeClass import androidx.compose.runtime.* import androidx.compose.ui.unit.Dp import com.darkrockstudios.apps.hammer.common.uiNeedsExplicitCloseButtons @@ -22,11 +26,12 @@ val LocalScreenCharacteristic = staticCompositionLocalOf { ) } +@OptIn(ExperimentalMaterial3WindowSizeClassApi::class) @Composable fun SetScreenCharacteristics(wideThreshold: Dp, content: @Composable BoxWithConstraintsScope.() -> Unit) { BoxWithConstraints { val isWide by remember(maxWidth) { derivedStateOf { maxWidth >= wideThreshold } } - val windowSizeClass = rememberWindowSizeClass(constraints) + val windowSizeClass = calculateWindowSizeClass() CompositionLocalProvider( LocalScreenCharacteristic provides ScreenCharacteristics( diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScrollBarOverlay.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScrollBarOverlay.kt deleted file mode 100644 index c0f2ee183..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ScrollBarOverlay.kt +++ /dev/null @@ -1,22 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.foundation.gestures.ScrollableState -import androidx.compose.foundation.layout.BoxScope -import androidx.compose.foundation.layout.wrapContentWidth -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier - -/** Whether there is anywhere left to scroll in either direction. */ -val ScrollableState.isScrollable: Boolean - get() = canScrollForward || canScrollBackward - -/** - * Placement for a scrollbar overlaid on a scrolling sibling: full height, pinned to the trailing - * edge. Uses [BoxScope.matchParentSize] rather than `fillMaxHeight` so the bar never contributes to - * the parent's size, which matters in the wrap-content boxes the detail screens use. - */ -@Suppress("ModifierFactoryExtensionFunction") -fun BoxScope.scrollBarOverlay(): Modifier = - Modifier - .matchParentSize() - .wrapContentWidth(Alignment.End) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/SerializableSaver.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/SerializableSaver.kt index 3f38cc95c..5f0a70a19 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/SerializableSaver.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/SerializableSaver.kt @@ -1,12 +1,6 @@ package com.darkrockstudios.apps.hammer.common.compose -import androidx.compose.runtime.Composable -import androidx.compose.runtime.mutableStateListOf import androidx.compose.runtime.saveable.Saver -import androidx.compose.runtime.saveable.listSaver -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.snapshots.SnapshotStateList -import androidx.compose.runtime.toMutableStateList import kotlinx.serialization.json.Json /** @@ -39,15 +33,3 @@ inline fun serializableSaverNonNull(): Saver = Save save = { value -> Json.encodeToString(value) }, restore = { json -> Json.decodeFromString(json) } ) - -/** - * A string list that survives a configuration change. Use it for draft collections (tags, chips, - * selections) that a plain [mutableStateListOf] would drop when the composition is rebuilt. - */ -@Composable -fun rememberSaveableStringList(): SnapshotStateList = rememberSaveable( - saver = listSaver, String>( - save = { it.toList() }, - restore = { it.toMutableStateList() }, - ) -) { mutableStateListOf() } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ShortcutModifiers.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ShortcutModifiers.kt index 08d85ca7b..e580425e9 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ShortcutModifiers.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ShortcutModifiers.kt @@ -2,25 +2,6 @@ package com.darkrockstudios.apps.hammer.common.compose import androidx.compose.ui.Modifier import androidx.compose.ui.input.key.* -import com.darkrockstudios.texteditor.input.layoutKey - -/** - * Matches a key-down with exactly these modifiers: extra ones do not count as a match. - * Letters match on [layoutKey], as the editor's built-in chords do. - */ -fun KeyEvent.matchesShortcut( - key: Key, - ctrl: Boolean = false, - shift: Boolean = false, - alt: Boolean = false, -): Boolean { - val ctrlOrMeta = isCtrlPressed || isMetaPressed - return type == KeyEventType.KeyDown && - layoutKey == key && - ctrlOrMeta == ctrl && - isShiftPressed == shift && - isAltPressed == alt -} internal fun Modifier.onKeyShortcut( key: Key, @@ -29,7 +10,13 @@ internal fun Modifier.onKeyShortcut( alt: Boolean = false, action: () -> Unit, ): Modifier = onPreviewKeyEvent { event -> - if (event.matchesShortcut(key, ctrl, shift, alt)) { + val ctrlOrMeta = event.isCtrlPressed || event.isMetaPressed + if (event.type == KeyEventType.KeyDown && + event.key == key && + ctrlOrMeta == ctrl && + event.isShiftPressed == shift && + event.isAltPressed == alt + ) { action() true } else { @@ -43,6 +30,12 @@ fun Modifier.findShortcutModifier(showFindBar: () -> Unit): Modifier = fun Modifier.saveShortcutModifier(onSave: () -> Unit): Modifier = onKeyShortcut(Key.S, ctrl = true, action = onSave) +fun Modifier.saveAllShortcutModifier(onSaveAll: () -> Unit): Modifier = + onKeyShortcut(Key.S, ctrl = true, alt = true, action = onSaveAll) + +fun Modifier.syncShortcutModifier(onSync: () -> Unit): Modifier = + onKeyShortcut(Key.F3, action = onSync) + fun Modifier.boldShortcutModifier(onBold: () -> Unit): Modifier = onKeyShortcut(Key.B, ctrl = true, action = onBold) @@ -51,18 +44,3 @@ fun Modifier.italicShortcutModifier(onItalic: () -> Unit): Modifier = fun Modifier.strikethroughShortcutModifier(onStrikethrough: () -> Unit): Modifier = onKeyShortcut(Key.X, ctrl = true, shift = true, action = onStrikethrough) - -/** Ctrl/Cmd with Plus, Minus and 0, as browsers zoom. Plus is Shift+Equals on most layouts. */ -fun Modifier.textSizeShortcutModifier( - onIncrease: () -> Unit, - onDecrease: () -> Unit, - onReset: () -> Unit, -): Modifier = this - .onKeyShortcut(Key.Equals, ctrl = true, action = onIncrease) - .onKeyShortcut(Key.Equals, ctrl = true, shift = true, action = onIncrease) - .onKeyShortcut(Key.Plus, ctrl = true, action = onIncrease) - .onKeyShortcut(Key.NumPadAdd, ctrl = true, action = onIncrease) - .onKeyShortcut(Key.Minus, ctrl = true, action = onDecrease) - .onKeyShortcut(Key.NumPadSubtract, ctrl = true, action = onDecrease) - .onKeyShortcut(Key.Zero, ctrl = true, action = onReset) - .onKeyShortcut(Key.NumPad0, ctrl = true, action = onReset) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/WindowSizeClass.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/WindowSizeClass.kt deleted file mode 100644 index fa19eacfa..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/WindowSizeClass.kt +++ /dev/null @@ -1,56 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.remember -import androidx.compose.ui.platform.LocalDensity -import androidx.compose.ui.unit.Constraints -import androidx.compose.ui.unit.Density -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -/** Width buckets, using the Material 3 window size class breakpoints. */ -enum class WindowWidthSizeClass { Compact, Medium, Expanded } - -/** Height buckets, using the Material 3 window size class breakpoints. */ -enum class WindowHeightSizeClass { Compact, Medium, Expanded } - -data class WindowSizeClass( - val widthSizeClass: WindowWidthSizeClass, - val heightSizeClass: WindowHeightSizeClass, -) { - companion object { - private val MediumWidth = 600.dp - private val ExpandedWidth = 840.dp - private val MediumHeight = 480.dp - private val ExpandedHeight = 900.dp - - fun widthClassOf(width: Dp): WindowWidthSizeClass = when { - width < MediumWidth -> WindowWidthSizeClass.Compact - width < ExpandedWidth -> WindowWidthSizeClass.Medium - else -> WindowWidthSizeClass.Expanded - } - - fun heightClassOf(height: Dp): WindowHeightSizeClass = when { - height < MediumHeight -> WindowHeightSizeClass.Compact - height < ExpandedHeight -> WindowHeightSizeClass.Medium - else -> WindowHeightSizeClass.Expanded - } - - fun calculateFromSize(widthPx: Int, heightPx: Int, density: Density): WindowSizeClass = - with(density) { - WindowSizeClass( - widthSizeClass = widthClassOf(widthPx.toDp()), - heightSizeClass = heightClassOf(heightPx.toDp()), - ) - } - } -} - -/** Derived from the space the UI occupies; the Tao backend has no AWT window to measure. */ -@Composable -fun rememberWindowSizeClass(constraints: Constraints): WindowSizeClass { - val density = LocalDensity.current - return remember(constraints, density) { - WindowSizeClass.calculateFromSize(constraints.maxWidth, constraints.maxHeight, density) - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/DESIGN_README.md b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/DESIGN_README.md index d8d0c61bb..913dfa887 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/DESIGN_README.md +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/DESIGN_README.md @@ -208,32 +208,6 @@ These set up the page. Use them before reaching for raw `Column` / │ └─[ KTOR · HTTPS ]─────────[ LAST SYNC 14:32 ]┘ │ └──────────────────────────────────────────────────┘ -- **[`HdIndentRails`](HdIndentRails.kt)** — the nesting vocabulary for - tree rows: `HdIndentStep` (one level = one disclosure column), - `hdIndentFor(depth)` for a row's start inset, and - `Modifier.hdIndentRails(levels, color)` to draw one vertical hairline - per ancestor, each centered on the disclosure column that owns it. - Every row in a tree — parent and leaf alike — takes its inset from - `hdIndentFor`, and a leaf adds one more `HdIndentStep` to clear the - chevron column, so a child's label sits exactly one step right of its - parent's. The rails are the marginalia rule applied along the depth - axis: without them 16dp steps stop being traceable past two levels. - - ⌄ Chapter I 3 SCN - ┆ At Home - ┆ ⌄ Chapter II 2 SCN - ┆ ┆ The Pool of Tears - -- **[`HdScrollAwayFooter`](HdScrollAwayFooter.kt)**: hairline action - strip that floats over the bottom of a scrolling pane and slides away - as the reader scrolls down. It is an **overlay**, never a sibling in - a `Column`: host it in the same `Box` as the list, wire - `state.nestedScrollConnection` to the list, and pass `state.height` - as the list's bottom `contentPadding` so the last row clears the - strip. A footer that takes layout space changes what the list can - scroll, which flips any visibility rule keyed off scroll position and - flickers the strip on and off. - ### Mono & numeric labels The handwriting of the system. Reach for these instead of styling @@ -261,11 +235,6 @@ The handwriting of the system. Reach for these instead of styling `LocalHammerColors`. - **[`HdDailyGoalProgress`](HdDailyGoalProgress.kt)** — daily-goal pair with thin progress bar. -- **[`HdWarningNotice`](HdWarningNotice.kt)** — amber hairline callout: - `HdWarnGlyph` + mono label over a body message. For a condition the - user should see before acting on it, where an error dialog would be - too much and silence too little. Non-blocking by design — the action - it warns about stays available. ### Buttons & inputs @@ -291,13 +260,6 @@ The handwriting of the system. Reach for these instead of styling - **[`HdHairlineTagField`](HdHairlineTagField.kt)** — same vocabulary but the value is a `List` of `HdTagChip`s; Enter / comma adds a tag, Backspace on empty removes the last. -- **[`HdHairlineWordListField`](HdHairlineWordListField.kt)**: the - tag field's shape for a plain word list (the project dictionary): - neutral `#` chips that wrap instead of scrolling, Enter / comma / - space commits, and the caller's `parseInput` decides what a word is. - Both fields are thin wrappers over the internal - [`HdHairlineChipInput`](HdHairlineChipInput.kt), which owns the chip - run, the draft input, and its key and focus handling. - **[`HdHairlineTypePicker`](HdHairlineTypePicker.kt)** — segmented picker for `EntryType`. Glyph square + mono label per cell, 2dp top stripe in the type's color when active. @@ -329,30 +291,6 @@ The handwriting of the system. Reach for these instead of styling `DropdownMenu`. Same signature as `HdHairlineSegmentedPicker`, so swapping is one-for-one. Use for enums of 4+ values where a segmented row would crowd. -- **[`HdSearchableListDialog`](HdSearchableListDialog.kt)** — hairline - dialog with an `HdSearchField` over a lazy row list, each row a label - plus optional mono greeble (`English (United States) EN-US`). - Use where a dropdown would be unwieldy: dozens to hundreds of - options, e.g. every platform locale. Optional muted clear row above - the list resets the selection. -- **[`HdResizeHandle`](HdResizeHandle.kt)**: full-height 16dp gutter - on the start edge of a centered, width-capped column (the scene - editor, focus mode) that drags the column wider or narrower. Shows - the `HdDragHandle` grip glyph at low alpha, full alpha on hover or - drag; desktop gets a horizontal-resize cursor via expect/actual - (the scrollbar-rail precedent for desktop-flavored affordances); - double-click resets. Reports drag deltas outward-positive - regardless of layout direction, so callers stay RTL-safe and a - centered column grows by twice the reported delta. Pair it with - `rememberHdResizeHandleState`, which owns the drag math, - commit-on-drag-end, and the `showHandle` gate that hides it on - narrow layouts (`RESIZE_HANDLE_MIN_SLACK` beyond the column's - minimum width, so an over-wide persisted value can always be - shrunk back). - - ┆▪ ▪┆ ┌────────────────────┐ - ┆▪ ▪┆ │ centered column │ - ┆▪ ▪┆ └────────────────────┘ ### Categorization @@ -746,59 +684,6 @@ Encyclopedia). Tag collapse lives inside `HdHairlineTagField` so it works wherever the field is used; date and crumb rows are wrapped at their call sites. -### Scrollbar rail - -Desktop scrollbars are drawn as a **hatched rail** rather than a bare -thumb: a vertical `outlineVariant` hairline marking the scrollable edge, -with 45° hairline hatching filling the track behind an opaque square -thumb. - -``` -│╱╱╱│ -│███│ <- thumb, masking the hatch -│╱╱╱│ - ^ edge rule -``` - -The hatch is [greeble](#greebles) logic applied to texture — it means -something. The thumb masks it as it travels, so the hatching that -remains is exactly the part of the document you haven't reached. It also -follows rule 1: the edge rule is the same vertical hairline -`HdHairlineSection` uses to group content, so a scrolling screen reads -as bounded rather than cut off. - -Both the rule and the hatch are drawn **only while there is somewhere to -scroll**, so a screen whose content fits gets no chrome at all. The -thumb rests at `outlineVariant` and promotes to `outline` on hover — -Compose's default is 12% black, which vanishes on a dark surface. - -Screens don't build any of this. Overlay the bar on its scrolling -sibling inside a `Box`: - -```kotlin -Box(Modifier.weight(1f)) { - LazyColumn(state = listState) { … } - MpScrollBarList(modifier = scrollBarOverlay(), state = listState) -} -``` - -- **[`scrollBarOverlay()`](../ScrollBarOverlay.kt)** is the only correct - placement — `matchParentSize()`, so the bar never contributes to the - parent's size. `fillMaxHeight()` would stretch the wrap-content boxes - the detail screens use. -- **[`MpScrollBarGutter`](../MpScrollBar.kt)** is the width to reserve - when content runs *edge to edge* (a full-bleed row that paints its own - background, or a drag surface). Screens with normal horizontal padding - need nothing — the rail sits in the padding they already have. - -**Platform caveat, and a known exception to cross-platform parity.** The -rail is `desktopMain` only. Android draws a transient fading thumb and -iOS uses its native inline indicators, so `MpScrollBarGutter` is `0.dp` -on both. This is the one piece of visual vocabulary that isn't -`commonMain`; a persistent hatched rail is right for a pointer and wrong -for a touch screen. If it ever needs to be shared, the drawing belongs -in an `Hd*` here and the platform files should supply only the thumb. - --- ## Adding to the system diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdChapter.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdChapter.kt deleted file mode 100644 index e2559c4fc..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdChapter.kt +++ /dev/null @@ -1,284 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.animation.AnimatedVisibility -import androidx.compose.animation.core.animateFloatAsState -import androidx.compose.animation.expandVertically -import androidx.compose.animation.fadeIn -import androidx.compose.animation.fadeOut -import androidx.compose.animation.shrinkVertically -import androidx.compose.foundation.background -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.* -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.itemsIndexed -import androidx.compose.material.icons.Icons -import androidx.compose.material.icons.filled.KeyboardArrowDown -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.Icon -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.* -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.rotate -import androidx.compose.ui.graphics.Color -import androidx.compose.ui.text.font.FontWeight -import androidx.compose.ui.text.style.TextOverflow -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.sp -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.scene_list_outline_overview_chapter_eyebrow -import com.darkrockstudios.apps.hammer.scene_list_outline_overview_jump_to -import com.darkrockstudios.apps.hammer.scene_list_outline_overview_position -import com.darkrockstudios.apps.hammer.scene_list_outline_overview_scene_count - -/** One chapter as listed by [HdChapterRailItem] and [HdChapterDropdown]. */ -@Immutable -data class HdChapterRow(val title: String, val sceneCount: Int) - -/** - * A chapter entry for a jump list: roman numeral, title and scene count, - * with a primary-colored edge bar when [selected]. - */ -@Composable -fun HdChapterRailItem( - index: Int, - row: HdChapterRow, - selected: Boolean, - onClick: () -> Unit, - modifier: Modifier = Modifier, -) { - val accent = MaterialTheme.colorScheme.primary - val rowBg = if (selected) { - MaterialTheme.colorScheme.surfaceContainer - } else { - MaterialTheme.colorScheme.surfaceContainerLow - } - - Row( - modifier = modifier - .fillMaxWidth() - .height(IntrinsicSize.Min) - .background(rowBg) - .clickable(onClick = onClick), - verticalAlignment = Alignment.Top, - ) { - Box( - modifier = Modifier - .width(2.dp) - .fillMaxHeight() - .background(if (selected) accent else Color.Transparent), - ) - Row( - modifier = Modifier - .fillMaxWidth() - .padding( - start = Ui.Padding.L, - end = Ui.Padding.XL, - top = Ui.Padding.L, - bottom = Ui.Padding.L, - ), - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), - verticalAlignment = Alignment.Top, - ) { - Text( - text = romanNumeral(index + 1), - style = MaterialTheme.typography.titleLarge, - fontWeight = FontWeight.Light, - color = if (selected) { - MaterialTheme.colorScheme.onSurface - } else { - MaterialTheme.colorScheme.onSurfaceVariant - }, - modifier = Modifier.widthIn(min = 24.dp), - ) - Column( - modifier = Modifier.weight(1f), - verticalArrangement = Arrangement.spacedBy(2.dp), - ) { - Text( - text = row.title, - style = MaterialTheme.typography.titleSmall, - fontWeight = if (selected) FontWeight.Medium else FontWeight.Normal, - color = MaterialTheme.colorScheme.onSurface, - maxLines = 1, - overflow = TextOverflow.Ellipsis, - ) - HdMonoLabel( - text = Res.string.scene_list_outline_overview_scene_count.get(row.sceneCount), - ) - } - } - } -} - -/** - * Collapsed chapter picker for narrow layouts: a full-width bar showing the - * selected chapter and its position, expanding in place to the chapter list. - */ -@Composable -fun HdChapterDropdown( - rows: List, - selectedIndex: Int, - onSelect: (Int) -> Unit, - modifier: Modifier = Modifier, -) { - var expanded by remember { mutableStateOf(false) } - val rotation by animateFloatAsState( - targetValue = if (expanded) 180f else 0f, - label = "chapterDropdownRotation", - ) - val current = rows.getOrNull(selectedIndex) - - Column(modifier = modifier.fillMaxWidth()) { - Row( - modifier = Modifier - .fillMaxWidth() - .background(MaterialTheme.colorScheme.surfaceContainerLow) - .clickable { expanded = !expanded } - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.L), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - HdMonoLabel(text = Res.string.scene_list_outline_overview_jump_to.get()) - Row( - modifier = Modifier.weight(1f), - verticalAlignment = Alignment.Bottom, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), - ) { - Text( - text = romanNumeral(selectedIndex + 1), - style = MaterialTheme.typography.titleMedium, - fontWeight = FontWeight.Light, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - Text( - text = current?.title.orEmpty(), - style = MaterialTheme.typography.titleMedium, - fontWeight = FontWeight.Medium, - color = MaterialTheme.colorScheme.onSurface, - maxLines = 1, - overflow = TextOverflow.Ellipsis, - ) - } - HdMonoLabel( - text = Res.string.scene_list_outline_overview_position.get( - selectedIndex + 1, - rows.size, - ), - ) - Icon( - imageVector = Icons.Default.KeyboardArrowDown, - contentDescription = null, - tint = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier - .size(20.dp) - .rotate(rotation), - ) - } - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - - AnimatedVisibility( - visible = expanded, - enter = expandVertically() + fadeIn(), - exit = shrinkVertically() + fadeOut(), - ) { - Column( - modifier = Modifier - .fillMaxWidth() - .heightIn(max = 320.dp) - .background(MaterialTheme.colorScheme.surface), - ) { - LazyColumn(modifier = Modifier.fillMaxWidth()) { - itemsIndexed(rows, key = { idx, _ -> "drop-$idx" }) { idx, row -> - HdChapterRailItem( - index = idx, - row = row, - selected = idx == selectedIndex, - onClick = { - onSelect(idx) - expanded = false - }, - ) - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - } - } - } - } - } -} - -/** Chapter opener: mono eyebrow with numeral and scene count, light title, hairline rule. */ -@Composable -fun HdChapterHeader( - index: Int, - title: String, - sceneCount: Int, - wide: Boolean, - modifier: Modifier = Modifier, -) { - val titleStyle = if (wide) { - MaterialTheme.typography.headlineLarge - } else { - MaterialTheme.typography.headlineMedium - } - Column(modifier = modifier, verticalArrangement = Arrangement.spacedBy(Ui.Padding.M)) { - HdMonoLabel( - text = Res.string.scene_list_outline_overview_chapter_eyebrow.get( - romanNumeral(index + 1), - sceneCount, - ), - ) - Text( - text = title, - style = titleStyle, - fontWeight = FontWeight.Light, - color = MaterialTheme.colorScheme.onSurface, - ) - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - modifier = Modifier.padding(top = Ui.Padding.M), - ) - } -} - -/** Centered `· · ·` ornament marking a break between passages. */ -@Composable -fun HdSceneBreak(modifier: Modifier = Modifier) { - Box( - modifier = modifier.fillMaxWidth(), - contentAlignment = Alignment.Center, - ) { - Text( - text = "· · ·", - style = MaterialTheme.typography.titleLarge.copy(letterSpacing = 8.sp), - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } -} - -/** Closing mark for a long read: a hairline rule over a centered mono [label]. */ -@Composable -fun HdEndMark(label: String, modifier: Modifier = Modifier) { - Column( - modifier = modifier.fillMaxWidth().padding(top = Ui.Padding.L), - horizontalAlignment = Alignment.CenterHorizontally, - verticalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - HdMonoLabel(text = label) - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdCredentialFields.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdCredentialFields.kt deleted file mode 100644 index f7352e1a3..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdCredentialFields.kt +++ /dev/null @@ -1,106 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.text.input.ImeAction -import androidx.compose.ui.text.input.KeyboardCapitalization -import androidx.compose.ui.text.input.KeyboardType -import androidx.compose.ui.text.input.PasswordVisualTransformation -import androidx.compose.ui.text.input.VisualTransformation -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.settings_server_setup_password_hide -import com.darkrockstudios.apps.hammer.settings_server_setup_password_show - -/** - * Credential entry built on [HdHairlineField]. - * - * Anything the user has to reproduce byte-for-byte on another device — a - * password, the email it is keyed to — must reach the server exactly as typed. - * These wrappers pin the keyboard options that guarantee that, so no screen has - * to remember them: IME auto-capitalization and autocorrect are off, and the - * password variant carries its own show/hide toggle. - */ -@Composable -fun HdPasswordField( - label: String, - value: String, - onValueChange: (String) -> Unit, - visible: Boolean, - onVisibleChange: (Boolean) -> Unit, - modifier: Modifier = Modifier, - placeholder: String? = null, - hint: String? = null, - error: String? = null, - imeAction: ImeAction = ImeAction.Done, - enabled: Boolean = true, - testTag: String? = null, -) { - Column( - modifier = modifier.fillMaxWidth(), - verticalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - HdHairlineField( - label = label, - value = value, - onValueChange = onValueChange, - placeholder = placeholder, - hint = hint, - error = error, - singleLine = true, - imeAction = imeAction, - capitalization = KeyboardCapitalization.None, - autoCorrectEnabled = false, - keyboardType = KeyboardType.Password, - visualTransformation = if (visible) VisualTransformation.None - else PasswordVisualTransformation(), - enabled = enabled, - testTag = testTag, - ) - - HdHairlineToggleRow( - checked = visible, - onCheckedChange = onVisibleChange, - label = if (visible) { - Res.string.settings_server_setup_password_hide.get() - } else { - Res.string.settings_server_setup_password_show.get() - }, - ) - } -} - -@Composable -fun HdEmailField( - label: String, - value: String, - onValueChange: (String) -> Unit, - modifier: Modifier = Modifier, - placeholder: String? = null, - hint: String? = null, - error: String? = null, - imeAction: ImeAction = ImeAction.Next, - enabled: Boolean = true, - testTag: String? = null, -) { - HdHairlineField( - label = label, - value = value, - onValueChange = onValueChange, - modifier = modifier, - placeholder = placeholder, - hint = hint, - error = error, - singleLine = true, - imeAction = imeAction, - capitalization = KeyboardCapitalization.None, - autoCorrectEnabled = false, - keyboardType = KeyboardType.Email, - enabled = enabled, - testTag = testTag, - ) -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineChipInput.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineChipInput.kt deleted file mode 100644 index c9e66e387..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineChipInput.kt +++ /dev/null @@ -1,173 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.horizontalScroll -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.heightIn -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.width -import androidx.compose.foundation.rememberScrollState -import androidx.compose.foundation.text.BasicTextField -import androidx.compose.foundation.text.KeyboardOptions -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.focus.onFocusChanged -import androidx.compose.ui.graphics.SolidColor -import androidx.compose.ui.input.key.Key -import androidx.compose.ui.input.key.KeyEventType -import androidx.compose.ui.input.key.key -import androidx.compose.ui.input.key.onPreviewKeyEvent -import androidx.compose.ui.input.key.type -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.text.input.ImeAction -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -/** - * The body shared by [HdHairlineTagField] and [HdHairlineWordListField]: mono label and - * hint, a run of removable [HdTagChip]s, a trailing draft input that commits on Enter or - * focus loss and removes the last chip on Backspace when empty, and the hairline rule. - * Parsing and persistence stay with the caller, which also decides what typed text does - * through [onInput]. - * - * @param onInput Receives every value change of the draft input. - * @param onCommitDraft Commits the draft; returns whether the key event was consumed. - * @param onRemoveLast Removes the last chip; returns whether the key event was consumed. - * @param wrapChips Wrap chips onto further rows instead of scrolling one row sideways. - * @param accentChips Give each chip its per-label color swatch instead of a neutral `#`. - * @param footer Drawn under the rule, e.g. a suggestion strip. - */ -@OptIn(ExperimentalLayoutApi::class) -@Composable -internal fun HdHairlineChipInput( - label: String, - chips: List, - draft: String, - onInput: (String) -> Unit, - onCommitDraft: () -> Boolean, - onRemoveLast: () -> Boolean, - onRemoveChip: (String) -> Unit, - modifier: Modifier = Modifier, - hint: String? = null, - placeholder: String? = null, - wrapChips: Boolean = false, - accentChips: Boolean = true, - testTag: String? = null, - onFocusChanged: (Boolean) -> Unit = {}, - footer: @Composable () -> Unit = {}, -) { - val onSurface = MaterialTheme.colorScheme.onSurface - val muted = MaterialTheme.colorScheme.onSurfaceVariant - val textStyle = MaterialTheme.typography.bodyMedium.copy(color = onSurface) - - Column(modifier = modifier.fillMaxWidth()) { - Row( - modifier = Modifier.fillMaxWidth(), - verticalAlignment = Alignment.Bottom, - horizontalArrangement = Arrangement.spacedBy(10.dp), - ) { - HdMonoLabel(text = label) - if (hint != null) { - HdMonoLabel(text = hint, color = muted) - } - } - - val content: @Composable () -> Unit = { - chips.forEach { chip -> - if (accentChips) { - HdTagChip(label = chip, active = true, onRemove = { onRemoveChip(chip) }) - } else { - HdTagChip(label = chip, active = true, accent = null, onRemove = { onRemoveChip(chip) }) - } - } - Box( - modifier = Modifier - .width(200.dp) - .heightIn(min = 24.dp) - .padding(vertical = 2.dp), - contentAlignment = Alignment.CenterStart, - ) { - BasicTextField( - value = draft, - onValueChange = onInput, - singleLine = true, - textStyle = textStyle, - cursorBrush = SolidColor(onSurface), - keyboardOptions = KeyboardOptions( - imeAction = ImeAction.Done, - autoCorrectEnabled = false, - ), - modifier = Modifier - .fillMaxWidth() - .heightIn(min = 24.dp) - .onFocusChanged { focusState -> - onFocusChanged(focusState.isFocused) - // A typed-but-uncommitted value would otherwise be silently - // dropped when focus moves on; commit it instead. - if (!focusState.isFocused && draft.isNotBlank()) { - onCommitDraft() - } - } - .then(if (testTag != null) Modifier.testTag(testTag) else Modifier) - .onPreviewKeyEvent { event -> - if (event.type != KeyEventType.KeyDown) return@onPreviewKeyEvent false - when (event.key) { - Key.Enter, Key.NumPadEnter -> onCommitDraft() - Key.Backspace -> onRemoveLast() - else -> false - } - }, - ) - if (draft.isEmpty() && chips.isEmpty() && placeholder != null) { - Text( - text = placeholder, - style = textStyle.copy(color = muted), - ) - } - } - } - - if (wrapChips) { - FlowRow( - modifier = Modifier - .fillMaxWidth() - .heightIn(min = 38.dp) - .padding(top = 6.dp, bottom = 6.dp), - horizontalArrangement = Arrangement.spacedBy(6.dp), - verticalArrangement = Arrangement.spacedBy(6.dp), - ) { - content() - } - } else { - // One scrollable line: chips and input share a fixed container so focus survives - // the keyboard opening, and chips never wrap to extra rows that eat editor space. - Row( - modifier = Modifier - .fillMaxWidth() - .heightIn(min = 38.dp) - .horizontalScroll(rememberScrollState()) - .padding(top = 6.dp, bottom = 6.dp), - horizontalArrangement = Arrangement.spacedBy(6.dp), - verticalAlignment = Alignment.CenterVertically, - ) { - content() - } - } - - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - - footer() - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineField.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineField.kt index 2d6e1d5ed..facf3aeb9 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineField.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineField.kt @@ -47,7 +47,6 @@ fun HdHairlineField( maxLines: Int = if (singleLine) 1 else Int.MAX_VALUE, imeAction: ImeAction = if (singleLine) ImeAction.Next else ImeAction.Default, capitalization: KeyboardCapitalization = KeyboardCapitalization.Sentences, - autoCorrectEnabled: Boolean? = null, keyboardType: KeyboardType = KeyboardType.Text, visualTransformation: VisualTransformation = VisualTransformation.None, enabled: Boolean = true, @@ -108,7 +107,6 @@ fun HdHairlineField( keyboardOptions = KeyboardOptions( imeAction = imeAction, capitalization = capitalization, - autoCorrectEnabled = autoCorrectEnabled, keyboardType = keyboardType, ), ) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineTagField.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineTagField.kt index dbdd69074..3a196e629 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineTagField.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineTagField.kt @@ -1,35 +1,37 @@ package com.darkrockstudios.apps.hammer.common.compose.designsystem -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue +import androidx.compose.foundation.horizontalScroll +import androidx.compose.foundation.layout.* +import androidx.compose.foundation.rememberScrollState +import androidx.compose.foundation.text.BasicTextField +import androidx.compose.foundation.text.KeyboardOptions +import androidx.compose.material3.HorizontalDivider +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.Text +import androidx.compose.runtime.* +import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.focus.focusProperties +import androidx.compose.ui.focus.onFocusChanged +import androidx.compose.ui.graphics.SolidColor +import androidx.compose.ui.platform.testTag +import androidx.compose.ui.input.key.* +import androidx.compose.ui.text.input.ImeAction +import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.common.compose.CollapseWhileTyping -import com.darkrockstudios.apps.hammer.common.data.tagindex.isTagSeparator -import com.darkrockstudios.apps.hammer.common.data.tagindex.parseTagInput -import com.darkrockstudios.apps.hammer.common.data.tagindex.replaceTagPrefix -import com.darkrockstudios.apps.hammer.common.data.tagindex.tagPrefixOf /** - * Tag chip field: labeled hairline-underline input that keeps its value as a list of - * tags rather than a free-form string. Each tag renders as an [HdTagChip] with a `×` - * remove affordance; the trailing input adds a tag on Enter or comma and removes the - * last tag on Backspace when empty. Built on [HdHairlineChipInput]. + * Tag chip field — labeled hairline-underline input that keeps its + * value as a list of tags rather than a free-form string. Each tag + * renders as an [HdTagChip] with a `×` remove affordance; the trailing + * input adds a tag on Enter or comma and removes the last tag on + * Backspace when empty. * * TAGS ↵ to add * [# animal ×] [# guide ×] ritual,… * ──────────────────────────────────────────── */ +@OptIn(ExperimentalLayoutApi::class) @Composable fun HdHairlineTagField( label: String, @@ -42,24 +44,21 @@ fun HdHairlineTagField( testTag: String? = null, onDraftChange: (String) -> Unit = {}, ) { - // Saveable so a configuration change can't drop a tag that was typed but not yet committed. - var draft by rememberSaveable { mutableStateOf("") } + var draft by remember { mutableStateOf("") } val updateDraft: (String) -> Unit = { draft = it onDraftChange(it) } - // Parsed with the same rule that persistence uses, so a chip is never shown for input - // that would be dropped on save. val addTag: (String) -> Unit = { raw -> - val candidates = parseTagInput(raw).filter { it !in tags } - if (candidates.isNotEmpty()) { - onTagsChange(tags + candidates) + val candidate = raw.trim().removePrefix("#") + if (candidate.isNotEmpty() && !tags.contains(candidate)) { + onTagsChange(tags + candidate) } updateDraft("") } val addCurrent: () -> Boolean = add@{ - if (parseTagInput(draft).isEmpty()) return@add false + if (draft.trim().removePrefix("#").isEmpty()) return@add false addTag(draft) true } @@ -69,56 +68,117 @@ fun HdHairlineTagField( true } - val suggestions = rememberTagSuggestions(draft, tags, suggestTags) + val suggestions = remember(draft, tags, suggestTags) { + val prefix = draft.trim().removePrefix("#") + if (prefix.isEmpty()) emptyList() + else suggestTags(prefix).filter { it !in tags } + } + + val onSurface = MaterialTheme.colorScheme.onSurface + val muted = MaterialTheme.colorScheme.onSurfaceVariant + val textStyle = MaterialTheme.typography.bodyMedium.copy(color = onSurface) // Collapse the whole field while the body editor is being typed into; keep it visible while it // holds focus itself so tapping it (which raises the keyboard) doesn't make it vanish. var tagsFocused by remember { mutableStateOf(false) } CollapseWhileTyping(modifier = modifier, keepVisible = tagsFocused) { - HdHairlineChipInput( - label = label, - chips = tags, - draft = draft, - onInput = { next -> - val last = next.lastOrNull() - if (last != null && last.isTagSeparator()) { - updateDraft(next.dropLast(1)) - addCurrent() - } else { - updateDraft(next) + Column(modifier = Modifier.fillMaxWidth()) { + Row( + modifier = Modifier.fillMaxWidth(), + verticalAlignment = Alignment.Bottom, + horizontalArrangement = Arrangement.spacedBy(10.dp), + ) { + HdMonoLabel(text = label) + if (hint != null) { + HdMonoLabel( + text = hint, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) } - }, - onCommitDraft = addCurrent, - onRemoveLast = removeLast, - onRemoveChip = { onTagsChange(tags - it) }, - hint = hint, - placeholder = placeholder, - testTag = testTag, - onFocusChanged = { tagsFocused = it }, - footer = { - HdTagSuggestionStrip( - suggestions = suggestions, - onSelect = { addTag(replaceTagPrefix(draft, it)) }, - modifier = Modifier.padding(top = 6.dp), - ) - }, - ) - } -} + } -/** - * Suggestions for the tag being typed at the end of [draft], minus the ones in [applied]. Pair the - * strip's `onSelect` with [replaceTagPrefix] so picking one keeps the tags typed before it. - */ -@Composable -fun rememberTagSuggestions( - draft: String, - applied: Collection, - suggestTags: (prefix: String) -> List, -): List = remember(draft, applied, suggestTags) { - val prefix = tagPrefixOf(draft) - if (prefix.isEmpty()) emptyList() - else suggestTags(prefix).filter { it !in applied } + // One scrollable line — chips + input share a fixed container so focus survives + // the keyboard opening, and tags never wrap to extra rows that eat editor space. + Row( + modifier = Modifier + .fillMaxWidth() + .heightIn(min = 38.dp) + .horizontalScroll(rememberScrollState()) + .padding(top = 6.dp, bottom = 6.dp), + horizontalArrangement = Arrangement.spacedBy(6.dp), + verticalAlignment = Alignment.CenterVertically, + ) { + tags.forEach { tag -> + HdTagChip( + label = tag, + active = true, + onRemove = { onTagsChange(tags - tag) }, + ) + } + Box( + modifier = Modifier + .width(200.dp) + .heightIn(min = 24.dp) + .padding(vertical = 2.dp), + contentAlignment = Alignment.CenterStart, + ) { + BasicTextField( + value = draft, + onValueChange = { next -> + val last = next.lastOrNull() + if (last == ',' || last == ' ') { + updateDraft(next.dropLast(1)) + addCurrent() + } else { + updateDraft(next) + } + }, + singleLine = true, + textStyle = textStyle, + cursorBrush = SolidColor(onSurface), + keyboardOptions = KeyboardOptions(imeAction = ImeAction.Done), + modifier = Modifier + .fillMaxWidth() + .heightIn(min = 24.dp) + .onFocusChanged { focusState -> + tagsFocused = focusState.isFocused + // A typed-but-uncommitted tag would otherwise be silently + // dropped when focus moves on — commit it instead. + if (!focusState.isFocused && draft.isNotBlank()) { + addCurrent() + } + } + .then(if (testTag != null) Modifier.testTag(testTag) else Modifier) + .onPreviewKeyEvent { event -> + if (event.type != KeyEventType.KeyDown) return@onPreviewKeyEvent false + when (event.key) { + Key.Enter, Key.NumPadEnter -> addCurrent() + Key.Backspace -> removeLast() + else -> false + } + }, + ) + if (draft.isEmpty() && tags.isEmpty() && placeholder != null) { + Text( + text = placeholder, + style = textStyle.copy(color = muted), + ) + } + } + } + + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + + HdTagSuggestionStrip( + suggestions = suggestions, + onSelect = { addTag(it) }, + modifier = Modifier.padding(top = 6.dp), + ) + } + } } @OptIn(ExperimentalLayoutApi::class) @@ -135,13 +195,10 @@ fun HdTagSuggestionStrip( verticalArrangement = Arrangement.spacedBy(6.dp), ) { suggestions.forEach { tag -> - // A focusable chip takes focus on press, which commits the raw draft as a tag and - // removes the strip before the release ever reaches onSelect. HdTagChip( label = tag, active = false, onClick = { onSelect(tag) }, - modifier = Modifier.focusProperties { canFocus = false }, ) } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineToggleRow.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineToggleRow.kt index 9d99f1fa7..67e14b985 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineToggleRow.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineToggleRow.kt @@ -10,7 +10,6 @@ import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.alpha import com.darkrockstudios.apps.hammer.common.compose.Ui /** @@ -25,13 +24,11 @@ fun HdHairlineToggleRow( label: String, modifier: Modifier = Modifier, hint: String? = null, - enabled: Boolean = true, ) { Row( modifier = modifier .fillMaxWidth() - .alpha(if (enabled) 1f else 0.45f) - .clickable(enabled = enabled) { onCheckedChange(!checked) }, + .clickable { onCheckedChange(!checked) }, verticalAlignment = Alignment.CenterVertically, horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), ) { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineWordListField.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineWordListField.kt deleted file mode 100644 index aa795391e..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdHairlineWordListField.kt +++ /dev/null @@ -1,101 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import com.darkrockstudios.apps.hammer.common.data.tagindex.isTagSeparator - -/** - * Word list field: the tag field's shape for a plain list of single words, such as the - * project dictionary. Neutral chips wrap onto further rows; a separator (space, comma, or - * their fullwidth forms), Enter, or focus loss commits the draft, and Backspace on an empty - * draft removes the last chip. [parseInput] is the same rule persistence applies, so a chip - * is never shown for input that would be dropped on save; input it rejects stays in the - * draft where the user can see it. Duplicates are matched ignoring case. - * - * PROJECT DICTIONARY to add - * [# Kvothe x] [# Denna x] [# Tarbean x] - * [# Imre x] Ademre - * ---------------------------------------------- - */ -@Composable -fun HdHairlineWordListField( - label: String, - words: List, - onAdd: (String) -> Unit, - onRemove: (String) -> Unit, - parseInput: (String) -> String?, - modifier: Modifier = Modifier, - hint: String? = null, - placeholder: String? = null, - testTag: String? = null, -) { - // Saveable so a configuration change can't drop a word that was typed but not yet committed. - var draft by rememberSaveable { mutableStateOf("") } - - /** Commits what the parser accepts and returns the tokens it rejected. */ - fun commitAll(tokens: List): List = tokens.filterNot { token -> - val word = parseInput(token) ?: return@filterNot false - if (words.none { it.equals(word, ignoreCase = true) }) onAdd(word) - true - } - - val onInput: (String) -> Unit = { next -> - if (next.any { it.isTagSeparator() }) { - // A separator anywhere commits the complete words before it, so a pasted - // list is not stranded as one draft the parser rejects. - val tokens = splitOnSeparators(next) - val endsWithSeparator = next.last().isTagSeparator() - val complete = if (endsWithSeparator) tokens else tokens.dropLast(1) - val partial = if (endsWithSeparator) emptyList() else tokens.takeLast(1) - draft = (commitAll(complete) + partial).joinToString(" ") - } else { - draft = next - } - } - val commitDraft: () -> Boolean = commit@{ - val tokens = splitOnSeparators(draft) - val rejected = commitAll(tokens) - draft = rejected.joinToString(" ") - rejected.size < tokens.size - } - val removeLast: () -> Boolean = remove@{ - if (draft.isNotEmpty() || words.isEmpty()) return@remove false - onRemove(words.last()) - true - } - - HdHairlineChipInput( - label = label, - chips = words, - draft = draft, - onInput = onInput, - onCommitDraft = commitDraft, - onRemoveLast = removeLast, - onRemoveChip = onRemove, - modifier = modifier, - hint = hint, - placeholder = placeholder, - wrapChips = true, - accentChips = false, - testTag = testTag, - ) -} - -private fun splitOnSeparators(text: String): List { - val tokens = mutableListOf() - val current = StringBuilder() - for (c in text) { - if (c.isTagSeparator()) { - if (current.isNotEmpty()) tokens += current.toString() - current.clear() - } else { - current.append(c) - } - } - if (current.isNotEmpty()) tokens += current.toString() - return tokens -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdIndentRails.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdIndentRails.kt deleted file mode 100644 index 6c3bf19ec..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdIndentRails.kt +++ /dev/null @@ -1,53 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.drawBehind -import androidx.compose.ui.geometry.Offset -import androidx.compose.ui.graphics.Color -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -/** One nesting level in a tree row: the width of a disclosure column. */ -val HdIndentStep: Dp = 16.dp - -/** - * Start of a row's own content at [depth], counting the outer gutter. - * Depth 1 is a top level row. - */ -fun hdIndentFor(depth: Int, gutter: Dp = HdIndentStep, step: Dp = HdIndentStep): Dp = - gutter + step * (depth - 1).coerceAtLeast(0) - -/** - * Vertical hairline rails, one per ancestor level, descending through a nested row. - * Each rail is centered on the disclosure column of the ancestor that owns it, so a - * child row reads as hanging off its parent's chevron. - * - * ``` - * ⌄ Chapter I - * ┆ ⌄ Scene Group - * ┆ ┆ Scene name - * ``` - * - * [levels] is the number of ancestors above this row: `depth - 1`. - */ -fun Modifier.hdIndentRails( - levels: Int, - color: Color, - gutter: Dp = HdIndentStep, - step: Dp = HdIndentStep, -): Modifier { - if (levels <= 0) return this - return drawBehind { - val stepPx = step.toPx() - val centerOffset = gutter.toPx() + (stepPx / 2f) - repeat(levels) { level -> - val x = centerOffset + (stepPx * level) - drawLine( - color = color, - start = Offset(x, 0f), - end = Offset(x, size.height), - strokeWidth = Dp.Hairline.toPx(), - ) - } - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdNoticeStrip.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdNoticeStrip.kt deleted file mode 100644 index 132f3d33a..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdNoticeStrip.kt +++ /dev/null @@ -1,90 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -/** - * A full-width notice pinned above a list: a title line, an optional detail line, an optional - * hairline progress bar, and up to two hairline actions. Hairline rules top and bottom over a - * `surfaceContainerLow` fill separate it from the page without elevation. - */ -@Composable -fun HdNoticeStrip( - title: String, - modifier: Modifier = Modifier, - detail: String? = null, - progress: Float? = null, - primaryLabel: String? = null, - onPrimary: () -> Unit = {}, - secondaryLabel: String? = null, - onSecondary: () -> Unit = {}, - actionsEnabled: Boolean = true, -) { - val rule = MaterialTheme.colorScheme.outlineVariant - Column( - modifier = modifier - .fillMaxWidth() - .background(MaterialTheme.colorScheme.surfaceContainerLow), - ) { - HorizontalDivider(thickness = Dp.Hairline, color = rule) - Row( - modifier = Modifier - .fillMaxWidth() - .padding(horizontal = 20.dp, vertical = 12.dp), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(12.dp), - ) { - Column( - modifier = Modifier.weight(1f), - verticalArrangement = Arrangement.spacedBy(4.dp), - ) { - Text( - text = title, - style = MaterialTheme.typography.bodyLarge, - color = MaterialTheme.colorScheme.onSurface, - ) - if (detail != null) { - Text( - text = detail, - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - if (progress != null) { - HdHairlineProgressBar( - progress = progress, - modifier = Modifier.padding(top = 4.dp), - ) - } - } - if (secondaryLabel != null) { - HdHairlineButton( - label = secondaryLabel, - onClick = onSecondary, - enabled = actionsEnabled, - ) - } - if (primaryLabel != null) { - HdHairlineButton( - label = primaryLabel, - onClick = onPrimary, - emphasised = true, - enabled = actionsEnabled, - ) - } - } - HorizontalDivider(thickness = Dp.Hairline, color = rule) - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdPickerList.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdPickerList.kt deleted file mode 100644 index 08c84df38..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdPickerList.kt +++ /dev/null @@ -1,132 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.border -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.RowScope -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.heightIn -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.size -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.LazyListScope -import androidx.compose.foundation.lazy.rememberLazyListState -import androidx.compose.material3.Icon -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.graphics.vector.ImageVector -import androidx.compose.ui.platform.LocalDensity -import androidx.compose.ui.text.style.TextOverflow -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.isSpecified -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay - -/** Rows deeper than this share the same indent so long names keep room. */ -private const val MAX_INDENT_DEPTH = 4 - -/** - * Hairline-bordered list for picking from an indented tree inside a dialog. - * The visible height is capped at [maxVisibleRows] rows derived from the text - * size, so the row count holds steady across font scales; overflow scrolls. - */ -@Composable -fun HdPickerList( - modifier: Modifier = Modifier, - maxVisibleRows: Int = 6, - emptyText: String? = null, - content: LazyListScope.() -> Unit, -) { - Column( - modifier = modifier - .fillMaxWidth() - .border( - width = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - shape = RectangleShape, - ), - ) { - if (emptyText != null) { - Text( - text = emptyText, - style = MaterialTheme.typography.bodyMedium, - color = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier.padding(Ui.Padding.XL), - ) - } else { - val lineHeight = MaterialTheme.typography.bodyMedium.lineHeight - val rowHeight = with(LocalDensity.current) { - (if (lineHeight.isSpecified) lineHeight.toDp() else 20.dp) + (Ui.Padding.M * 2) - } - val listState = rememberLazyListState() - Box { - LazyColumn( - state = listState, - modifier = Modifier - .heightIn(max = rowHeight * maxVisibleRows) - .padding(end = Ui.Padding.S), - content = content, - ) - MpScrollBarList( - modifier = scrollBarOverlay(), - state = listState, - ) - } - } - } -} - -/** - * One row of an [HdPickerList]: depth-based indent, optional leading icon, - * ellipsized label, and a trailing slot (count label, checkbox, ...). - * Interaction (clickable/toggleable), selection background, and test tags are - * the caller's, passed through [modifier]. - */ -@Composable -fun HdPickerRow( - label: String, - modifier: Modifier = Modifier, - depth: Int = 0, - icon: ImageVector? = null, - trailing: @Composable RowScope.() -> Unit = {}, -) { - Row( - modifier = Modifier - .fillMaxWidth() - .then(modifier) - .padding( - start = Ui.Padding.L + (Ui.Padding.XL * depth.coerceAtMost(MAX_INDENT_DEPTH)), - end = Ui.Padding.L, - top = Ui.Padding.M, - bottom = Ui.Padding.M, - ), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), - ) { - if (icon != null) { - Icon( - imageVector = icon, - contentDescription = null, - tint = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier.size(16.dp), - ) - } - Text( - text = label, - style = MaterialTheme.typography.bodyMedium, - color = MaterialTheme.colorScheme.onSurface, - maxLines = 1, - overflow = TextOverflow.Ellipsis, - modifier = Modifier.weight(1f), - ) - trailing() - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdResizeHandle.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdResizeHandle.kt deleted file mode 100644 index f781422b4..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdResizeHandle.kt +++ /dev/null @@ -1,182 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.animation.core.animateFloatAsState -import androidx.compose.foundation.gestures.Orientation -import androidx.compose.foundation.gestures.detectTapGestures -import androidx.compose.foundation.gestures.draggable -import androidx.compose.foundation.gestures.rememberDraggableState -import androidx.compose.foundation.hoverable -import androidx.compose.foundation.interaction.MutableInteractionSource -import androidx.compose.foundation.interaction.collectIsDraggedAsState -import androidx.compose.foundation.interaction.collectIsHoveredAsState -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxHeight -import androidx.compose.foundation.layout.requiredWidth -import androidx.compose.foundation.layout.width -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.Stable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.graphicsLayer -import androidx.compose.ui.input.pointer.PointerIcon -import androidx.compose.ui.input.pointer.pointerHoverIcon -import androidx.compose.ui.input.pointer.pointerInput -import androidx.compose.ui.platform.LocalDensity -import androidx.compose.ui.platform.LocalLayoutDirection -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.LayoutDirection -import androidx.compose.ui.unit.dp - -const val HD_RESIZE_HANDLE_TAG = "hd-resize-handle" - -val RESIZE_HANDLE_WIDTH = 16.dp - -/** Minimum horizontal slack beyond the column's minimum width before a resize handle is worth showing. */ -val RESIZE_HANDLE_MIN_SLACK = 48.dp - -private val RESIZE_HANDLE_TOUCH_WIDTH = 48.dp -private const val RESIZE_HANDLE_REST_ALPHA = 0.3f - -/** - * Drag state for a centered column resized by [HdResizeHandle]. Holds the in-flight - * width locally during a drag and fires [onCommit] once on drag end, so callers can - * persist without per-frame writes. - */ -@Stable -class HdResizeHandleState internal constructor() { - internal var clampWidth: (Float) -> Float = { it } - internal var onCommit: (Float) -> Unit = {} - internal var onReset: () -> Unit = {} - internal var persistedWidth by mutableStateOf(0f) - internal var availableWidth by mutableStateOf(0.dp) - - private var dragWidth by mutableStateOf(null) - private var dragging = false - - /** Live column max width in dp: the in-flight drag value, else the persisted one. */ - val width: Dp get() = (dragWidth ?: persistedWidth).dp - - /** - * True when the window is wide enough for resizing to be meaningful. Keyed off the - * column's minimum width, never its current one, so the handle (and its reset) stays - * reachable even when the persisted width exceeds the window, and never un-composes - * mid-drag (which would drop the draggable's onDragStopped and lose the commit). - */ - val showHandle: Boolean get() = availableWidth >= clampWidth(0f).dp + RESIZE_HANDLE_MIN_SLACK - - fun onOutwardDrag(delta: Dp) { - dragging = true - val target = (dragWidth ?: persistedWidth) + 2 * delta.value - dragWidth = clampWidth(target).coerceAtMost(availableWidth.value) - } - - fun onDragEnd() { - dragging = false - dragWidth?.let { onCommit(it) } - } - - fun reset() { - dragWidth = null - onReset() - } - - internal fun clearDragUnlessActive() { - if (!dragging) dragWidth = null - } -} - -@Composable -fun rememberHdResizeHandleState( - persistedWidth: Float, - availableWidth: Dp, - clampWidth: (Float) -> Float, - onCommit: (Float) -> Unit, - onReset: () -> Unit, -): HdResizeHandleState { - val state = remember { HdResizeHandleState() } - state.clampWidth = clampWidth - state.onCommit = onCommit - state.onReset = onReset - state.persistedWidth = persistedWidth - state.availableWidth = availableWidth - // The persisted value catching up to a committed drag releases the local override; - // skipped while a drag is active so a late settings echo can't snap the column mid-gesture. - LaunchedEffect(persistedWidth) { state.clearDragUnlessActive() } - return state -} - -/** - * A full-height gutter on the start edge of a centered, width-capped column - * that lets the user drag the column wider or narrower. The grip glyph sits - * subdued until hovered or dragged; the pointer becomes a horizontal-resize - * cursor on desktop. Double-click resets. The hit strip is wider than the - * visual gutter so touch drags can land. - * - * ``` - * ┆▪ ▪┆ ┌────────────────────┐ - * ┆▪ ▪┆ │ centered column │ - * ┆▪ ▪┆ └────────────────────┘ - * ``` - * - * [onOutwardDrag] reports deltas as outward-positive (away from the column's - * center) regardless of layout direction, so callers stay RTL-safe. A centered - * column grows by twice the outward delta. Pair with [rememberHdResizeHandleState], - * which owns that math plus commit-on-drag-end. - */ -@Composable -fun HdResizeHandle( - onOutwardDrag: (Dp) -> Unit, - onDragEnd: () -> Unit, - onReset: () -> Unit, - modifier: Modifier = Modifier, -) { - val density = LocalDensity.current - val layoutDirection = LocalLayoutDirection.current - val interactionSource = remember { MutableInteractionSource() } - val hovered by interactionSource.collectIsHoveredAsState() - val dragged by interactionSource.collectIsDraggedAsState() - val glyphAlpha = animateFloatAsState( - if (hovered || dragged) 1f else RESIZE_HANDLE_REST_ALPHA - ) - val resizeCursor = remember { horizontalResizePointerIcon() } - - Box( - modifier = modifier - .fillMaxHeight() - .width(RESIZE_HANDLE_WIDTH), - contentAlignment = Alignment.Center, - ) { - // requiredWidth overflows the 16dp layout slot without shifting the column. - Box( - modifier = Modifier - .requiredWidth(RESIZE_HANDLE_TOUCH_WIDTH) - .fillMaxHeight() - .testTag(HD_RESIZE_HANDLE_TAG) - .hoverable(interactionSource) - .pointerHoverIcon(resizeCursor) - .draggable( - orientation = Orientation.Horizontal, - state = rememberDraggableState { deltaPx -> - val outwardPx = if (layoutDirection == LayoutDirection.Ltr) -deltaPx else deltaPx - onOutwardDrag(with(density) { outwardPx.toDp() }) - }, - interactionSource = interactionSource, - onDragStopped = { onDragEnd() }, - ) - .pointerInput(onReset) { - detectTapGestures(onDoubleTap = { onReset() }) - }, - contentAlignment = Alignment.Center, - ) { - HdDragHandle(modifier = Modifier.graphicsLayer { alpha = glyphAlpha.value }) - } - } -} - -expect fun horizontalResizePointerIcon(): PointerIcon diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdScrollAwayFooter.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdScrollAwayFooter.kt deleted file mode 100644 index 9ce1b0bb9..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdScrollAwayFooter.kt +++ /dev/null @@ -1,135 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.animation.AnimatedVisibility -import androidx.compose.animation.fadeIn -import androidx.compose.animation.fadeOut -import androidx.compose.animation.slideInVertically -import androidx.compose.animation.slideOutVertically -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.BoxScope -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.PaddingValues -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.RowScope -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.runtime.Stable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.geometry.Offset -import androidx.compose.ui.graphics.Color -import androidx.compose.ui.input.nestedscroll.NestedScrollConnection -import androidx.compose.ui.input.nestedscroll.NestedScrollSource -import androidx.compose.ui.layout.onSizeChanged -import androidx.compose.ui.platform.LocalDensity -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.Ui - -/** - * Tracks the scroll-away state of a [HdScrollAwayFooter]: wire - * [nestedScrollConnection] to the scrolling content and feed [height] into - * that content's bottom `contentPadding` so its last row can clear the strip. - */ -@Stable -class HdScrollAwayFooterState internal constructor() { - var isHiddenByScroll by mutableStateOf(false) - private set - - /** - * Measured height of the footer strip. Retained while the footer is - * hidden, so the list's bottom padding never changes. - */ - var height by mutableStateOf(0.dp) - internal set - - /** - * Reacts to raw scroll direction, not accumulated distance. Any - * distance threshold has to survive the jitter in a real drag, and - * the reveal has to feel immediate, so direction wins here. - */ - val nestedScrollConnection: NestedScrollConnection = object : NestedScrollConnection { - override fun onPreScroll(available: Offset, source: NestedScrollSource): Offset { - if (available.y < -1f) isHiddenByScroll = true - else if (available.y > 1f) isHiddenByScroll = false - return Offset.Zero - } - } -} - -@Composable -fun rememberHdScrollAwayFooterState(): HdScrollAwayFooterState = remember { HdScrollAwayFooterState() } - -/** - * Hairline action strip that floats over the bottom of a scrolling pane and - * slides away as the reader scrolls down. - * - * ┌───────────────────────┐ - * │ list row │ - * │ list row │ - * ├───────────────────────┤ - * │ [ ACTION ] + │ - * └───────────────────────┘ - * - * The strip is an **overlay**, never a sibling in a `Column`: hiding it must - * not resize the list. A footer that takes layout space changes what the list - * can scroll, which flips any visibility rule keyed off scroll position and - * flickers the strip on and off. - * - * Host it in the same `Box` as the scrolling content, and pass - * [HdScrollAwayFooterState.height] as that content's bottom `contentPadding`. - * The host `Box` should `clipToBounds()` so the strip disappears at the pane - * edge as it slides out. - * - * [visible] defaults to the scroll-away rule; widen it to pin the strip open - * (e.g. `!listState.canScrollForward || !state.isHiddenByScroll` keeps it - * reachable once the list bottoms out). - */ -@Composable -fun BoxScope.HdScrollAwayFooter( - state: HdScrollAwayFooterState, - modifier: Modifier = Modifier, - visible: Boolean = !state.isHiddenByScroll, - containerColor: Color = MaterialTheme.colorScheme.surface, - dividerColor: Color = MaterialTheme.colorScheme.outlineVariant, - contentPadding: PaddingValues = PaddingValues(Ui.Padding.M), - content: @Composable RowScope.() -> Unit, -) { - val density = LocalDensity.current - AnimatedVisibility( - visible = visible, - modifier = modifier.align(Alignment.BottomCenter), - enter = slideInVertically(initialOffsetY = { it }) + fadeIn(), - exit = slideOutVertically(targetOffsetY = { it }) + fadeOut(), - ) { - Column( - modifier = Modifier - .fillMaxWidth() - .background(containerColor) - .onSizeChanged { size -> - if (size.height > 0) { - state.height = with(density) { size.height.toDp() } - } - }, - ) { - HorizontalDivider( - thickness = Dp.Hairline, - color = dividerColor, - ) - Row( - modifier = Modifier.fillMaxWidth().padding(contentPadding), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), - content = content, - ) - } - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdSearchableListDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdSearchableListDialog.kt deleted file mode 100644 index 95f74182f..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdSearchableListDialog.kt +++ /dev/null @@ -1,225 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.heightIn -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.items -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.AnimatedDialog -import com.darkrockstudios.apps.hammer.common.compose.SpacerL -import com.darkrockstudios.apps.hammer.common.compose.Ui - -/** - * Hairline dialog for picking one item from a long list, narrowed by a search field. - * Use it when a [HdHairlineDropdown] would be unwieldy (dozens to hundreds of options, - * e.g. every locale the platform knows). - * - * ┌───────────────────────────────────────────┐ - * │ Choose a language × │ - * │ ┌───────────────────────────────────────┐ │ - * │ │ ⌕ search │ │ - * │ └───────────────────────────────────────┘ │ - * │ Clear selection │ - * │ ──────────────────────────────────────────│ - * │ English (United States) EN-US │ - * │ ──────────────────────────────────────────│ - * │ Français (France) FR-FR │ - * └───────────────────────────────────────────┘ - * - * The search matches [itemLabel] and [itemTrailing] case-insensitively. [itemTrailing] - * renders as a mono greeble on the right; anchor it to a real value (a locale code, - * a count), never decoration. [onClear], when provided, shows a muted row above the - * list that clears the current selection. Selection and clear both dismiss. - */ -@Composable -fun HdSearchableListDialog( - visible: Boolean, - title: String, - items: List, - itemLabel: (T) -> String, - onSelect: (T) -> Unit, - onDismiss: () -> Unit, - closeContentDescription: String, - searchPlaceholder: String = "", - itemTrailing: ((T) -> String)? = null, - itemKey: ((T) -> Any)? = null, - clearLabel: String? = null, - onClear: (() -> Unit)? = null, - emptyLabel: String = "", -) { - var query by rememberSaveable { mutableStateOf("") } - - AnimatedDialog( - visible = visible, - onCloseRequest = onDismiss, - dismissOnTapOutside = true, - onDismissed = { query = "" }, - ) { - HdSearchableListDialogContent( - title = title, - query = query, - onQueryChange = { query = it }, - items = items, - itemLabel = itemLabel, - onSelect = onSelect, - onDismissRequest = { requestDismiss() }, - closeContentDescription = closeContentDescription, - searchPlaceholder = searchPlaceholder, - itemTrailing = itemTrailing, - itemKey = itemKey, - clearLabel = clearLabel, - onClear = onClear, - emptyLabel = emptyLabel, - ) - } -} - -/** The dialog body without the [AnimatedDialog] host, so previews can render it directly. */ -@Composable -internal fun HdSearchableListDialogContent( - title: String, - query: String, - onQueryChange: (String) -> Unit, - items: List, - itemLabel: (T) -> String, - onSelect: (T) -> Unit, - onDismissRequest: () -> Unit, - closeContentDescription: String, - searchPlaceholder: String = "", - itemTrailing: ((T) -> String)? = null, - itemKey: ((T) -> Any)? = null, - clearLabel: String? = null, - onClear: (() -> Unit)? = null, - emptyLabel: String = "", -) { - val filtered = remember(items, query) { - if (query.isBlank()) items - else items.filter { - itemLabel(it).contains(query, ignoreCase = true) || - itemTrailing?.invoke(it)?.contains(query, ignoreCase = true) == true - } - } - - HdHairlineDialogShell( - title = title, - onClose = onDismissRequest, - closeContentDescription = closeContentDescription, - ) { - HdSearchField( - value = query, - onValueChange = onQueryChange, - placeholder = searchPlaceholder, - onClear = { onQueryChange("") }, - modifier = Modifier.fillMaxWidth(), - ) - - SpacerL() - - // Pinned above the scrolling list so it stays reachable even when the - // search matches nothing. - if (clearLabel != null && onClear != null) { - PickerRow( - label = clearLabel, - trailing = null, - muted = true, - onClick = { - onClear() - onDismissRequest() - }, - ) - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - } - - Box( - modifier = Modifier - .fillMaxWidth() - .heightIn(min = 120.dp, max = 360.dp), - ) { - if (filtered.isEmpty()) { - Box( - modifier = Modifier - .fillMaxWidth() - .padding(vertical = Ui.Padding.XL), - contentAlignment = Alignment.Center, - ) { - Text( - text = emptyLabel, - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - } else { - LazyColumn(modifier = Modifier.fillMaxWidth()) { - items(filtered, key = itemKey) { item -> - PickerRow( - label = itemLabel(item), - trailing = itemTrailing?.invoke(item), - muted = false, - onClick = { - onSelect(item) - onDismissRequest() - }, - ) - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - } - } - } - } - } -} - -@Composable -private fun PickerRow( - label: String, - trailing: String?, - muted: Boolean, - onClick: () -> Unit, -) { - Row( - modifier = Modifier - .fillMaxWidth() - .clickable(onClick = onClick) - .padding(horizontal = Ui.Padding.M, vertical = Ui.Padding.L), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.SpaceBetween, - ) { - Text( - text = label, - style = MaterialTheme.typography.bodyMedium, - color = if (muted) { - MaterialTheme.colorScheme.onSurfaceVariant - } else { - MaterialTheme.colorScheme.onSurface - }, - ) - if (trailing != null) { - HdMonoLabel( - text = trailing, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdWarningNotice.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdWarningNotice.kt deleted file mode 100644 index 2625ee5fc..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HdWarningNotice.kt +++ /dev/null @@ -1,59 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.foundation.border -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors - -/** - * Amber hairline callout: mono [label] over a body [message]. - * - * ``` - * ┌──────────────────────────────┐ - * │ [!] LABEL │ - * │ Message body. │ - * └──────────────────────────────┘ - * ``` - * - * Non-blocking, unlike an error: the action it warns about stays available. - */ -@Composable -fun HdWarningNotice( - label: String, - message: String, - modifier: Modifier = Modifier, -) { - val amber = LocalHammerColors.current.warning - Row( - modifier = modifier - .fillMaxWidth() - .border(width = Dp.Hairline, color = amber, shape = RectangleShape) - .padding(horizontal = 10.dp, vertical = 8.dp), - horizontalArrangement = Arrangement.spacedBy(10.dp), - verticalAlignment = Alignment.Top, - ) { - HdWarnGlyph(size = 16.dp) - Column( - modifier = Modifier.weight(1f), - verticalArrangement = Arrangement.spacedBy(4.dp), - ) { - HdMonoLabel(text = label, color = amber) - Text( - text = message, - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurface, - ) - } - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/FontControlUtils.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/FontControlUtils.kt new file mode 100644 index 000000000..bd6cc7a05 --- /dev/null +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/FontControlUtils.kt @@ -0,0 +1,114 @@ +package com.darkrockstudios.apps.hammer.common.compose.markdown + +import androidx.compose.ui.text.SpanStyle +import androidx.compose.ui.unit.sp +import com.darkrockstudios.texteditor.markdown.MarkdownConfiguration +import io.github.aakira.napier.Napier + +internal fun MarkdownConfiguration.changeFontSize( + newBaseFontSize: Float +): MarkdownConfiguration { + // Determine the baseline font size to adjust from + val baselineFontSize = defaultTextStyle.fontSize.value + if (baselineFontSize == newBaseFontSize) return this + + Napier.d("Font size OLD: $baselineFontSize NEW: $newBaseFontSize") + + val scaleFactor = newBaseFontSize / baselineFontSize + + // Create a new configuration with scaled font sizes + // The key is to handle each property individually without relying on the copy method's handling of colors + return MarkdownConfiguration( + defaultTextStyle = defaultTextStyle.copy( + fontSize = newBaseFontSize.sp + ), + boldStyle = SpanStyle( + fontSize = newBaseFontSize.sp, + fontWeight = boldStyle.fontWeight, + color = boldStyle.color, + fontFamily = boldStyle.fontFamily, + fontStyle = boldStyle.fontStyle, + background = boldStyle.background + ), + italicStyle = SpanStyle( + fontSize = newBaseFontSize.sp, + fontWeight = italicStyle.fontWeight, + color = italicStyle.color, + fontFamily = italicStyle.fontFamily, + fontStyle = italicStyle.fontStyle, + background = italicStyle.background + ), + codeStyle = SpanStyle( + fontSize = newBaseFontSize.sp, + fontWeight = codeStyle.fontWeight, + color = codeStyle.color, + fontFamily = codeStyle.fontFamily, + fontStyle = codeStyle.fontStyle, + background = codeStyle.background + ), + linkStyle = SpanStyle( + fontSize = newBaseFontSize.sp, + fontWeight = linkStyle.fontWeight, + color = linkStyle.color, + fontFamily = linkStyle.fontFamily, + fontStyle = linkStyle.fontStyle, + background = linkStyle.background + ), + blockquoteStyle = SpanStyle( + fontSize = newBaseFontSize.sp, + fontWeight = blockquoteStyle.fontWeight, + color = blockquoteStyle.color, + fontFamily = blockquoteStyle.fontFamily, + fontStyle = blockquoteStyle.fontStyle, + background = blockquoteStyle.background + ), + header1Style = SpanStyle( + fontSize = (header1Style.fontSize.value * scaleFactor).sp, + fontWeight = header1Style.fontWeight, + color = header1Style.color, + fontFamily = header1Style.fontFamily, + fontStyle = header1Style.fontStyle, + background = header1Style.background + ), + header2Style = SpanStyle( + fontSize = (header2Style.fontSize.value * scaleFactor).sp, + fontWeight = header2Style.fontWeight, + color = header2Style.color, + fontFamily = header2Style.fontFamily, + fontStyle = header2Style.fontStyle, + background = header2Style.background + ), + header3Style = SpanStyle( + fontSize = (header3Style.fontSize.value * scaleFactor).sp, + fontWeight = header3Style.fontWeight, + color = header3Style.color, + fontFamily = header3Style.fontFamily, + fontStyle = header3Style.fontStyle, + background = header3Style.background + ), + header4Style = SpanStyle( + fontSize = (header4Style.fontSize.value * scaleFactor).sp, + fontWeight = header4Style.fontWeight, + color = header4Style.color, + fontFamily = header4Style.fontFamily, + fontStyle = header4Style.fontStyle, + background = header4Style.background + ), + header5Style = SpanStyle( + fontSize = (header5Style.fontSize.value * scaleFactor).sp, + fontWeight = header5Style.fontWeight, + color = header5Style.color, + fontFamily = header5Style.fontFamily, + fontStyle = header5Style.fontStyle, + background = header5Style.background + ), + header6Style = SpanStyle( + fontSize = (header6Style.fontSize.value * scaleFactor).sp, + fontWeight = header6Style.fontWeight, + color = header6Style.color, + fontFamily = header6Style.fontFamily, + fontStyle = header6Style.fontStyle, + background = header6Style.background + ) + ) +} \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/HammerMarkdownConfiguration.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/HammerMarkdownConfiguration.kt deleted file mode 100644 index 94bdae95e..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/HammerMarkdownConfiguration.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.markdown - -import com.darkrockstudios.texteditor.markdown.MarkdownConfiguration -import com.darkrockstudios.texteditor.markdown.ParagraphSeparator - -/** - * One editor line per markdown line. The library default, BLANK_LINE, drops the blank lines - * between paragraphs on import and rewrites single-newline paragraphs on export. - */ -val HammerMarkdownConfiguration = MarkdownConfiguration(paragraphSeparator = ParagraphSeparator.NEWLINE) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/updateMarkdownStyles.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/updateMarkdownStyles.kt index 421a23490..c7ad168cf 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/updateMarkdownStyles.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdown/updateMarkdownStyles.kt @@ -3,53 +3,53 @@ package com.darkrockstudios.apps.hammer.common.compose.markdown import androidx.compose.ui.text.AnnotatedString import androidx.compose.ui.text.SpanStyle import androidx.compose.ui.text.buildAnnotatedString -import com.darkrockstudios.texteditor.RichTextStyles +import com.darkrockstudios.texteditor.markdown.MarkdownConfiguration +import com.darkrockstudios.texteditor.markdown.MarkdownExtension import com.darkrockstudios.texteditor.state.TextEditorState -internal fun TextEditorState.updateRichTextStyles(newStyles: RichTextStyles) { +internal fun MarkdownExtension.updateMarkdownConfiguration(newConfig: MarkdownConfiguration) { + val oldConfig = markdownConfiguration updateMarkdownStyles( - state = this, - oldConfig = richTextStyles, - newConfig = newStyles + state = editorState, + oldConfig = oldConfig, + newConfig = newConfig ) - richTextStyles = newStyles + markdownConfiguration = newConfig } /** - * Updates all text in the editor to use the new styles. + * Updates all text in the editor to use the new markdown configuration styles. * This preserves the semantic meaning of styles while updating their visual appearance. * * @param state The TextEditorState to update - * @param oldConfig The previous styles that were used - * @param newConfig The new styles to apply + * @param oldConfig The previous configuration that was used + * @param newConfig The new configuration to apply */ internal fun updateMarkdownStyles( state: TextEditorState, - oldConfig: RichTextStyles, - newConfig: RichTextStyles + oldConfig: MarkdownConfiguration, + newConfig: MarkdownConfiguration ) { if (state.textLines.isEmpty()) return - // Heading styles are deliberately absent: TextEditorState.richTextStyles' - // setter rebakes them from their HeaderSpanStyle spans. Remapping them here too - // leaves the rebake unable to find the old style to strip, so it appends a second - // copy to every heading on each config change. val styleMapping = mapOf( oldConfig.defaultTextStyle to newConfig.defaultTextStyle, oldConfig.boldStyle to newConfig.boldStyle, oldConfig.italicStyle to newConfig.italicStyle, oldConfig.codeStyle to newConfig.codeStyle, oldConfig.linkStyle to newConfig.linkStyle, - oldConfig.highlightStyle to newConfig.highlightStyle, oldConfig.blockquoteStyle to newConfig.blockquoteStyle, + oldConfig.header1Style to newConfig.header1Style, + oldConfig.header2Style to newConfig.header2Style, + oldConfig.header3Style to newConfig.header3Style, + oldConfig.header4Style to newConfig.header4Style, + oldConfig.header5Style to newConfig.header5Style, + oldConfig.header6Style to newConfig.header6Style ) state.processLines { _: Int, line: AnnotatedString -> buildAnnotatedString { append(line.text) - // Block lines carry their indent as a ParagraphStyle, which the raw text - // append above drops. - line.paragraphStyles.forEach { addStyle(it.item, it.start, it.end) } if (line.spanStyles.isEmpty()) { addStyle(newConfig.defaultTextStyle, 0, line.length) } else { @@ -59,6 +59,7 @@ internal fun updateMarkdownStyles( addStyle(newStyle, span.start, span.end) } else { // Keep the original style if it's not a markdown style + println("Skipping style update") addStyle(span.item, span.start, span.end) } } @@ -97,8 +98,5 @@ private fun deepCompareSpanStyles(style1: SpanStyle, style2: SpanStyle): Boolean if (style1.baselineShift != style2.baselineShift) return false if (style1.textGeometricTransform != style2.textGeometricTransform) return false if (style1.localeList != style2.localeList) return false - // What tells a heading's look from an inline style it equals (RichTextStyles.headingLook) - if (style1.platformStyle != style2.platformStyle) return false - if (style1.drawStyle != style2.drawStyle) return false return true } \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt index fdf66ba2c..d9a118820 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt @@ -7,7 +7,6 @@ import androidx.compose.ui.graphics.vector.ImageVector internal expect fun EditorAction( icon: ImageVector, active: Boolean, - enabled: Boolean = true, onClick: () -> Unit, ) @@ -15,6 +14,5 @@ internal expect fun EditorAction( internal expect fun EditorTextAction( label: String, active: Boolean, - enabled: Boolean = true, onClick: () -> Unit, ) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorActionColor.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorActionColor.kt deleted file mode 100644 index 62e562a8f..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorActionColor.kt +++ /dev/null @@ -1,13 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.markdowneditor - -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.graphics.Color - -/** An action's tint: Material's disabled content colour, else the active or the resting one. */ -@Composable -internal fun editorActionColor(active: Boolean, enabled: Boolean): Color = when { - !enabled -> MaterialTheme.colorScheme.onSurface.copy(alpha = 0.38f) - active -> MaterialTheme.colorScheme.inversePrimary - else -> MaterialTheme.colorScheme.onSurfaceVariant -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditField.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditField.kt index 9f1a69687..a8cd23c5b 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditField.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditField.kt @@ -11,19 +11,19 @@ import androidx.compose.runtime.getValue import androidx.compose.runtime.remember import androidx.compose.ui.Modifier import androidx.compose.ui.platform.testTag +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.style.TextIndent import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.LocalRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles +import androidx.compose.ui.unit.sp +import com.darkrockstudios.apps.hammer.common.compose.LocalMarkdownConfig +import com.darkrockstudios.apps.hammer.common.compose.markdown.updateMarkdownConfiguration import com.darkrockstudios.apps.hammer.common.compose.rememberKoinInject -import com.darkrockstudios.apps.hammer.common.compose.withParagraphIndent import com.darkrockstudios.apps.hammer.common.spellcheck.SpellCheckRepository import com.darkrockstudios.apps.hammer.common.utils.toEditorSpellChecker -import com.darkrockstudios.texteditor.markdown.withMarkdown import com.darkrockstudios.texteditor.rememberTextEditorStyle import com.darkrockstudios.texteditor.spellcheck.SpellCheckingTextEditor +import com.darkrockstudios.texteditor.spellcheck.markdown.withMarkdown import com.darkrockstudios.texteditor.spellcheck.rememberSpellCheckState /** @@ -46,25 +46,19 @@ fun MarkdownEditField( minEditorHeight: Dp = 200.dp, testTag: String? = null, ) { - val richTextStyles = LocalRichTextStyles.current + val markdownConfig = LocalMarkdownConfig.current val spellCheckRepository = rememberKoinInject() val platformSpellChecker by spellCheckRepository.dictionaryFlow.collectAsState(initial = null) - // rememberSpellCheckState re-scans the whole document whenever this instance changes identity. - val editorSpellChecker = remember(platformSpellChecker) { platformSpellChecker.toEditorSpellChecker() } - val textEditorState = rememberSpellCheckState( - spellChecker = editorSpellChecker, + spellChecker = platformSpellChecker.toEditorSpellChecker(), initialText = null, // The repository only emits a dictionary while spell checking is globally enabled, // so a null checker also means "disabled" — clear decorations rather than keep checking. enableSpellChecking = enableSpellChecking && platformSpellChecker != null, ) - val markdownExtension = remember { - textEditorState.textState.richTextStyles = richTextStyles - textEditorState.textState.withMarkdown(HammerMarkdownConfiguration) - } + val markdownExtension = remember { textEditorState.withMarkdown(markdownConfig) } LaunchedEffect(markdownExtension) { markdownExtension.importMarkdown(initialMarkdown) @@ -75,8 +69,8 @@ fun MarkdownEditField( } } - LaunchedEffect(richTextStyles) { - textEditorState.textState.updateRichTextStyles(richTextStyles) + LaunchedEffect(markdownConfig) { + markdownExtension.updateMarkdownConfiguration(markdownConfig) } Column( @@ -94,7 +88,9 @@ fun MarkdownEditField( enabled = enabled, autoFocus = autoFocus, style = rememberTextEditorStyle( - textStyle = LocalEditorTextStyle.current.withParagraphIndent() + textStyle = TextStyle.Default.copy( + textIndent = TextIndent(firstLine = 24.sp) + ) ), contentPadding = contentPadding, modifier = Modifier diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditorActions.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditorActions.kt index 3822b365b..1c342444e 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditorActions.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownEditorActions.kt @@ -2,21 +2,12 @@ package com.darkrockstudios.apps.hammer.common.compose.markdowneditor import com.darkrockstudios.texteditor.CharLineOffset import com.darkrockstudios.texteditor.TextEditorRange +import com.darkrockstudios.texteditor.markdown.MarkdownExtension import com.darkrockstudios.texteditor.richstyle.HR_PLACEHOLDER import com.darkrockstudios.texteditor.richstyle.HorizontalRuleSpanStyle import com.darkrockstudios.texteditor.state.TextEditorState -import com.darkrockstudios.texteditor.state.headerLevel -import com.darkrockstudios.texteditor.state.isTableCell -import com.darkrockstudios.texteditor.state.toggleBlockquote -import com.darkrockstudios.texteditor.state.toggleBulletList -import com.darkrockstudios.texteditor.state.toggleHeader -import com.darkrockstudios.texteditor.state.toggleOrderedList internal fun insertHorizontalRule(state: TextEditorState) { - // A table cell holds inline text alone, and a rule would break the table apart. - val selection = state.selector.selection - val touched = selection?.let { listOf(it.start.line, it.end.line) } ?: listOf(state.cursorPosition.line) - if (touched.any { state.isTableCell(it) }) return state.insertNewlineAtCursor() val hrLine = state.cursorPosition.line state.insertStringAtCursor(HR_PLACEHOLDER) @@ -58,37 +49,49 @@ internal fun reconcileHorizontalRules(state: TextEditorState) { } } -private fun selectedLines(state: TextEditorState): IntRange { +internal fun toggleBulletList(state: TextEditorState, markdown: MarkdownExtension) { val selection = state.selector.selection - return if (selection != null) { + val lines = if (selection != null) { selection.start.line..selection.end.line } else { state.cursorPosition.line..state.cursorPosition.line } + markdown.toggleBulletList(lines) } -internal fun toggleBlockquote(state: TextEditorState) { - state.toggleBlockquote(selectedLines(state)) -} - -internal fun toggleBulletList(state: TextEditorState) { - state.toggleBulletList(selectedLines(state)) -} - -internal fun toggleOrderedList(state: TextEditorState) { - state.toggleOrderedList(selectedLines(state)) +internal fun toggleOrderedList(state: TextEditorState, markdown: MarkdownExtension) { + val selection = state.selector.selection + val lines = if (selection != null) { + selection.start.line..selection.end.line + } else { + state.cursorPosition.line..state.cursorPosition.line + } + markdown.toggleOrderedList(lines) } internal val HEADER_CYCLE_LEVELS = 1..3 -internal fun cycleHeader(state: TextEditorState, currentLevel: Int) { - val lines = selectedLines(state) - if (currentLevel >= HEADER_CYCLE_LEVELS.last) { - // toggleHeader only removes a level every line already has, so clear each line by its own - lines.forEach { line -> - state.headerLevel(line)?.let { state.toggleHeader(line..line, it) } +internal fun cycleHeader( + state: TextEditorState, + markdown: MarkdownExtension, + currentLevel: Int, +) { + val maxLevel = HEADER_CYCLE_LEVELS.last + val nextLevel = (currentLevel + 1) % (maxLevel + 1) + val selection = state.selector.selection + if (selection != null) { + HEADER_CYCLE_LEVELS.forEach { lvl -> + state.removeStyleSpan(selection, markdown.markdownStyles.header(lvl)) + } + if (nextLevel != 0) { + state.addStyleSpan(selection, markdown.markdownStyles.header(nextLevel)) } } else { - state.toggleHeader(lines, currentLevel + 1) + HEADER_CYCLE_LEVELS.forEach { lvl -> + state.cursor.removeStyle(markdown.markdownStyles.header(lvl)) + } + if (nextLevel != 0) { + state.cursor.addStyle(markdown.markdownStyles.header(nextLevel)) + } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownFormatBar.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownFormatBar.kt index ffaec5a30..7f96e580f 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownFormatBar.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownFormatBar.kt @@ -8,9 +8,7 @@ import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.RowScope import androidx.compose.foundation.layout.Spacer import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.width -import androidx.compose.foundation.layout.widthIn import androidx.compose.foundation.rememberScrollState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.automirrored.filled.FormatListBulleted @@ -23,7 +21,6 @@ import androidx.compose.material3.DropdownMenu import androidx.compose.material3.DropdownMenuItem import androidx.compose.material3.ExperimentalMaterial3Api import androidx.compose.material3.Icon -import androidx.compose.material3.IconButton import androidx.compose.material3.MaterialTheme import androidx.compose.material3.PlainTooltip import androidx.compose.material3.Text @@ -36,13 +33,10 @@ import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.setValue -import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.text.SpanStyle -import androidx.compose.ui.text.style.TextAlign import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle import com.darkrockstudios.apps.hammer.common.compose.boldShortcutModifier import com.darkrockstudios.apps.hammer.common.compose.icons.EditorIcons import com.darkrockstudios.apps.hammer.common.compose.icons.IconBold @@ -56,7 +50,6 @@ import com.darkrockstudios.apps.hammer.common.compose.icons.IconUndo import com.darkrockstudios.apps.hammer.common.compose.italicShortcutModifier import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.strikethroughShortcutModifier -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.markdown_format_bar_blockquote import com.darkrockstudios.apps.hammer.markdown_format_bar_bold import com.darkrockstudios.apps.hammer.markdown_format_bar_bullet_list @@ -69,23 +62,16 @@ import com.darkrockstudios.apps.hammer.markdown_format_bar_italic import com.darkrockstudios.apps.hammer.markdown_format_bar_numbered_list import com.darkrockstudios.apps.hammer.markdown_format_bar_redo import com.darkrockstudios.apps.hammer.markdown_format_bar_reset_text_size -import com.darkrockstudios.apps.hammer.markdown_format_bar_text_size import com.darkrockstudios.apps.hammer.markdown_format_bar_strikethrough import com.darkrockstudios.apps.hammer.markdown_format_bar_undo import com.darkrockstudios.apps.hammer.more_menu_button -import com.darkrockstudios.texteditor.TextEditorRange import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.richstyle.BlockquoteSpanStyle import com.darkrockstudios.texteditor.richstyle.BulletListSpanStyle import com.darkrockstudios.texteditor.richstyle.OrderedListSpanStyle import com.darkrockstudios.texteditor.state.TextEditorState import com.darkrockstudios.texteditor.state.getRichSpansAtPosition import com.darkrockstudios.texteditor.state.getRichSpansInRange -import com.darkrockstudios.texteditor.state.hasStyleThroughout -import com.darkrockstudios.texteditor.state.headerLevel -import com.darkrockstudios.texteditor.state.isInlineOnlyLine -import com.darkrockstudios.texteditor.state.isTableCell -import com.darkrockstudios.texteditor.state.toggleSpanStyle +import com.darkrockstudios.texteditor.state.getSpanStylesInRange @Composable fun MarkdownFormatBar( @@ -103,50 +89,36 @@ fun MarkdownFormatBar( var isBulletListActive by remember { mutableStateOf(false) } var isOrderedListActive by remember { mutableStateOf(false) } var currentHeaderLevel by remember { mutableStateOf(0) } - var blocksRefused by remember { mutableStateOf(false) } - var ruleRefused by remember { mutableStateOf(false) } val state = remember(markdownState) { markdownState.editorState } - // A table cell holds inline text alone: no list, heading or rule goes on it, and a rule - // would break a table a selection reaches into. - fun readCaretLine(line: Int, selection: TextEditorRange?) { - blocksRefused = state.isInlineOnlyLine(line) - ruleRefused = blocksRefused || selection != null && (state.isTableCell(selection.start.line) || state.isTableCell(selection.end.line)) - } - LaunchedEffect(Unit) { state.cursorDataFlow.collect { (position, cursorStyles, selection) -> - // Active exactly when the toggle would remove the style. - fun isActive(style: SpanStyle) = - if (selection != null && selection.start != selection.end) { - state.hasStyleThroughout(selection, style) - } else { - style in cursorStyles - } + val styles = if (selection != null) { + state.getSpanStylesInRange(selection) + } else { + cursorStyles + } val richSpans = if (selection != null) { state.getRichSpansInRange(selection) } else { state.getRichSpansAtPosition(position) } - isBoldActive = isActive(state.richTextStyles.boldStyle) - isItalicActive = isActive(state.richTextStyles.italicStyle) - isStrikethroughActive = isActive(state.richTextStyles.strikethroughStyle) - isBlockquoteActive = richSpans.any { it.style === BlockquoteSpanStyle } - isBulletListActive = richSpans.any { it.style is BulletListSpanStyle } - isOrderedListActive = richSpans.any { it.style is OrderedListSpanStyle } - currentHeaderLevel = state.headerLevel(selection?.start?.line ?: position.line) ?: 0 - readCaretLine(position.line, selection) + isBoldActive = styles.contains(markdownState.markdownStyles.BOLD) + isItalicActive = styles.contains(markdownState.markdownStyles.ITALICS) + isStrikethroughActive = styles.contains(markdownState.markdownStyles.STRIKETHROUGH) + isBlockquoteActive = styles.contains(markdownState.markdownStyles.BLOCKQUOTE) + isBulletListActive = richSpans.any { it.style === BulletListSpanStyle } + isOrderedListActive = richSpans.any { it.style === OrderedListSpanStyle } + currentHeaderLevel = HEADER_CYCLE_LEVELS.firstOrNull { lvl -> + styles.contains(markdownState.markdownStyles.header(lvl)) + } ?: 0 } } LaunchedEffect(Unit) { - state.editOperations.collect { - reconcileHorizontalRules(state) - // An edit can make the caret's line a table cell without moving the caret. - readCaretLine(state.cursorPosition.line, state.selector.selection) - } + state.editOperations.collect { reconcileHorizontalRules(state) } } val showOverflow = decreaseTextSize != null || increaseTextSize != null || @@ -162,6 +134,7 @@ fun MarkdownFormatBar( Row(modifier = rowModifier) { FormatButtons( state = state, + markdownState = markdownState, isBoldActive = isBoldActive, isItalicActive = isItalicActive, isStrikethroughActive = isStrikethroughActive, @@ -169,8 +142,6 @@ fun MarkdownFormatBar( isBulletListActive = isBulletListActive, isOrderedListActive = isOrderedListActive, currentHeaderLevel = currentHeaderLevel, - blocksRefused = blocksRefused, - ruleRefused = ruleRefused, ) if (compact) { @@ -196,6 +167,7 @@ private val TOOLBAR_COMPACT_THRESHOLD = 520.dp @Composable private fun RowScope.FormatButtons( state: TextEditorState, + markdownState: MarkdownExtension, isBoldActive: Boolean, isItalicActive: Boolean, isStrikethroughActive: Boolean, @@ -203,15 +175,13 @@ private fun RowScope.FormatButtons( isBulletListActive: Boolean, isOrderedListActive: Boolean, currentHeaderLevel: Int, - blocksRefused: Boolean, - ruleRefused: Boolean, ) { EditorTooltip("${Res.string.markdown_format_bar_bold.get()} (${shortcutHint("B")})") { EditorAction( icon = EditorIcons.IconBold, active = isBoldActive, ) { - state.toggleSpanStyle(state.richTextStyles.boldStyle) + toggleStyle(state, markdownState.markdownStyles.BOLD) } } EditorTooltip("${Res.string.markdown_format_bar_italic.get()} (${shortcutHint("I")})") { @@ -219,7 +189,7 @@ private fun RowScope.FormatButtons( icon = EditorIcons.IconItalic, active = isItalicActive, ) { - state.toggleSpanStyle(state.richTextStyles.italicStyle) + toggleStyle(state, markdownState.markdownStyles.ITALICS) } } EditorTooltip( @@ -234,50 +204,45 @@ private fun RowScope.FormatButtons( icon = EditorIcons.IconStrikethrough, active = isStrikethroughActive, ) { - state.toggleSpanStyle(state.richTextStyles.strikethroughStyle) + toggleStyle(state, markdownState.markdownStyles.STRIKETHROUGH) } } EditorTooltip(Res.string.markdown_format_bar_heading.get()) { EditorTextAction( label = if (currentHeaderLevel == 0) "H" else "H$currentHeaderLevel", active = currentHeaderLevel != 0, - enabled = !blocksRefused, ) { - cycleHeader(state, currentHeaderLevel) + cycleHeader(state, markdownState, currentHeaderLevel) } } EditorTooltip(Res.string.markdown_format_bar_blockquote.get()) { EditorAction( icon = Icons.Default.FormatQuote, active = isBlockquoteActive, - enabled = !blocksRefused, ) { - toggleBlockquote(state) + toggleStyle(state, markdownState.markdownStyles.BLOCKQUOTE) } } EditorTooltip(Res.string.markdown_format_bar_bullet_list.get()) { EditorAction( icon = Icons.AutoMirrored.Filled.FormatListBulleted, active = isBulletListActive, - enabled = !blocksRefused, ) { - toggleBulletList(state) + toggleBulletList(state, markdownState) } } EditorTooltip(Res.string.markdown_format_bar_numbered_list.get()) { EditorAction( icon = Icons.Default.FormatListNumbered, active = isOrderedListActive, - enabled = !blocksRefused, ) { - toggleOrderedList(state) + toggleOrderedList(state, markdownState) } } EditorTooltip(Res.string.markdown_format_bar_horizontal_rule.get()) { EditorAction( icon = Icons.Default.HorizontalRule, active = false, - enabled = !ruleRefused, ) { insertHorizontalRule(state) } @@ -311,8 +276,7 @@ private fun HistoryAndOverflow( EditorTooltip(Res.string.markdown_format_bar_undo.get()) { EditorAction( icon = EditorIcons.IconUndo, - active = false, - enabled = state.canUndo, + active = state.canUndo ) { state.undo() } @@ -320,8 +284,7 @@ private fun HistoryAndOverflow( EditorTooltip(Res.string.markdown_format_bar_redo.get()) { EditorAction( icon = EditorIcons.IconRedo, - active = false, - enabled = state.canRedo, + active = state.canRedo ) { state.redo() } @@ -358,60 +321,49 @@ private fun HistoryAndOverflow( }, ) } - if (decreaseTextSize != null || increaseTextSize != null || resetTextSize != null) { - TextSizeMenuRow(decreaseTextSize, increaseTextSize, resetTextSize) - } - } - } -} - -/** Steps the body text size and shows it; the menu stays open while stepping. */ -@Composable -private fun TextSizeMenuRow( - decreaseTextSize: (() -> Unit)?, - increaseTextSize: (() -> Unit)?, - resetTextSize: (() -> Unit)?, -) { - val textSize = LocalEditorTextStyle.current.fontSize.value - Row( - modifier = Modifier.padding(start = 12.dp, end = 4.dp), - verticalAlignment = Alignment.CenterVertically, - ) { - Text( - text = Res.string.markdown_format_bar_text_size.get(), - style = MaterialTheme.typography.bodyLarge, - modifier = Modifier.padding(end = 12.dp), - ) - if (decreaseTextSize != null) { - IconButton(onClick = decreaseTextSize) { - Icon( - imageVector = EditorIcons.IconTextDecrease, - contentDescription = Res.string.markdown_format_bar_decrease_text_size.get(), + if (decreaseTextSize != null) { + DropdownMenuItem( + text = { Text(Res.string.markdown_format_bar_decrease_text_size.get()) }, + leadingIcon = { + Icon( + imageVector = EditorIcons.IconTextDecrease, + contentDescription = null, + ) + }, + onClick = { + decreaseTextSize() + menuExpanded = false + }, ) } - } - Text( - text = textSize.toInt().toString(), - style = MaterialTheme.typography.bodyLarge, - textAlign = TextAlign.Center, - modifier = Modifier.widthIn(min = 28.dp), - ) - if (increaseTextSize != null) { - IconButton(onClick = increaseTextSize) { - Icon( - imageVector = EditorIcons.IconTextIncrease, - contentDescription = Res.string.markdown_format_bar_increase_text_size.get(), + if (increaseTextSize != null) { + DropdownMenuItem( + text = { Text(Res.string.markdown_format_bar_increase_text_size.get()) }, + leadingIcon = { + Icon( + imageVector = EditorIcons.IconTextIncrease, + contentDescription = null, + ) + }, + onClick = { + increaseTextSize() + menuExpanded = false + }, ) } - } - if (resetTextSize != null) { - IconButton( - onClick = resetTextSize, - enabled = textSize != GlobalSettings.DEFAULT_FONT_SIZE, - ) { - Icon( - imageVector = EditorIcons.IconTextReset, - contentDescription = Res.string.markdown_format_bar_reset_text_size.get(), + if (resetTextSize != null) { + DropdownMenuItem( + text = { Text(Res.string.markdown_format_bar_reset_text_size.get()) }, + leadingIcon = { + Icon( + imageVector = EditorIcons.IconTextReset, + contentDescription = null, + ) + }, + onClick = { + resetTextSize() + menuExpanded = false + }, ) } } @@ -427,7 +379,34 @@ private fun TextSizeMenuRow( fun Modifier.markdownFormatShortcuts(markdownExtension: MarkdownExtension): Modifier { val state = markdownExtension.editorState return this - .boldShortcutModifier { state.toggleSpanStyle(state.richTextStyles.boldStyle) } - .italicShortcutModifier { state.toggleSpanStyle(state.richTextStyles.italicStyle) } - .strikethroughShortcutModifier { state.toggleSpanStyle(state.richTextStyles.strikethroughStyle) } + .boldShortcutModifier { toggleStyle(state, markdownExtension.markdownStyles.BOLD) } + .italicShortcutModifier { toggleStyle(state, markdownExtension.markdownStyles.ITALICS) } + .strikethroughShortcutModifier { toggleStyle(state, markdownExtension.markdownStyles.STRIKETHROUGH) } +} + +/** + * Toggles [spanStyle] over the current selection, or at the cursor when there is + * no selection. The active state is read synchronously from the editor so this is + * safe to call from a keyboard shortcut as well as a toolbar button. + */ +private fun toggleStyle( + state: TextEditorState, + spanStyle: SpanStyle, +) { + val selection = state.selector.selection + if (selection != null) { + val isActive = state.getSpanStylesInRange(selection).contains(spanStyle) + if (isActive) { + state.removeStyleSpan(selection, spanStyle) + } else { + state.addStyleSpan(selection, spanStyle) + } + } else { + val isActive = state.cursor.styles.contains(spanStyle) + if (isActive) { + state.cursor.removeStyle(spanStyle) + } else { + state.cursor.addStyle(spanStyle) + } + } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownView.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownView.kt index c5f6520ad..cf0ed3285 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownView.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/MarkdownView.kt @@ -3,19 +3,16 @@ package com.darkrockstudios.apps.hammer.common.compose.markdowneditor import androidx.compose.foundation.layout.PaddingValues import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue import androidx.compose.ui.Modifier import androidx.compose.ui.semantics.semantics import androidx.compose.ui.semantics.text import androidx.compose.ui.text.AnnotatedString +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.style.TextIndent import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.LocalRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.withParagraphIndent +import androidx.compose.ui.unit.sp +import com.darkrockstudios.apps.hammer.common.compose.LocalMarkdownConfig import com.darkrockstudios.texteditor.RichTextView import com.darkrockstudios.texteditor.markdown.withMarkdown import com.darkrockstudios.texteditor.rememberTextEditorStyle @@ -28,43 +25,27 @@ import com.darkrockstudios.texteditor.state.rememberTextEditorState * * The raw [markdown] is exposed via semantics so test matchers (`onNodeWithText`, * `assertTextSatisfies`) can read it; the Canvas-based render itself has no semantic text. - * - * [importDuringComposition] parses the first text in composition instead of a frame later, - * so the view has its real height on the first frame. A lazy list cannot scroll past a row - * that is still empty. - * - * [isSelectable] lets the user select and copy text. */ @Composable fun MarkdownView( markdown: String, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), - importDuringComposition: Boolean = false, - isSelectable: Boolean = false, ) { - val richTextStyles = LocalRichTextStyles.current + val markdownConfig = LocalMarkdownConfig.current val state = rememberTextEditorState() - var imported by remember(state) { mutableStateOf(if (importDuringComposition) markdown else null) } - val markdownExtension = remember(state) { - state.richTextStyles = richTextStyles - state.withMarkdown(HammerMarkdownConfiguration).apply { - if (importDuringComposition) importMarkdown(markdown) - } - } + val markdownExtension = remember(state) { state.withMarkdown(markdownConfig) } LaunchedEffect(markdownExtension, markdown) { - if (imported != markdown) { - markdownExtension.importMarkdown(markdown) - imported = markdown - } + markdownExtension.importMarkdown(markdown) } RichTextView( state = state, modifier = modifier.semantics { text = AnnotatedString(markdown) }, contentPadding = contentPadding, - isSelectable = isSelectable, style = rememberTextEditorStyle( - textStyle = LocalEditorTextStyle.current.withParagraphIndent() + textStyle = TextStyle.Default.copy( + textIndent = TextIndent(firstLine = 24.sp) + ) ) ) } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/reorderable/DragDropList.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/reorderable/DragDropList.kt index ab04d6379..3a27b62de 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/reorderable/DragDropList.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/reorderable/DragDropList.kt @@ -4,9 +4,7 @@ import androidx.compose.foundation.ExperimentalFoundationApi import androidx.compose.foundation.gestures.detectDragGesturesAfterLongPress import androidx.compose.foundation.gestures.scrollBy import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.PaddingValues -import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.lazy.LazyColumn import androidx.compose.foundation.lazy.itemsIndexed import androidx.compose.runtime.Composable @@ -22,9 +20,6 @@ import androidx.compose.ui.hapticfeedback.HapticFeedbackType import androidx.compose.ui.input.pointer.pointerInput import androidx.compose.ui.platform.LocalHapticFeedback import androidx.compose.ui.zIndex -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarGutter -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import kotlinx.coroutines.Job import kotlinx.coroutines.launch @@ -69,67 +64,58 @@ fun DragDropList( }) val hapticFeedback = LocalHapticFeedback.current - Box(modifier = modifier) { - LazyColumn( - modifier = Modifier - .fillMaxSize() - .padding(end = MpScrollBarGutter) - .pointerInput(Unit) { - detectDragGesturesAfterLongPress( - onDrag = { change, offset -> - change.consume() - dragDropListState.onDrag(offset) + LazyColumn( + modifier = modifier + .pointerInput(Unit) { + detectDragGesturesAfterLongPress( + onDrag = { change, offset -> + change.consume() + dragDropListState.onDrag(offset) - if (overscrollJob?.isActive == true) - return@detectDragGesturesAfterLongPress + if (overscrollJob?.isActive == true) + return@detectDragGesturesAfterLongPress - dragDropListState.checkForOverScroll() - .takeIf { it != 0f } - ?.let { overscrollJob = scope.launch { dragDropListState.lazyListState.scrollBy(it) } } - ?: run { overscrollJob?.cancel() } - }, - onDragStart = { offset -> - if (dragDropListState.onDragStart(offset)) { - hapticFeedback.performHapticFeedback(HapticFeedbackType.LongPress) - } - }, - onDragEnd = { dragDropListState.onDragEnd() }, - onDragCancel = { dragDropListState.onDragInterrupted() } - ) - }, - state = dragDropListState.lazyListState, - contentPadding = contentPadding - ) { - itemsIndexed(data, key) { index, item -> - val isDragging = index == dragDropListState.currentIndexOfDraggedItem - val isReordering = dragDropListState.currentIndexOfDraggedItem != null - val zIndex = if (isDragging) { - 1f - } else { - 0f - } - // Animate placement only while reordering, so the displaced items - // slide into place; otherwise plain scrolling would animate them too. - val itemModifier = when { - isDragging -> Modifier.graphicsLayer { - translationY = dragDropListState.elementDisplacement ?: 0f - } - isReordering -> Modifier.animateItem() - else -> Modifier - } - Box( - modifier = Modifier - .zIndex(zIndex) - .then(itemModifier) - ) { - itemContent(item, isDragging) + dragDropListState.checkForOverScroll() + .takeIf { it != 0f } + ?.let { overscrollJob = scope.launch { dragDropListState.lazyListState.scrollBy(it) } } + ?: run { overscrollJob?.cancel() } + }, + onDragStart = { offset -> + if (dragDropListState.onDragStart(offset)) { + hapticFeedback.performHapticFeedback(HapticFeedbackType.LongPress) + } + }, + onDragEnd = { dragDropListState.onDragEnd() }, + onDragCancel = { dragDropListState.onDragInterrupted() } + ) + }, + state = dragDropListState.lazyListState, + contentPadding = contentPadding + ) { + itemsIndexed(data, key) { index, item -> + val isDragging = index == dragDropListState.currentIndexOfDraggedItem + val isReordering = dragDropListState.currentIndexOfDraggedItem != null + val zIndex = if (isDragging) { + 1f + } else { + 0f + } + // Animate placement only while reordering, so the displaced items + // slide into place; otherwise plain scrolling would animate them too. + val itemModifier = when { + isDragging -> Modifier.graphicsLayer { + translationY = dragDropListState.elementDisplacement ?: 0f } + isReordering -> Modifier.animateItem() + else -> Modifier + } + Box( + modifier = Modifier + .zIndex(zIndex) + .then(itemModifier) + ) { + itemContent(item, isDragging) } } - - MpScrollBarList( - modifier = scrollBarOverlay(), - state = dragDropListState.lazyListState, - ) } } \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.kt deleted file mode 100644 index 19223a4dd..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.theme - -expect val oledBlackThemeAvailable: Boolean diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/ProjectColorScheme.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/ProjectColorScheme.kt index 9dd4b324f..9c21c100c 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/ProjectColorScheme.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/ProjectColorScheme.kt @@ -60,11 +60,7 @@ fun ProjectThemeOverride( } val parentIsDark = MaterialTheme.colorScheme.background.luminance() < 0.5f - val oledBlack = LocalOledBlack.current - val derived = remember(theme, parentIsDark, oledBlack) { - val scheme = theme.toColorScheme(parentIsDark) - if (oledBlack) scheme?.withOledBlack() else scheme - } + val derived = remember(theme, parentIsDark) { theme.toColorScheme(parentIsDark) } if (derived == null) { content() diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/Theme.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/Theme.kt index 5dce83239..9e9008ae8 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/Theme.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/Theme.kt @@ -6,12 +6,9 @@ import androidx.compose.material3.* import androidx.compose.runtime.Composable import androidx.compose.runtime.CompositionLocalProvider import androidx.compose.runtime.remember -import androidx.compose.runtime.staticCompositionLocalOf -import androidx.compose.ui.graphics.Color import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.ProvideRichTextStyles +import com.darkrockstudios.apps.hammer.common.compose.ProvideMarkdownConfig import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.UiTheme val LightColors = lightColorScheme( @@ -87,15 +84,6 @@ fun resolveColorScheme(useDarkTheme: Boolean): ColorScheme { } } -val LocalOledBlack = staticCompositionLocalOf { false } - -fun ColorScheme.withOledBlack(): ColorScheme = copy( - background = Color.Black, - surface = Color.Black, - surfaceDim = Color.Black, - surfaceContainerLowest = Color.Black, -) - // Manuscript shape system — every M3 component reads square corners by // default. Per-component rounding (e.g. chart bars) is opted in // explicitly. See designsystem/DESIGN_README.md. @@ -115,24 +103,19 @@ fun AppTheme( getOverrideColorScheme: ((Boolean) -> ColorScheme?)? = null, content: @Composable () -> Unit ) { - val oledBlack = useDarkTheme && settings.uiTheme == UiTheme.OledBlack - val colors = remember(useDarkTheme, oledBlack) { - val base = getOverrideColorScheme?.invoke(useDarkTheme) ?: resolveColorScheme(useDarkTheme) - if (oledBlack) base.withOledBlack() else base + val colors = remember(useDarkTheme) { + getOverrideColorScheme?.invoke(useDarkTheme) ?: resolveColorScheme(useDarkTheme) } val extendedColors = if (useDarkTheme) DarkHammerColors else LightHammerColors - CompositionLocalProvider( - LocalHammerColors provides extendedColors, - LocalOledBlack provides oledBlack, - ) { + CompositionLocalProvider(LocalHammerColors provides extendedColors) { MaterialTheme( colorScheme = colors, shapes = HammerShapes, typography = hammerTypography(), ) { - ProvideRichTextStyles(isDark = useDarkTheme, settings = settings) { + ProvideMarkdownConfig(isDark = useDarkTheme, settings = settings) { content() } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/BrowseEntriesUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/BrowseEntriesUi.kt index 8d3d03218..2320245a8 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/BrowseEntriesUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/BrowseEntriesUi.kt @@ -10,7 +10,6 @@ import androidx.compose.animation.fadeOut import androidx.compose.animation.togetherWith import androidx.compose.foundation.horizontalScroll import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.ExperimentalLayoutApi import androidx.compose.foundation.layout.FlowRow @@ -23,7 +22,6 @@ import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.widthIn import androidx.compose.foundation.lazy.grid.GridCells import androidx.compose.foundation.lazy.grid.LazyVerticalGrid -import androidx.compose.foundation.lazy.grid.rememberLazyGridState import androidx.compose.foundation.rememberScrollState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Create @@ -53,7 +51,6 @@ import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.encyclopedia.BrowseEntries import com.darkrockstudios.apps.hammer.common.components.encyclopedia.Encyclopedia import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarGrid import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCollapsingStrip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEntryFilterBar @@ -66,7 +63,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSectionHeader import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagChip import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.search.parseQuery @@ -228,46 +224,37 @@ fun BrowseEntriesUi( // Card grid — adaptive 320dp min cell so on wide screens we get // 3-4 columns and on narrow screens cards stack into a single // column. - val gridState = rememberLazyGridState() - Box(modifier = Modifier.weight(1f)) { - LazyVerticalGrid( - state = gridState, - columns = GridCells.Adaptive(minSize = 320.dp), - modifier = Modifier.fillMaxSize(), - contentPadding = PaddingValues(Ui.Padding.XL), - verticalArrangement = Arrangement.spacedBy(Ui.Padding.XL), - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.XL), - ) { - if (filteredEntries.isEmpty()) { - item { - Text( - text = Res.string.encyclopedia_browse_list_empty.get(), - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onBackground, - modifier = Modifier.padding(Ui.Padding.XL), - ) - } - } else { - items(filteredEntries.size) { index -> - EncyclopediaEntryItem( - entryDef = filteredEntries[index], - component = component, - viewEntry = viewEntry, - scope = scope, - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - activeTags = activeTags.toSet(), - tagsScrollHorizontally = !isWide, - filterByType = onSelectType, - ) - } + LazyVerticalGrid( + columns = GridCells.Adaptive(minSize = 320.dp), + modifier = Modifier.fillMaxSize(), + contentPadding = PaddingValues(Ui.Padding.XL), + verticalArrangement = Arrangement.spacedBy(Ui.Padding.XL), + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.XL), + ) { + if (filteredEntries.isEmpty()) { + item { + Text( + text = Res.string.encyclopedia_browse_list_empty.get(), + style = MaterialTheme.typography.headlineSmall, + color = MaterialTheme.colorScheme.onBackground, + modifier = Modifier.padding(Ui.Padding.XL), + ) + } + } else { + items(filteredEntries.size) { index -> + EncyclopediaEntryItem( + entryDef = filteredEntries[index], + component = component, + viewEntry = viewEntry, + scope = scope, + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + activeTags = activeTags.toSet(), + tagsScrollHorizontally = !isWide, + filterByType = onSelectType, + ) } } - - MpScrollBarGrid( - modifier = scrollBarOverlay(), - state = gridState, - ) } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/CreateEntryUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/CreateEntryUi.kt index 1c62ce309..184515481 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/CreateEntryUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/CreateEntryUi.kt @@ -22,6 +22,7 @@ import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableStateListOf import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.saveable.rememberSaveable @@ -45,15 +46,14 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineBut import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineField import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineImageDrop import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineTagField -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineTypePicker import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.glyph import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownEditField import com.darkrockstudios.apps.hammer.common.compose.rememberIoDispatcher -import com.darkrockstudios.apps.hammer.common.compose.rememberSaveableStringList import com.darkrockstudios.apps.hammer.common.compose.rememberStrRes import com.darkrockstudios.apps.hammer.common.compose.resources.get +import com.darkrockstudios.apps.hammer.common.compose.retryingFileDialog import com.darkrockstudios.apps.hammer.common.compose.stageIntoCache import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource @@ -76,8 +76,6 @@ import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_image_too_large import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_name_label import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_name_placeholder import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_section_marker -import com.darkrockstudios.apps.hammer.encyclopedia_entry_dictionary_toggle_hint -import com.darkrockstudios.apps.hammer.encyclopedia_entry_dictionary_toggle_label import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_tags_hint import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_tags_label import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_tags_placeholder @@ -87,10 +85,8 @@ import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_name_too_ import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_success import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_tag_too_long import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_too_long -import io.github.aakira.napier.Napier import io.github.vinceglb.filekit.FileKit import io.github.vinceglb.filekit.PlatformFile -import io.github.vinceglb.filekit.dialogs.FileKitPickerException import io.github.vinceglb.filekit.dialogs.FileKitType import io.github.vinceglb.filekit.dialogs.openFilePicker import io.github.vinceglb.filekit.path @@ -118,9 +114,8 @@ internal fun CreateEntryUi( var name by rememberSaveable { mutableStateOf("") } var description by rememberSaveable { mutableStateOf("") } - val tags = rememberSaveableStringList() + val tags = remember { mutableStateListOf() } var selectedType by rememberSaveable { mutableStateOf(EntryType.PERSON) } - var excludeFromDictionary by rememberSaveable { mutableStateOf(false) } var imagePath by remember { mutableStateOf(null) } @@ -212,7 +207,6 @@ internal fun CreateEntryUi( MarkdownEditField( initialMarkdown = description, onMarkdownChanged = { description = it }, - enableSpellChecking = state.spellCheckAllowed, contentPadding = PaddingValues(Ui.Padding.XL), modifier = Modifier.fillMaxWidth().heightIn(min = 160.dp), ) @@ -222,14 +216,8 @@ internal fun CreateEntryUi( label = Res.string.encyclopedia_create_entry_cover_art_label.get(), onClick = { scope.launch { - val picked = try { + val picked = retryingFileDialog { FileKit.openFilePicker(type = FileKitType.File(EncyclopediaDatasource.IMAGE_EXTENSIONS)) - } catch (e: FileKitPickerException) { - Napier.e("Image picker failed", e) - rootSnackbar.showSnackbar( - strRes.get(Res.string.encyclopedia_create_entry_image_load_failed) - ) - null } if (picked != null) applyImage(picked) } @@ -258,15 +246,6 @@ internal fun CreateEntryUi( { imagePath = null } } else null, ) - - if (state.dictionaryFeatureEnabled) { - HdHairlineToggleRow( - checked = !excludeFromDictionary, - label = Res.string.encyclopedia_entry_dictionary_toggle_label.get(), - hint = Res.string.encyclopedia_entry_dictionary_toggle_hint.get(), - onCheckedChange = { include -> excludeFromDictionary = !include }, - ) - } } HairlineModalFooter( @@ -280,7 +259,6 @@ internal fun CreateEntryUi( text = description, tags = tags.toSet(), imagePath = imagePath?.path, - excludeFromDictionary = excludeFromDictionary, ) val message = when (result.error) { EntryError.NAME_TOO_LONG -> strRes.get( diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/ViewEntryUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/ViewEntryUi.kt index ed952c1e6..2d3b7ae95 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/ViewEntryUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/encyclopedia/ViewEntryUi.kt @@ -3,48 +3,20 @@ package com.darkrockstudios.apps.hammer.common.encyclopedia import androidx.compose.animation.AnimatedVisibilityScope import androidx.compose.animation.ExperimentalSharedTransitionApi import androidx.compose.animation.SharedTransitionScope -import androidx.compose.foundation.background -import androidx.compose.foundation.border -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.foundation.layout.PaddingValues -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.RowScope -import androidx.compose.foundation.layout.fillMaxHeight -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.size -import androidx.compose.foundation.layout.width -import androidx.compose.foundation.layout.widthIn -import androidx.compose.foundation.rememberScrollState +import androidx.compose.foundation.* +import androidx.compose.foundation.layout.* import androidx.compose.foundation.text.BasicText import androidx.compose.foundation.text.BasicTextField import androidx.compose.foundation.text.KeyboardOptions import androidx.compose.foundation.text.TextAutoSize -import androidx.compose.foundation.verticalScroll import androidx.compose.material.icons.Icons import androidx.compose.material.icons.automirrored.filled.Article import androidx.compose.material.icons.filled.Add import androidx.compose.material.icons.filled.Delete -import androidx.compose.material3.ExperimentalMaterial3Api -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.Icon -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember +import androidx.compose.material3.* +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass +import androidx.compose.runtime.* import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.focus.onFocusChanged @@ -56,7 +28,6 @@ import androidx.compose.ui.layout.ContentScale import androidx.compose.ui.text.TextStyle import androidx.compose.ui.text.font.FontWeight import androidx.compose.ui.text.input.ImeAction -import androidx.compose.ui.text.input.KeyboardCapitalization import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp @@ -68,101 +39,21 @@ import coil3.memory.MemoryCache import coil3.request.ImageRequest import coil3.request.crossfade import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.Res +import com.darkrockstudios.apps.hammer.* import com.darkrockstudios.apps.hammer.common.components.encyclopedia.ViewEntry -import com.darkrockstudios.apps.hammer.common.compose.CollapseWhileTyping -import com.darkrockstudios.apps.hammer.common.compose.DetailViewDropdownMenu -import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn -import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.compose.SimpleConfirm -import com.darkrockstudios.apps.hammer.common.compose.SimpleDialog -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCrumbBackLink -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdDetailStampRow -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEngravingPlaceholder -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineField -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineGrid -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMetadataItem -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSectionHeader -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagChip -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagSuggestionStrip -import com.darkrockstudios.apps.hammer.common.compose.designsystem.glyph -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberTagSuggestions +import com.darkrockstudios.apps.hammer.common.compose.* +import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownEditField import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownView -import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher -import com.darkrockstudios.apps.hammer.common.compose.rememberIoDispatcher -import com.darkrockstudios.apps.hammer.common.compose.rememberKoinInject -import com.darkrockstudios.apps.hammer.common.compose.rememberMainDispatcher -import com.darkrockstudios.apps.hammer.common.compose.rememberStrRes import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay -import com.darkrockstudios.apps.hammer.common.compose.stageIntoCache import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaDatasource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EncyclopediaRepository import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryError import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.EntryResult import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.tagindex.replaceTagPrefix import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_image_load_failed -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_image_too_large -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_tags_label -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_alias_too_long -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_invalid_name -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_name_too_short -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_success -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_tag_too_long -import com.darkrockstudios.apps.hammer.encyclopedia_create_entry_toast_too_long -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_alias_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_alias_chip -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_alias_dialog_title -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_tag_chip -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_tags_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_add_tags_dialog_title -import com.darkrockstudios.apps.hammer.encyclopedia_entry_alias_hint -import com.darkrockstudios.apps.hammer.encyclopedia_entry_aliases_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_appears_in_empty -import com.darkrockstudios.apps.hammer.encyclopedia_entry_appears_in_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_dictionary_toggle_hint -import com.darkrockstudios.apps.hammer.encyclopedia_entry_dictionary_toggle_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_body_empty_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_close_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_colophon_end -import com.darkrockstudios.apps.hammer.encyclopedia_entry_colophon_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_colophon_label_compact -import com.darkrockstudios.apps.hammer.encyclopedia_entry_crumb_root -import com.darkrockstudios.apps.hammer.encyclopedia_entry_delete_image_message -import com.darkrockstudios.apps.hammer.encyclopedia_entry_delete_image_title -import com.darkrockstudios.apps.hammer.encyclopedia_entry_delete_message -import com.darkrockstudios.apps.hammer.encyclopedia_entry_delete_title -import com.darkrockstudios.apps.hammer.encyclopedia_entry_delete_toast -import com.darkrockstudios.apps.hammer.encyclopedia_entry_discard_message -import com.darkrockstudios.apps.hammer.encyclopedia_entry_discard_title -import com.darkrockstudios.apps.hammer.encyclopedia_entry_edit_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_edit_cancel_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_edit_save_button -import com.darkrockstudios.apps.hammer.encyclopedia_entry_edit_save_toast -import com.darkrockstudios.apps.hammer.encyclopedia_entry_figure_add -import com.darkrockstudios.apps.hammer.encyclopedia_entry_figure_caption -import com.darkrockstudios.apps.hammer.encyclopedia_entry_figure_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_folio_format -import com.darkrockstudios.apps.hammer.encyclopedia_entry_name_hint -import com.darkrockstudios.apps.hammer.encyclopedia_entry_particulars_aliases -import com.darkrockstudios.apps.hammer.encyclopedia_entry_particulars_label -import com.darkrockstudios.apps.hammer.encyclopedia_entry_particulars_scenes -import com.darkrockstudios.apps.hammer.encyclopedia_entry_particulars_tags -import com.darkrockstudios.apps.hammer.encyclopedia_entry_particulars_type -import com.darkrockstudios.apps.hammer.encyclopedia_entry_scene_index_format -import com.darkrockstudios.apps.hammer.encyclopedia_entry_tags_label -import io.github.aakira.napier.Napier import io.github.vinceglb.filekit.FileKit -import io.github.vinceglb.filekit.dialogs.FileKitPickerException import io.github.vinceglb.filekit.dialogs.FileKitType import io.github.vinceglb.filekit.dialogs.openFilePicker import io.github.vinceglb.filekit.path @@ -196,21 +87,15 @@ internal fun ViewEntryUi( var entryNameText by rememberSaveable { mutableStateOf(state.content?.name ?: "") } var entryText by rememberSaveable { mutableStateOf(state.content?.text ?: "") } var discardConfirm by rememberSaveable { mutableStateOf(false) } - var seeded by rememberSaveable { mutableStateOf(false) } val screen = LocalScreenCharacteristic.current val isCompact = screen.windowWidthClass == WindowWidthSizeClass.Compact - LaunchedEffect(state.content, state.editName, state.editText) { - val loaded = state.content ?: return@LaunchedEffect - // Once the fields hold the entry, an open edit owns them: re-seeding would discard - // unsaved text. Until then they must be filled even if the edit started first, - // otherwise a save writes an empty entry. Leaving edit mode reseeds, which is what - // makes a discard from outside this screen drop the typed text. - if (seeded && (state.editName || state.editText)) return@LaunchedEffect - entryNameText = loaded.name - entryText = loaded.text - seeded = true + LaunchedEffect(state.content) { + state.content?.let { + entryNameText = it.name + entryText = it.text + } } val ruleColor = MaterialTheme.colorScheme.outlineVariant @@ -251,163 +136,146 @@ internal fun ViewEntryUi( } else { Modifier.fillMaxSize().verticalScroll(outerScrollState) } - Box { - Column( - modifier = outerModifier, - horizontalAlignment = Alignment.CenterHorizontally, - ) { - with(sharedTransitionScope) { - Column( - modifier = modifier - .padding( - start = Ui.Padding.M, - end = Ui.Padding.M, - ) - .widthIn(max = Ui.MaxWidth.CatalogueCard) - .fillMaxWidth() - .then(if (editing) Modifier.fillMaxHeight() else Modifier) - .background(MaterialTheme.colorScheme.surface) - .border(width = Dp.Hairline, color = ruleColor, shape = RectangleShape) - .sharedElement( - sharedContentState = rememberSharedContentState( - key = "encyclopedia-card-${state.entryDef.id}", - ), - animatedVisibilityScope = animatedVisibilityScope, - ), - ) { - CollapseWhileTyping(enabled = editing) { - Column { - CrumbRow( - title = entryNameText.ifBlank { state.entryDef.name }.uppercase(), - menuSlot = { DetailViewDropdownMenu(menuItems = state.menuItems) }, - onClose = { - val isDirty = content != null && - (entryNameText != content.name || entryText != content.text) - when { - editing && isDirty -> component.confirmClose() - editing -> { - component.finishNameEdit() - component.finishTextEdit() - closeEntry() - } - - else -> closeEntry() - } - }, - ) - - HorizontalDivider(thickness = Dp.Hairline, color = ruleColor) - } - } - - StampRow( - entryDef = state.entryDef, - editing = editing, - onEdit = { - component.startNameEdit() - component.startTextEdit() - }, - onSave = saveChanges, - onCancel = { - val isDirty = content != null && - (entryNameText != content.name || entryText != content.text) - if (isDirty) { - discardConfirm = true - } else { - discardChanges() - } - }, + Column( + modifier = outerModifier, + horizontalAlignment = Alignment.CenterHorizontally, + ) { + with(sharedTransitionScope) { + Column( + modifier = modifier + .padding( + start = Ui.Padding.M, + end = Ui.Padding.M, ) + .widthIn(max = Ui.MaxWidth.CatalogueCard) + .fillMaxWidth() + .then(if (editing) Modifier.fillMaxHeight() else Modifier) + .background(MaterialTheme.colorScheme.surface) + .border(width = Dp.Hairline, color = ruleColor, shape = RectangleShape) + .sharedElement( + sharedContentState = rememberSharedContentState( + key = "encyclopedia-card-${state.entryDef.id}", + ), + animatedVisibilityScope = animatedVisibilityScope, + ), + ) { + CollapseWhileTyping(enabled = editing) { + Column { + CrumbRow( + title = entryNameText.ifBlank { state.entryDef.name }.uppercase(), + menuSlot = { DetailViewDropdownMenu(menuItems = state.menuItems) }, + onClose = { + val isDirty = content != null && + (entryNameText != content.name || entryText != content.text) + when { + editing && isDirty -> component.confirmClose() + editing -> { + component.finishNameEdit() + component.finishTextEdit() + closeEntry() + } - HorizontalDivider(thickness = 2.dp, color = ruleStrong) - - // The big name collapses while the body editor has focus; kept visible while the name - // field itself holds focus so it stays reachable. - var nameFocused by remember { mutableStateOf(false) } - CollapseWhileTyping(keepVisible = nameFocused) { - NameZone( - entryNameText = entryNameText, - onNameChange = { entryNameText = it }, - editName = state.editName, - onStartEdit = component::startNameEdit, - onFocusChanged = { nameFocused = it }, - compact = isCompact, - sharedKey = "encyclopedia-title-${state.entryDef.id}", - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - ) - } - - val bodyOuterModifier = if (editing) Modifier.weight(1f) else Modifier - if (isCompact) { - CompactBody( - state = state, - entryText = entryText, - setEntryText = { entryText = it }, - onStartTextEdit = component::startTextEdit, - onShowDeleteImage = component::showDeleteImageDialog, - onAddImage = component::showAddImageDialog, - outerModifier = bodyOuterModifier, - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - ) - } else { - WideBody( - state = state, - entryText = entryText, - setEntryText = { entryText = it }, - onStartTextEdit = component::startTextEdit, - onShowDeleteImage = component::showDeleteImageDialog, - onAddImage = component::showAddImageDialog, - outerModifier = bodyOuterModifier, - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - ) - } - - if (!editing) { - if (content != null) { - ParticularsLedger( - state = state, - modifier = Modifier - .padding(horizontal = Ui.Padding.XXL) - .padding(top = 28.dp), - ) - } - - TagsAndAliasesZone( - state = state, - component = component, - compact = isCompact, + else -> closeEntry() + } + }, ) - AppearsInZone( - state = state, - component = component, - ) - - DictionaryToggleZone( - state = state, - component = component, - scope = scope, - ) - - FooterColophon( - compact = isCompact, - ruleSoft = ruleSoft, - ) + HorizontalDivider(thickness = Dp.Hairline, color = ruleColor) } } - } - } - // Editing swaps in a non-scrolling layout, leaving outerScrollState detached but still - // reporting its last measured extent, so only the screen knows the bar is stale. - if (!editing) { - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = outerScrollState, - ) + StampRow( + entryDef = state.entryDef, + editing = editing, + onEdit = { + component.startNameEdit() + component.startTextEdit() + }, + onSave = saveChanges, + onCancel = { + val isDirty = content != null && + (entryNameText != content.name || entryText != content.text) + if (isDirty) { + discardConfirm = true + } else { + discardChanges() + } + }, + ) + + HorizontalDivider(thickness = 2.dp, color = ruleStrong) + + // The big name collapses while the body editor has focus; kept visible while the name + // field itself holds focus so it stays reachable. + var nameFocused by remember { mutableStateOf(false) } + CollapseWhileTyping(keepVisible = nameFocused) { + NameZone( + entryNameText = entryNameText, + onNameChange = { entryNameText = it }, + editName = state.editName, + onStartEdit = component::startNameEdit, + onFocusChanged = { nameFocused = it }, + compact = isCompact, + sharedKey = "encyclopedia-title-${state.entryDef.id}", + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + ) + } + + val bodyOuterModifier = if (editing) Modifier.weight(1f) else Modifier + if (isCompact) { + CompactBody( + state = state, + entryText = entryText, + setEntryText = { entryText = it }, + onStartTextEdit = component::startTextEdit, + onShowDeleteImage = component::showDeleteImageDialog, + onAddImage = component::showAddImageDialog, + outerModifier = bodyOuterModifier, + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + ) + } else { + WideBody( + state = state, + entryText = entryText, + setEntryText = { entryText = it }, + onStartTextEdit = component::startTextEdit, + onShowDeleteImage = component::showDeleteImageDialog, + onAddImage = component::showAddImageDialog, + outerModifier = bodyOuterModifier, + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + ) + } + + if (!editing) { + if (content != null) { + ParticularsLedger( + state = state, + modifier = Modifier + .padding(horizontal = Ui.Padding.XXL) + .padding(top = 28.dp), + ) + } + + TagsAndAliasesZone( + state = state, + component = component, + compact = isCompact, + ) + + AppearsInZone( + state = state, + component = component, + ) + + FooterColophon( + compact = isCompact, + ruleSoft = ruleSoft, + ) + } + } } } @@ -425,14 +293,8 @@ internal fun ViewEntryUi( LaunchedEffect(state.showAddImageDialog) { if (state.showAddImageDialog) { - val file = try { + val file = retryingFileDialog { FileKit.openFilePicker(type = FileKitType.File(EncyclopediaDatasource.IMAGE_EXTENSIONS)) - } catch (e: FileKitPickerException) { - Napier.e("Image picker failed", e) - rootSnackbar.showSnackbar( - strRes.get(Res.string.encyclopedia_create_entry_image_load_failed) - ) - null } if (file != null) { if (file.size() > EncyclopediaDatasource.MAX_IMAGE_SIZE_BYTES) { @@ -744,7 +606,6 @@ private fun WideBody( entryText = entryText, setEntryText = setEntryText, onStartTextEdit = onStartTextEdit, - enableSpellChecking = state.spellCheckAllowed, modifier = Modifier.weight(1f).fillMaxHeight(), sharedKey = "encyclopedia-text-${state.entryDef.id}", animatedVisibilityScope = animatedVisibilityScope, @@ -813,7 +674,6 @@ private fun CompactBody( entryText = entryText, setEntryText = setEntryText, onStartTextEdit = onStartTextEdit, - enableSpellChecking = state.spellCheckAllowed, modifier = if (editing) Modifier.fillMaxWidth().weight(1f) else Modifier.fillMaxWidth(), sharedKey = "encyclopedia-text-${state.entryDef.id}", animatedVisibilityScope = animatedVisibilityScope, @@ -829,7 +689,6 @@ private fun BodyTextZone( entryText: String, setEntryText: (String) -> Unit, onStartTextEdit: () -> Unit, - enableSpellChecking: Boolean, modifier: Modifier, sharedKey: String, animatedVisibilityScope: AnimatedVisibilityScope, @@ -846,7 +705,6 @@ private fun BodyTextZone( MarkdownEditField( initialMarkdown = entryText, onMarkdownChanged = setEntryText, - enableSpellChecking = enableSpellChecking, contentPadding = PaddingValues(Ui.Padding.XL), modifier = Modifier .fillMaxWidth() @@ -1046,28 +904,6 @@ private fun TagsAndAliasesZone( } } -@Composable -private fun DictionaryToggleZone( - state: ViewEntry.State, - component: ViewEntry, - scope: CoroutineScope, -) { - if (!state.dictionaryFeatureEnabled) return - val content = state.content ?: return - HdHairlineToggleRow( - checked = !content.excludeFromDictionary, - label = Res.string.encyclopedia_entry_dictionary_toggle_label.get(), - hint = Res.string.encyclopedia_entry_dictionary_toggle_hint.get(), - onCheckedChange = { include -> - scope.launch { component.setExcludeFromDictionary(!include) } - }, - modifier = Modifier - .padding(horizontal = Ui.Padding.XXL) - .padding(top = 28.dp) - .fillMaxWidth(), - ) -} - @OptIn(ExperimentalLayoutApi::class) @Composable private fun TagsSection( @@ -1279,20 +1115,22 @@ private fun TagAddDialog( ) { var newTagsText by rememberSaveable { mutableStateOf("") } val existingTags = state.content?.tags.orEmpty() - val suggestions = rememberTagSuggestions(newTagsText, existingTags, component::suggestTags) + val suggestions = remember(newTagsText, existingTags) { + val prefix = newTagsText.substringAfterLast(' ').trim().removePrefix("#") + if (prefix.isEmpty()) emptyList() + else component.suggestTags(prefix).filter { it !in existingTags } + } Column(verticalArrangement = Arrangement.spacedBy(Ui.Padding.L)) { HdHairlineField( label = Res.string.encyclopedia_create_entry_tags_label.get(), value = newTagsText, onValueChange = { newTagsText = it }, - capitalization = KeyboardCapitalization.None, - autoCorrectEnabled = false, ) HdTagSuggestionStrip( suggestions = suggestions, onSelect = { tag -> scope.launch { - component.addTags(replaceTagPrefix(newTagsText, tag)) + component.addTags(tag) withContext(mainDispatcher) { newTagsText = "" } } }, diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/BrowseNotesUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/BrowseNotesUi.kt index 5ea21e94c..e4f52ac68 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/BrowseNotesUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/BrowseNotesUi.kt @@ -22,7 +22,6 @@ import androidx.compose.foundation.layout.width import androidx.compose.foundation.lazy.staggeredgrid.LazyVerticalStaggeredGrid import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridCells import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridItemSpan -import androidx.compose.foundation.lazy.staggeredgrid.rememberLazyStaggeredGridState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Create import androidx.compose.material.icons.filled.Search @@ -34,7 +33,7 @@ import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.material3.TopAppBarDefaults import androidx.compose.material3.rememberTopAppBarState -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.derivedStateOf import androidx.compose.runtime.getValue @@ -52,7 +51,6 @@ import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.notes.BrowseNotes import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarStaggeredGrid import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdActiveFiltersStrip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCollapsingStrip @@ -68,9 +66,7 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSortOption import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagFilterBar import com.darkrockstudios.apps.hammer.common.compose.firstNonBlankLine import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent -import com.darkrockstudios.apps.hammer.common.data.search.markdownContains import com.darkrockstudios.apps.hammer.common.util.format import com.darkrockstudios.apps.hammer.notes_create_note_button import com.darkrockstudios.apps.hammer.notes_filter_all @@ -114,10 +110,6 @@ private enum class NotesSortMode( TitleAsc(Res.string.notes_sort_title_az, Res.string.notes_sort_glyph_title_az), } -/** A note matches on its body, read as prose rather than as stored Markdown. */ -internal fun noteMatchesQuery(note: NoteContent, query: String): Boolean = - markdownContains(note.content, query) - private fun NoteContent.wordCount(): Int = content.split(Regex("\\s+")).count { it.isNotBlank() } @@ -166,8 +158,7 @@ fun BrowseNotesUi( val byText = if (searchQuery.isBlank()) { state.notes } else { - val query = searchQuery.trim() - state.notes.filter { noteMatchesQuery(it, query) } + state.notes.filter { it.content.contains(searchQuery.trim(), ignoreCase = true) } } val byTags = if (activeTags.isEmpty()) { byText @@ -335,55 +326,46 @@ fun BrowseNotesUi( ) } - val gridState = rememberLazyStaggeredGridState() - Box(modifier = Modifier.weight(1f)) { - LazyVerticalStaggeredGrid( - state = gridState, - columns = StaggeredGridCells.Adaptive(400.dp), - modifier = Modifier.fillMaxSize(), - contentPadding = PaddingValues( - horizontal = Ui.Padding.XL, - vertical = Ui.Padding.L, - ), - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - if (visibleNotes.isEmpty()) { - item(span = StaggeredGridItemSpan.FullLine) { - Box( - modifier = Modifier - .fillMaxWidth() - .padding(vertical = Ui.Padding.XXL), - contentAlignment = Alignment.Center, - ) { - Text( - text = Res.string.notes_list_empty.get(), - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } + LazyVerticalStaggeredGrid( + columns = StaggeredGridCells.Adaptive(400.dp), + modifier = Modifier.fillMaxSize(), + contentPadding = PaddingValues( + horizontal = Ui.Padding.XL, + vertical = Ui.Padding.L, + ), + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), + ) { + if (visibleNotes.isEmpty()) { + item(span = StaggeredGridItemSpan.FullLine) { + Box( + modifier = Modifier + .fillMaxWidth() + .padding(vertical = Ui.Padding.XXL), + contentAlignment = Alignment.Center, + ) { + Text( + text = Res.string.notes_list_empty.get(), + style = MaterialTheme.typography.headlineSmall, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) } } - - staggeredItems( - items = visibleNotes, - key = { note -> note.id }, - ) { note -> - NoteCard( - note = note, - activeTags = activeTags, - onTagClick = toggleTag, - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - modifier = Modifier.padding(bottom = Ui.Padding.L), - onClick = { component.viewNote(note.id) }, - ) - } } - MpScrollBarStaggeredGrid( - modifier = scrollBarOverlay(), - state = gridState, - ) + staggeredItems( + items = visibleNotes, + key = { note -> note.id }, + ) { note -> + NoteCard( + note = note, + activeTags = activeTags, + onTagClick = toggleTag, + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + modifier = Modifier.padding(bottom = Ui.Padding.L), + onClick = { component.viewNote(note.id) }, + ) + } } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/CreateNoteUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/CreateNoteUi.kt index fdb605727..30274dd04 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/CreateNoteUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/CreateNoteUi.kt @@ -22,7 +22,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineTag import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSectionHeader import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownEditField -import com.darkrockstudios.apps.hammer.common.compose.rememberSaveableStringList import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.data.notesrepository.NoteError import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesRepository @@ -47,7 +46,7 @@ fun CreateNoteUi( val strRes = rememberStrRes() var newNoteError by remember { mutableStateOf(false) } var resetVersion by remember { mutableStateOf(0) } - val tags = rememberSaveableStringList() + val tags = remember { mutableStateListOf() } val wordCount = remember(noteText) { noteText.split(Regex("\\s+")).count { it.isNotBlank() } @@ -116,7 +115,6 @@ fun CreateNoteUi( MarkdownEditField( initialMarkdown = noteText, onMarkdownChanged = { component.onTextChanged(it) }, - enableSpellChecking = state.spellCheckAllowed, contentPadding = PaddingValues(Ui.Padding.XL), testTag = NOTES_CREATE_BODY_TAG, modifier = Modifier diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/ViewNoteUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/ViewNoteUi.kt index e9ea4c67c..93cfe45f8 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/ViewNoteUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/notes/ViewNoteUi.kt @@ -128,7 +128,6 @@ fun ViewNoteUi( noteText = noteText, onNoteTextChanged = { component.onContentChanged(it) }, suggestTags = component::suggestTags, - enableSpellChecking = state.spellCheckAllowed, modifier = Modifier.weight(1f), ) @@ -315,59 +314,52 @@ private fun ViewBody( modifier: Modifier = Modifier, ) { val scrollState = rememberScrollState() - Box(modifier = modifier) { - Column( - modifier = Modifier - .fillMaxWidth() - .verticalScroll(scrollState) - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), - ) { - val noteTags = note?.tags - if (!noteTags.isNullOrEmpty()) { - FlowRow( - modifier = Modifier - .fillMaxWidth() - .padding(bottom = Ui.Padding.L), - horizontalArrangement = Arrangement.spacedBy(6.dp), - verticalArrangement = Arrangement.spacedBy(6.dp), - ) { - noteTags.sorted().forEach { tag -> - HdTagChip( - label = tag, - active = true, - onClick = { onTagClick(tag) }, - onRemove = { onTagRemove(tag) }, - ) - } + Column( + modifier = modifier + .fillMaxWidth() + .verticalScroll(scrollState) + .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), + ) { + val noteTags = note?.tags + if (!noteTags.isNullOrEmpty()) { + FlowRow( + modifier = Modifier + .fillMaxWidth() + .padding(bottom = Ui.Padding.L), + horizontalArrangement = Arrangement.spacedBy(6.dp), + verticalArrangement = Arrangement.spacedBy(6.dp), + ) { + noteTags.sorted().forEach { tag -> + HdTagChip( + label = tag, + active = true, + onClick = { onTagClick(tag) }, + onRemove = { onTagRemove(tag) }, + ) } - - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - modifier = Modifier.padding(bottom = Ui.Padding.L), - ) } - with(sharedTransitionScope) { - MarkdownView( - markdown = noteText, - modifier = Modifier - .fillMaxWidth() - .sharedElement( - sharedContentState = rememberSharedContentState( - key = "note-content-${note?.id}", - ), - animatedVisibilityScope = animatedVisibilityScope, - ) - .clickable(onClick = onEnterEdit), - ) - } + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + modifier = Modifier.padding(bottom = Ui.Padding.L), + ) } - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, - ) + with(sharedTransitionScope) { + MarkdownView( + markdown = noteText, + modifier = Modifier + .fillMaxWidth() + .sharedElement( + sharedContentState = rememberSharedContentState( + key = "note-content-${note?.id}", + ), + animatedVisibilityScope = animatedVisibilityScope, + ) + .clickable(onClick = onEnterEdit), + ) + } } } @@ -378,7 +370,6 @@ private fun EditBody( noteText: String, onNoteTextChanged: (String) -> Unit, suggestTags: (prefix: String) -> List, - enableSpellChecking: Boolean, modifier: Modifier = Modifier, ) { Column(modifier = modifier.fillMaxWidth()) { @@ -405,7 +396,6 @@ private fun EditBody( MarkdownEditField( initialMarkdown = noteText, onMarkdownChanged = onNoteTextChanged, - enableSpellChecking = enableSpellChecking, contentPadding = PaddingValues(Ui.Padding.XL), modifier = Modifier .fillMaxWidth() diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportOptionsDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportOptionsDialog.kt index fd9b11a69..3900d3f79 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportOptionsDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportOptionsDialog.kt @@ -9,12 +9,6 @@ import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.height import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.widthIn -import androidx.compose.foundation.lazy.items -import androidx.compose.foundation.rememberScrollState -import androidx.compose.foundation.selection.toggleable -import androidx.compose.foundation.verticalScroll -import androidx.compose.material.icons.Icons -import androidx.compose.material.icons.filled.Folder import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Surface @@ -27,8 +21,6 @@ import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.semantics.Role import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.Res @@ -36,29 +28,19 @@ import com.darkrockstudios.apps.hammer.common.compose.AnimatedDialog import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdButtonBar import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineCheckbox import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineDropdown import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHelpButton import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMasthead import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMastheadAction -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPickerList -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPickerRow import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.data.ExportFont import com.darkrockstudios.apps.hammer.common.data.ExportFormat import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene -import com.darkrockstudios.apps.hammer.project_home_export_blank_lines_hint -import com.darkrockstudios.apps.hammer.project_home_export_blank_lines_label import com.darkrockstudios.apps.hammer.project_home_export_cancel import com.darkrockstudios.apps.hammer.project_home_export_chapters_label import com.darkrockstudios.apps.hammer.project_home_export_close import com.darkrockstudios.apps.hammer.project_home_export_dialog_title import com.darkrockstudios.apps.hammer.project_home_export_execute -import com.darkrockstudios.apps.hammer.project_home_export_font_label import com.darkrockstudios.apps.hammer.project_home_export_format_docx import com.darkrockstudios.apps.hammer.project_home_export_format_epub import com.darkrockstudios.apps.hammer.project_home_export_format_label @@ -66,54 +48,125 @@ import com.darkrockstudios.apps.hammer.project_home_export_format_markdown import com.darkrockstudios.apps.hammer.project_home_export_format_pdf import com.darkrockstudios.apps.hammer.project_home_export_format_rtf import com.darkrockstudios.apps.hammer.project_home_export_help_icon_description -import com.darkrockstudios.apps.hammer.project_home_export_limit_scenes_hint -import com.darkrockstudios.apps.hammer.project_home_export_limit_scenes_label -import com.darkrockstudios.apps.hammer.project_home_export_number_chapters_label -import com.darkrockstudios.apps.hammer.project_home_export_scenes_clear_all -import com.darkrockstudios.apps.hammer.project_home_export_scenes_label -import com.darkrockstudios.apps.hammer.project_home_export_scenes_select_all -import com.darkrockstudios.apps.hammer.project_home_export_scenes_selected import com.darkrockstudios.apps.hammer.project_home_export_section import org.jetbrains.compose.resources.StringResource private val DialogMaxWidth = 520.dp -internal fun exportSceneRowTag(id: Int) = "export-scene-row-$id" -internal fun exportGroupRowTag(id: Int) = "export-group-row-$id" -internal const val EXPORT_SCENE_MASTER_TOGGLE_TAG = "export-scene-master-toggle" - -/** - * Fully controlled: all option state lives in the component's retained state so - * in-dialog edits survive configuration changes (see issue #885). - */ @Composable fun ExportOptionsDialog( visible: Boolean, - options: ExportOptions, - exportableScenes: List, - onOptionsChanged: (ExportOptions) -> Unit, + initialOptions: ExportOptions, onCancel: () -> Unit, onConfirm: (ExportOptions) -> Unit, - onDismissed: () -> Unit = {}, working: Boolean = false, ) { + var treatAsChapters by remember(initialOptions, visible) { + mutableStateOf(initialOptions.treatTopLevelAsChapters) + } + var format by remember(initialOptions, visible) { + mutableStateOf(initialOptions.format) + } var showHelp by remember { mutableStateOf(false) } AnimatedDialog( visible = visible, onCloseRequest = { if (!working) onCancel() }, dismissOnTapOutside = !working, - onDismissed = onDismissed, ) { - ExportOptionsDialogContent( - options = options, - exportableScenes = exportableScenes, - onOptionsChanged = onOptionsChanged, - onCancel = onCancel, - onConfirm = onConfirm, - onShowHelp = { showHelp = true }, - working = working, - ) + Surface( + modifier = Modifier + .padding(Ui.Padding.M) + .widthIn(max = DialogMaxWidth) + .fillMaxWidth(), + shape = RectangleShape, + color = MaterialTheme.colorScheme.surface, + contentColor = MaterialTheme.colorScheme.onSurface, + border = BorderStroke( + width = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ), + ) { + Column { + HdMasthead( + section = Res.string.project_home_export_section.get(), + trailing = { + HdHelpButton( + onClick = { showHelp = true }, + contentDescription = Res.string.project_home_export_help_icon_description.get(), + ) + HdMastheadAction( + label = Res.string.project_home_export_close.get(), + onClick = { if (!working) onCancel() }, + ) + }, + ) + HdFolioDivider() + + Row( + modifier = Modifier + .fillMaxWidth() + .padding( + start = Ui.Padding.XL, + end = Ui.Padding.XL, + top = Ui.Padding.L, + bottom = Ui.Padding.M, + ), + verticalAlignment = Alignment.CenterVertically, + ) { + Text( + text = Res.string.project_home_export_dialog_title.get(), + style = MaterialTheme.typography.headlineSmall, + color = MaterialTheme.colorScheme.onSurface, + ) + } + + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + + Column( + modifier = Modifier.padding( + horizontal = Ui.Padding.XL, + vertical = Ui.Padding.XL, + ), + verticalArrangement = Arrangement.spacedBy(Ui.Padding.XL), + ) { + HdHairlineToggleRow( + checked = treatAsChapters, + onCheckedChange = { treatAsChapters = it }, + label = Res.string.project_home_export_chapters_label.get(), + ) + + HdHairlineDropdown( + title = Res.string.project_home_export_format_label.get(), + options = AVAILABLE_EXPORT_FORMATS, + selected = format, + onSelect = { format = it }, + label = { (it.labelRes()).get() }, + ) + } + + Spacer(modifier = Modifier.height(Ui.Padding.M)) + + HdButtonBar( + cancelLabel = Res.string.project_home_export_cancel.get(), + primaryLabel = Res.string.project_home_export_execute.get(), + onCancel = onCancel, + onPrimary = { + onConfirm( + ExportOptions( + treatTopLevelAsChapters = treatAsChapters, + format = format, + ) + ) + }, + primaryLoading = working, + cancelEnabled = !working, + ) + } + } } if (showHelp) { @@ -121,270 +174,6 @@ fun ExportOptionsDialog( } } -@Composable -internal fun ExportOptionsDialogContent( - options: ExportOptions, - exportableScenes: List, - onOptionsChanged: (ExportOptions) -> Unit, - onCancel: () -> Unit, - onConfirm: (ExportOptions) -> Unit, - onShowHelp: () -> Unit, - working: Boolean = false, -) { - val allSceneIds = remember(exportableScenes) { allSceneIds(exportableScenes) } - - Surface( - modifier = Modifier - .padding(Ui.Padding.M) - .widthIn(max = DialogMaxWidth) - .fillMaxWidth(), - shape = RectangleShape, - color = MaterialTheme.colorScheme.surface, - contentColor = MaterialTheme.colorScheme.onSurface, - border = BorderStroke( - width = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ), - ) { - Column { - HdMasthead( - section = Res.string.project_home_export_section.get(), - trailing = { - HdHelpButton( - onClick = onShowHelp, - contentDescription = Res.string.project_home_export_help_icon_description.get(), - ) - HdMastheadAction( - label = Res.string.project_home_export_close.get(), - onClick = { if (!working) onCancel() }, - ) - }, - ) - HdFolioDivider() - - Row( - modifier = Modifier - .fillMaxWidth() - .padding( - start = Ui.Padding.XL, - end = Ui.Padding.XL, - top = Ui.Padding.L, - bottom = Ui.Padding.M, - ), - verticalAlignment = Alignment.CenterVertically, - ) { - Text( - text = Res.string.project_home_export_dialog_title.get(), - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onSurface, - ) - } - - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - - Column( - modifier = Modifier - // Short screens and large font scales must scroll the options rather - // than push the button bar off-screen. - .weight(1f, fill = false) - .verticalScroll(rememberScrollState()) - .padding( - horizontal = Ui.Padding.XL, - vertical = Ui.Padding.XL, - ), - verticalArrangement = Arrangement.spacedBy(Ui.Padding.XL), - ) { - HdHairlineToggleRow( - checked = options.treatTopLevelAsChapters, - onCheckedChange = { onOptionsChanged(options.copy(treatTopLevelAsChapters = it)) }, - label = Res.string.project_home_export_chapters_label.get(), - ) - - HdHairlineDropdown( - title = Res.string.project_home_export_format_label.get(), - options = AVAILABLE_EXPORT_FORMATS, - selected = options.format, - onSelect = { onOptionsChanged(options.copy(format = it)) }, - label = { (it.labelRes()).get() }, - ) - - if (options.numbersChapters) { - HdHairlineToggleRow( - checked = options.numberChapters, - onCheckedChange = { onOptionsChanged(options.copy(numberChapters = it)) }, - label = Res.string.project_home_export_number_chapters_label.get(), - ) - } - - if (options.format in FONT_EXPORT_FORMATS) { - HdHairlineDropdown( - title = Res.string.project_home_export_font_label.get(), - options = ExportFont.entries, - selected = options.font, - onSelect = { onOptionsChanged(options.copy(font = it)) }, - label = { it.faceName }, - ) - } - - if (options.format != ExportFormat.Markdown) { - HdHairlineToggleRow( - checked = options.keepBlankLines, - onCheckedChange = { onOptionsChanged(options.copy(keepBlankLines = it)) }, - label = Res.string.project_home_export_blank_lines_label.get(), - hint = Res.string.project_home_export_blank_lines_hint.get(), - ) - } - - if (allSceneIds.isNotEmpty()) { - HdHairlineToggleRow( - checked = options.sceneIds != null, - onCheckedChange = { limit -> - onOptionsChanged(options.copy(sceneIds = if (limit) emptySet() else null)) - }, - label = Res.string.project_home_export_limit_scenes_label.get(), - hint = Res.string.project_home_export_limit_scenes_hint.get(), - ) - - val selectedIds = options.sceneIds - if (selectedIds != null) { - ExportSceneSelector( - entries = exportableScenes, - allIds = allSceneIds, - selected = selectedIds, - onSelectionChanged = { onOptionsChanged(options.copy(sceneIds = it)) }, - ) - } - } - } - - Spacer(modifier = Modifier.height(Ui.Padding.M)) - - HdButtonBar( - cancelLabel = Res.string.project_home_export_cancel.get(), - primaryLabel = Res.string.project_home_export_execute.get(), - onCancel = onCancel, - onPrimary = { - // Selecting every scene means no limit at all: exporting the full story - // keeps empty chapter groups instead of silently dropping them. - val selectedIds = options.sceneIds - val confirmed = if (selectedIds != null && isFullSelection(exportableScenes, selectedIds)) { - options.copy(sceneIds = null) - } else { - options - } - onConfirm(confirmed) - }, - primaryLoading = working, - primaryEnabled = options.sceneIds?.isNotEmpty() ?: true, - cancelEnabled = !working, - ) - } - } -} - -@Composable -private fun ExportSceneSelector( - entries: List, - allIds: Set, - selected: Set, - onSelectionChanged: (Set) -> Unit, -) { - val allSelected = allIds.isNotEmpty() && selected.containsAll(allIds) - - Column(verticalArrangement = Arrangement.spacedBy(Ui.Padding.M)) { - Row( - modifier = Modifier.fillMaxWidth(), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), - ) { - HdMonoLabel(text = Res.string.project_home_export_scenes_label.get()) - Text( - text = Res.string.project_home_export_scenes_selected.get(selected.size, allIds.size), - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier.weight(1f), - ) - HdHairlineButton( - label = if (allSelected) { - Res.string.project_home_export_scenes_clear_all.get() - } else { - Res.string.project_home_export_scenes_select_all.get() - }, - onClick = { onSelectionChanged(if (allSelected) emptySet() else allIds) }, - modifier = Modifier.testTag(EXPORT_SCENE_MASTER_TOGGLE_TAG), - ) - } - - HdPickerList { - items(items = entries, key = { it.id }) { entry -> - if (entry.isGroup) { - ExportGroupRow( - entry = entry, - fullySelected = isGroupFullySelected(entries, selected, entry), - hasScenes = descendantSceneIds(entries, entry).isNotEmpty(), - onToggle = { onSelectionChanged(toggleGroup(entries, selected, entry)) }, - ) - } else { - ExportSceneRow( - entry = entry, - isSelected = entry.id in selected, - onToggle = { onSelectionChanged(toggleScene(selected, entry.id)) }, - ) - } - } - } - } -} - -@Composable -private fun ExportGroupRow( - entry: ExportableScene, - fullySelected: Boolean, - hasScenes: Boolean, - onToggle: () -> Unit, -) { - val interaction = if (hasScenes) { - Modifier.toggleable( - value = fullySelected, - role = Role.Checkbox, - onValueChange = { onToggle() }, - ) - } else { - // Nothing beneath it to select; an inert checkbox would just mislead. - Modifier - } - HdPickerRow( - label = entry.name, - depth = entry.depth, - icon = Icons.Filled.Folder, - modifier = interaction.testTag(exportGroupRowTag(entry.id)), - trailing = { if (hasScenes) HdHairlineCheckbox(checked = fullySelected) }, - ) -} - -@Composable -private fun ExportSceneRow( - entry: ExportableScene, - isSelected: Boolean, - onToggle: () -> Unit, -) { - HdPickerRow( - label = entry.name, - depth = entry.depth, - modifier = Modifier - .toggleable( - value = isSelected, - role = Role.Checkbox, - onValueChange = { onToggle() }, - ) - .testTag(exportSceneRowTag(entry.id)), - trailing = { HdHairlineCheckbox(checked = isSelected) }, - ) -} - private val AVAILABLE_EXPORT_FORMATS = listOf( ExportFormat.Epub, @@ -394,16 +183,6 @@ private val AVAILABLE_EXPORT_FORMATS = ExportFormat.Markdown, ) -/** PDF renders in its library's built-in face, and Markdown carries no font. */ -private val FONT_EXPORT_FORMATS = setOf(ExportFormat.Epub, ExportFormat.Docx, ExportFormat.Rtf) - -/** Markdown only has chapter headings in chapter mode. */ -private val ExportOptions.numbersChapters: Boolean - get() = when (format) { - ExportFormat.Markdown -> treatTopLevelAsChapters - else -> true - } - private fun ExportFormat.labelRes(): StringResource = when (this) { ExportFormat.Markdown -> Res.string.project_home_export_format_markdown ExportFormat.Epub -> Res.string.project_home_export_format_epub diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportSceneSelection.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportSceneSelection.kt deleted file mode 100644 index 9d9f95c23..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportSceneSelection.kt +++ /dev/null @@ -1,54 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projecthome - -import com.darkrockstudios.apps.hammer.common.data.ExportableScene - -/** Every selectable (leaf scene) id in [entries]. */ -internal fun allSceneIds(entries: List): Set = - entries.filterNot { it.isGroup }.map { it.id }.toSet() - -/** - * Scene ids of every descendant of [group]: the contiguous entries following it - * while their depth stays greater than the group's. - */ -internal fun descendantSceneIds(entries: List, group: ExportableScene): List { - val start = entries.indexOf(group) + 1 - if (start <= 0) return emptyList() - return entries.asSequence() - .drop(start) - .takeWhile { it.depth > group.depth } - .filterNot { it.isGroup } - .map { it.id } - .toList() -} - -internal fun isGroupFullySelected( - entries: List, - selected: Set, - group: ExportableScene, -): Boolean { - val ids = descendantSceneIds(entries, group) - return ids.isNotEmpty() && selected.containsAll(ids) -} - -/** True when [selected] covers every leaf scene in [entries] and there is at least one. */ -internal fun isFullSelection(entries: List, selected: Set): Boolean { - val all = allSceneIds(entries) - return all.isNotEmpty() && selected.containsAll(all) -} - -internal fun toggleScene(selected: Set, id: Int): Set = - if (id in selected) selected - id else selected + id - -/** - * Group rows act as select-all/clear toggles for their subtree; a partially - * selected group toggles to fully selected. An empty group is inert. - */ -internal fun toggleGroup( - entries: List, - selected: Set, - group: ExportableScene, -): Set { - val ids = descendantSceneIds(entries, group) - if (ids.isEmpty()) return selected - return if (selected.containsAll(ids)) selected - ids.toSet() else selected + ids -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectInfoSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectInfoSettingsUi.kt index 915b8c3d8..182062c25 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectInfoSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectInfoSettingsUi.kt @@ -10,7 +10,6 @@ import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.Spacer import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.heightIn import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.size import androidx.compose.foundation.layout.width @@ -30,8 +29,6 @@ import androidx.compose.ui.graphics.Color import androidx.compose.ui.graphics.RectangleShape import androidx.compose.ui.text.input.ImeAction import androidx.compose.ui.text.input.KeyboardCapitalization -import androidx.compose.ui.text.input.KeyboardType -import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState @@ -48,7 +45,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineSeg import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineTagField import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchableListDialog import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.theme.parseHexColor import com.darkrockstudios.apps.hammer.common.compose.theme.toArgbHex @@ -56,13 +52,6 @@ import com.darkrockstudios.apps.hammer.project_info_author_label import com.darkrockstudios.apps.hammer.project_info_color_picker_cancel import com.darkrockstudios.apps.hammer.project_info_color_picker_confirm import com.darkrockstudios.apps.hammer.project_info_color_picker_edit -import com.darkrockstudios.apps.hammer.project_info_language_clear -import com.darkrockstudios.apps.hammer.project_info_language_dialog_close -import com.darkrockstudios.apps.hammer.project_info_language_dialog_title -import com.darkrockstudios.apps.hammer.project_info_language_empty -import com.darkrockstudios.apps.hammer.project_info_language_label -import com.darkrockstudios.apps.hammer.project_info_language_search_hint -import com.darkrockstudios.apps.hammer.project_info_language_unset import com.darkrockstudios.apps.hammer.project_info_tags_hint import com.darkrockstudios.apps.hammer.project_info_tags_label import com.darkrockstudios.apps.hammer.project_info_tags_placeholder @@ -108,78 +97,6 @@ internal fun AuthorField( ) } -@Composable -internal fun LanguageField( - languageTag: String?, - options: List, - onChange: (String?) -> Unit, - modifier: Modifier = Modifier, -) { - var showPicker by remember { mutableStateOf(false) } - val selected = options.firstOrNull { it.tag == languageTag } - val displayName = selected?.displayName ?: languageTag - - Column( - modifier = modifier, - verticalArrangement = Arrangement.spacedBy(8.dp), - ) { - HdMonoLabel(text = Res.string.project_info_language_label.get()) - Row( - modifier = Modifier - .fillMaxWidth() - .heightIn(min = 36.dp) - .border( - width = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - shape = RectangleShape, - ) - .clickable { showPicker = true } - .padding(horizontal = Ui.Padding.M, vertical = 6.dp), - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.S), - ) { - Text( - text = displayName ?: Res.string.project_info_language_unset.get(), - style = MaterialTheme.typography.bodyMedium, - color = if (displayName != null) { - MaterialTheme.colorScheme.onSurface - } else { - MaterialTheme.colorScheme.onSurfaceVariant - }, - maxLines = 1, - overflow = TextOverflow.Ellipsis, - modifier = Modifier.weight(1f), - ) - if (languageTag != null) { - HdMonoLabel( - text = languageTag.uppercase(), - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - HdMonoLabel( - text = "▾", - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - } - - HdSearchableListDialog( - visible = showPicker, - title = Res.string.project_info_language_dialog_title.get(), - items = options, - itemLabel = { it.displayName }, - itemTrailing = { it.tag.uppercase() }, - itemKey = { it.tag }, - onSelect = { onChange(it.tag) }, - onDismiss = { showPicker = false }, - closeContentDescription = Res.string.project_info_language_dialog_close.get(), - searchPlaceholder = Res.string.project_info_language_search_hint.get(), - clearLabel = Res.string.project_info_language_clear.get(), - onClear = { onChange(null) }, - emptyLabel = Res.string.project_info_language_empty.get(), - ) -} - @Composable internal fun CustomThemeSection( section: Int, @@ -295,7 +212,6 @@ internal fun WordCountGoalSection( onValueChange = { input -> if (enabled) count = input.filter(Char::isDigit) }, counter = "W", imeAction = ImeAction.Done, - keyboardType = KeyboardType.Number, ) HdHairlineSegmentedPicker( options = WordCountGoal.Cadence.entries, @@ -514,11 +430,6 @@ fun ProjectInfoSettingsUi(component: ProjectSettings) { initial = state.data.authorName.orEmpty(), onChange = component::setAuthorName, ) - LanguageField( - languageTag = state.data.language, - options = component.availableLanguages, - onChange = component::setProjectLanguage, - ) CustomThemeSection( section = 1, theme = state.data.theme, diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectSettingsUi.kt index 51271b95e..187b5d14c 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectSettingsUi.kt @@ -17,10 +17,9 @@ import androidx.compose.foundation.verticalScroll import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue -import androidx.compose.runtime.remember import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape @@ -30,38 +29,23 @@ import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.projecthome.ProjectSettings -import com.darkrockstudios.apps.hammer.common.components.spellchecksettings.SpellCheckSettings import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCrumbBackLink import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineSection -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineWordListField import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.common.projectselection.settings.SpellCheckSettingsContent -import com.darkrockstudios.apps.hammer.common.spellcheck.displayName -import com.darkrockstudios.apps.hammer.common.spellcheck.isSpellCheckAllowedForProject -import com.darkrockstudios.apps.hammer.common.spellcheck.normalizeDictionaryWord -import com.darkrockstudios.apps.hammer.common.util.Locale import com.darkrockstudios.apps.hammer.project_settings_autosaved import com.darkrockstudios.apps.hammer.project_settings_breadcrumb_home import com.darkrockstudios.apps.hammer.project_settings_breadcrumb_root -import com.darkrockstudios.apps.hammer.project_settings_dictionary_hint -import com.darkrockstudios.apps.hammer.project_settings_dictionary_label -import com.darkrockstudios.apps.hammer.project_settings_dictionary_placeholder import com.darkrockstudios.apps.hammer.project_settings_folio_caption import com.darkrockstudios.apps.hammer.project_settings_folio_section_count import com.darkrockstudios.apps.hammer.project_settings_hero_by import com.darkrockstudios.apps.hammer.project_settings_hero_marker import com.darkrockstudios.apps.hammer.project_settings_hero_no_author -import com.darkrockstudios.apps.hammer.project_settings_spellcheck_encyclopedia_enable -import com.darkrockstudios.apps.hammer.project_settings_spellcheck_encyclopedia_enable_hint -import com.darkrockstudios.apps.hammer.project_settings_spellcheck_mismatch_caption import com.darkrockstudios.apps.hammer.project_settings_spellcheck_section_title private val MaxColumnWidth = 880.dp @@ -91,67 +75,41 @@ fun ProjectSettingsUi( ) HdFolioDivider() - val scrollState = rememberScrollState() - Box( + Column( modifier = Modifier .weight(1f) - .fillMaxWidth(), + .fillMaxWidth() + .verticalScroll(rememberScrollState()) + .padding(horizontal = outerHorizontal, vertical = outerVertical), ) { - Column( + Box( modifier = Modifier - .fillMaxSize() - .verticalScroll(scrollState) - .padding(horizontal = outerHorizontal, vertical = outerVertical), + .widthIn(max = MaxColumnWidth) + .fillMaxWidth() + .align(Alignment.CenterHorizontally), ) { - Box( - modifier = Modifier - .widthIn(max = MaxColumnWidth) - .fillMaxWidth() - .align(Alignment.CenterHorizontally), - ) { - Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { - Hero( - projectName = component.projectName, - authorName = state.data.authorName, - isCompact = isCompact, - ) + Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { + Hero( + projectName = component.projectName, + authorName = state.data.authorName, + isCompact = isCompact, + ) - if (state.isLoaded) { - ProjectInfoSettingsUi(component) + if (state.isLoaded) { + ProjectInfoSettingsUi(component) - HdHairlineSection( - section = 4, - title = Res.string.project_settings_spellcheck_section_title.get(), - contentSpacing = 18.dp, - ) { - SpellCheckSettingsContent( - component.spellCheckSettings, - showEncyclopediaToggle = false, - ) - ProjectDictionaryToggle( - enabled = state.data.encyclopediaDictionary, - component = component, - ) - ProjectDictionaryWords( - words = state.data.dictionaryWords, - component = component, - ) - SpellCheckMismatchCaption( - projectLanguageTag = state.data.language, - spellCheckSettings = component.spellCheckSettings, - ) - } + HdHairlineSection( + section = 4, + title = Res.string.project_settings_spellcheck_section_title.get(), + contentSpacing = 18.dp, + ) { + SpellCheckSettingsContent(component.spellCheckSettings) } - - Spacer(Modifier.height(8.dp)) } + + Spacer(Modifier.height(8.dp)) } } - - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, - ) } FolioCaption( @@ -162,64 +120,6 @@ fun ProjectSettingsUi( } } -/** Per-project override for the global "learn encyclopedia names" feature. */ -@Composable -private fun ProjectDictionaryToggle( - enabled: Boolean, - component: ProjectSettings, -) { - val spellCheckState by component.spellCheckSettings.state.subscribeAsState() - if (!spellCheckState.spellCheckingEncyclopediaEnabled) return - - HdHairlineToggleRow( - checked = enabled, - label = Res.string.project_settings_spellcheck_encyclopedia_enable.get(), - hint = Res.string.project_settings_spellcheck_encyclopedia_enable_hint.get(), - enabled = spellCheckState.spellCheckingEnabled, - onCheckedChange = { component.setEncyclopediaDictionaryEnabled(it) }, - ) -} - -/** The user-added words this project's spell checker accepts, synced with the project. */ -@Composable -private fun ProjectDictionaryWords( - words: Set, - component: ProjectSettings, -) { - val sorted = remember(words) { words.sortedBy { it.lowercase() } } - HdHairlineWordListField( - label = Res.string.project_settings_dictionary_label.get(), - words = sorted, - onAdd = component::addDictionaryWord, - onRemove = component::removeDictionaryWord, - parseInput = ::normalizeDictionaryWord, - hint = Res.string.project_settings_dictionary_hint.get(), - placeholder = Res.string.project_settings_dictionary_placeholder.get(), - testTag = "project-settings-dictionary", - ) -} - -/** Explains why spell check isn't running when the project's language gates it off. */ -@Composable -private fun SpellCheckMismatchCaption( - projectLanguageTag: String?, - spellCheckSettings: SpellCheckSettings, -) { - val spellCheckState by spellCheckSettings.state.subscribeAsState() - if (!spellCheckState.spellCheckingEnabled) return - if (projectLanguageTag == null) return - if (isSpellCheckAllowedForProject(projectLanguageTag, spellCheckState.spellCheckingLanguage)) return - - Text( - text = Res.string.project_settings_spellcheck_mismatch_caption.get( - Locale.forLanguageTag(projectLanguageTag).displayName(), - spellCheckState.spellCheckingLanguage.displayName(), - ), - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) -} - @Composable private fun Breadcrumb( projectName: String, diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectStatsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectStatsUi.kt index 25fa5f322..c7bd7b1ab 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectStatsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ProjectStatsUi.kt @@ -36,10 +36,8 @@ import com.darkrockstudios.apps.hammer.common.components.projecthome.ProjectHome import com.darkrockstudios.apps.hammer.common.components.projecthome.TagBreakdown import com.darkrockstudios.apps.hammer.common.compose.HeaderUi import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.common.compose.theme.hammerMonoFontFamily import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType @@ -72,74 +70,60 @@ fun ProjectStatsUi( val state by component.state.subscribeAsState() val isWide = LocalScreenCharacteristic.current.isWide - val scrollState = rememberScrollState() - Box(modifier = modifier.fillMaxSize()) { - Column( - modifier = Modifier - .testTag(PROJECT_STATS_TAG) - .fillMaxSize() - .verticalScroll(scrollState) - .padding(horizontal = 24.dp, vertical = 16.dp), - verticalArrangement = Arrangement.spacedBy(20.dp), - ) { - DashboardHeader( - state = state, - component = component, - scope = scope, - ) + Column( + modifier = modifier + .testTag(PROJECT_STATS_TAG) + .fillMaxSize() + .verticalScroll(rememberScrollState()) + .padding(horizontal = 24.dp, vertical = 16.dp), + verticalArrangement = Arrangement.spacedBy(20.dp), + ) { + DashboardHeader( + state = state, + component = component, + scope = scope, + ) - if (state.isLoadingStats) { - LoadingRow() - } - - StatsStrip(state = state, isWide = isWide) - - StructureSection( - state = state, - isWide = isWide, - onShowLongestScene = component::showLongestScene, - onShowLastEditedScene = component::showLastEditedScene, - ) - - if (state.dailyWordTotals.isNotEmpty() || state.encyclopediaEntriesByType.isNotEmpty() || state.topAppearances.isNotEmpty()) { - InhabitantsSection( - state = state, - isWide = isWide, - onShowEntry = component::showEntry, - ) - } - - if (state.tagBreakdowns.isNotEmpty()) { - ThemesSection( - state = state, - isWide = isWide, - onTagClick = component::showGlobalSearchForTag, - ) - } - - if (state.wordsPerDevice.size >= 2) { - DevicesSection(state = state) - } + if (state.isLoadingStats) { + LoadingRow() } - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, + StatsStrip(state = state, isWide = isWide) + + StructureSection( + state = state, + isWide = isWide, + onShowLongestScene = component::showLongestScene, + onShowLastEditedScene = component::showLastEditedScene, ) + + if (state.dailyWordTotals.isNotEmpty() || state.encyclopediaEntriesByType.isNotEmpty() || state.topAppearances.isNotEmpty()) { + InhabitantsSection( + state = state, + isWide = isWide, + onShowEntry = component::showEntry, + ) + } + + if (state.tagBreakdowns.isNotEmpty()) { + ThemesSection( + state = state, + isWide = isWide, + onTagClick = component::showGlobalSearchForTag, + ) + } + + if (state.wordsPerDevice.size >= 2) { + DevicesSection(state = state) + } } ExportOptionsDialog( visible = state.showExportDialog, - options = state.exportOptions, - exportableScenes = state.exportableScenes, - onOptionsChanged = component::updateExportOptions, + initialOptions = state.exportOptions, onCancel = component::cancelExportDialog, onConfirm = component::confirmExportDialog, - onDismissed = component::exportDialogDismissed, - // The platform save dialog does not block this window on desktop, so the - // options must freeze once the picker is up or the written file's extension - // and contents could disagree. - working = state.isExporting || state.showExportFilePicker, + working = state.isExporting, ) ExportDirectoryPicker(state.showExportFilePicker, component, scope) } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ConfirmCloseDialogs.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ConfirmCloseDialogs.kt index 3ebcb4a2e..8ccaf312e 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ConfirmCloseDialogs.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ConfirmCloseDialogs.kt @@ -39,10 +39,7 @@ fun ConfirmUnsavedScenesDialog( } }, onDiscard = { - scope.launch { - component.discardUnsaved(CloseConfirm.Scenes) - component.closeRequestDealtWith(CloseConfirm.Scenes) - } + component.closeRequestDealtWith(CloseConfirm.Scenes) }, onCancel = { component.cancelCloseRequest() @@ -51,7 +48,7 @@ fun ConfirmUnsavedScenesDialog( } @Composable -fun ConfirmCloseUnsavedEncyclopediaDialog(component: ProjectRoot, scope: CoroutineScope) { +fun ConfirmCloseUnsavedEncyclopediaDialog(component: ProjectRoot) { SimpleConfirm( title = Res.string.unsaved_encyclopedia_dialog_title.get(), message = Res.string.unsaved_encyclopedia_dialog_message.get(), @@ -61,15 +58,12 @@ fun ConfirmCloseUnsavedEncyclopediaDialog(component: ProjectRoot, scope: Corouti component.cancelCloseRequest() } ) { - scope.launch { - component.discardUnsaved(CloseConfirm.Encyclopedia) - component.closeRequestDealtWith(CloseConfirm.Encyclopedia) - } + component.closeRequestDealtWith(CloseConfirm.Encyclopedia) } } @Composable -fun ConfirmCloseUnsavedNotesDialog(component: ProjectRoot, scope: CoroutineScope) { +fun ConfirmCloseUnsavedNotesDialog(component: ProjectRoot) { SimpleConfirm( title = Res.string.unsaved_notes_dialog_title.get(), message = Res.string.unsaved_notes_dialog_message.get(), @@ -79,15 +73,12 @@ fun ConfirmCloseUnsavedNotesDialog(component: ProjectRoot, scope: CoroutineScope component.cancelCloseRequest() } ) { - scope.launch { - component.discardUnsaved(CloseConfirm.Notes) - component.closeRequestDealtWith(CloseConfirm.Notes) - } + component.closeRequestDealtWith(CloseConfirm.Notes) } } @Composable -fun ConfirmCloseUnsavedTimelineDialog(component: ProjectRoot, scope: CoroutineScope) { +fun ConfirmCloseUnsavedTimelineDialog(component: ProjectRoot) { SimpleConfirm( title = Res.string.unsaved_timeline_dialog_title.get(), message = Res.string.unsaved_timeline_dialog_message.get(), @@ -97,9 +88,6 @@ fun ConfirmCloseUnsavedTimelineDialog(component: ProjectRoot, scope: CoroutineSc component.cancelCloseRequest() } ) { - scope.launch { - component.discardUnsaved(CloseConfirm.Timeline) - component.closeRequestDealtWith(CloseConfirm.Timeline) - } + component.closeRequestDealtWith(CloseConfirm.Timeline) } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootScaffold.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootScaffold.kt index 1396064e9..c2b828c01 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootScaffold.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootScaffold.kt @@ -1,13 +1,14 @@ package com.darkrockstudios.apps.hammer.common.projectroot -import androidx.compose.foundation.layout.BoxWithConstraints import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.WindowInsets import androidx.compose.foundation.layout.padding import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Scaffold import androidx.compose.material3.SnackbarHost -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.ExperimentalMaterial3WindowSizeClassApi +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.calculateWindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf @@ -22,7 +23,6 @@ import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.common.components.projectroot.CloseConfirm import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectRoot -import com.darkrockstudios.apps.hammer.common.compose.ProjectShortcutHost import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.defaultScaffold import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdBottomBar @@ -30,7 +30,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRail import com.darkrockstudios.apps.hammer.common.compose.fab import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.compose.rememberWindowSizeClass import com.darkrockstudios.apps.hammer.common.compose.rootElement import com.darkrockstudios.apps.hammer.common.compose.theme.ProjectThemeOverride import com.darkrockstudios.apps.hammer.common.util.getAppVersionString @@ -42,11 +41,11 @@ const val NAV_NOTES_TAG = "nav-Notes" const val NAV_ENCYCLOPEDIA_TAG = "nav-Encyclopedia" const val NAV_TIMELINE_TAG = "nav-TimeLine" +@OptIn(ExperimentalMaterial3WindowSizeClassApi::class) @Composable fun ProjectRootScaffold( component: ProjectRoot, onCloseRequest: () -> Unit, - shortcutHost: ProjectShortcutHost? = null, ) { val shouldConfirmClose by component.closeRequestHandlers.subscribeAsState() val themeState by component.projectTheme.subscribeAsState() @@ -54,21 +53,19 @@ fun ProjectRootScaffold( val coroutineScope = rememberCoroutineScope() ProjectThemeOverride(themeState.theme) { - BoxWithConstraints { - val windowSizeClass = rememberWindowSizeClass(constraints) - when (windowSizeClass.widthSizeClass) { - WindowWidthSizeClass.Compact -> CompactNavigation(component, rootSnackbar, shortcutHost) - WindowWidthSizeClass.Medium, - WindowWidthSizeClass.Expanded -> RailNavigation(component, rootSnackbar, shortcutHost) - } + val windowSizeClass = calculateWindowSizeClass() + when (windowSizeClass.widthSizeClass) { + WindowWidthSizeClass.Compact -> CompactNavigation(component, rootSnackbar) + WindowWidthSizeClass.Medium, + WindowWidthSizeClass.Expanded -> RailNavigation(component, rootSnackbar) } if (shouldConfirmClose.isNotEmpty()) { when (shouldConfirmClose.first()) { CloseConfirm.Scenes -> ConfirmUnsavedScenesDialog(component, coroutineScope) - CloseConfirm.Notes -> ConfirmCloseUnsavedNotesDialog(component, coroutineScope) - CloseConfirm.Encyclopedia -> ConfirmCloseUnsavedEncyclopediaDialog(component, coroutineScope) - CloseConfirm.Timeline -> ConfirmCloseUnsavedTimelineDialog(component, coroutineScope) + CloseConfirm.Notes -> ConfirmCloseUnsavedNotesDialog(component) + CloseConfirm.Encyclopedia -> ConfirmCloseUnsavedEncyclopediaDialog(component) + CloseConfirm.Timeline -> ConfirmCloseUnsavedTimelineDialog(component) CloseConfirm.Sync -> component.showProjectSync() CloseConfirm.Complete -> onCloseRequest() } @@ -80,7 +77,6 @@ fun ProjectRootScaffold( private fun CompactNavigation( component: ProjectRoot, rootSnackbar: RootSnackbarHostState, - shortcutHost: ProjectShortcutHost?, ) { val router by component.routerState.subscribeAsState() Scaffold( @@ -93,7 +89,6 @@ private fun CompactNavigation( rootSnackbar, modifier = Modifier.rootElement(scaffoldPadding), navWidth = 0.dp, - shortcutHost = shortcutHost, ) }, bottomBar = { @@ -115,7 +110,6 @@ private fun CompactNavigation( private fun RailNavigation( component: ProjectRoot, rootSnackbar: RootSnackbarHostState, - shortcutHost: ProjectShortcutHost?, ) { val router by component.routerState.subscribeAsState() val navRailState by component.navRailState.subscribeAsState() @@ -147,13 +141,7 @@ private fun RailNavigation( }, ) - ProjectRootUi( - component, - rootSnackbar, - navRailWidth, - Modifier.padding(scaffoldPadding), - shortcutHost = shortcutHost, - ) + ProjectRootUi(component, rootSnackbar, navRailWidth, Modifier.padding(scaffoldPadding)) } }, floatingActionButton = { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootUi.kt index 5610f09e2..fe7f006d0 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectroot/ProjectRootUi.kt @@ -4,7 +4,6 @@ import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.runtime.Composable -import androidx.compose.runtime.DisposableEffect import androidx.compose.runtime.getValue import androidx.compose.runtime.remember import androidx.compose.runtime.rememberCoroutineScope @@ -27,9 +26,10 @@ import com.darkrockstudios.apps.hammer.common.compose.SetScreenCharacteristics import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdBottomBarDestination import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRailDestination -import com.darkrockstudios.apps.hammer.common.compose.ProjectShortcutHost import com.darkrockstudios.apps.hammer.common.compose.rememberStrRes import com.darkrockstudios.apps.hammer.common.compose.resources.get +import com.darkrockstudios.apps.hammer.common.compose.saveAllShortcutModifier +import com.darkrockstudios.apps.hammer.common.compose.syncShortcutModifier import com.darkrockstudios.apps.hammer.common.encyclopedia.BrowseEntriesFab import com.darkrockstudios.apps.hammer.common.encyclopedia.EncyclopediaUi import com.darkrockstudios.apps.hammer.common.globalsearch.GlobalSearchUi @@ -89,29 +89,21 @@ fun ProjectRootUi( rootSnackbar: RootSnackbarHostState, navWidth: Dp = Dp.Unspecified, modifier: Modifier = Modifier, - shortcutHost: ProjectShortcutHost? = null, ) { val scope = rememberCoroutineScope() val strRes = rememberStrRes() - if (shortcutHost != null) { - DisposableEffect(shortcutHost, component, rootSnackbar, scope, strRes) { - shortcutHost.bind( - startSync = { component.startProjectSync() }, - saveAll = { + SetScreenCharacteristics(WIDE_SCREEN_THRESHOLD) { + FeatureContent( + modifier + .fillMaxSize() + .saveAllShortcutModifier { scope.launch { component.storeDirtyBuffers() rootSnackbar.showSnackbar(strRes.get(Res.string.save_all_toast)) } - }, - ) - onDispose { shortcutHost.unbind() } - } - } - - SetScreenCharacteristics(WIDE_SCREEN_THRESHOLD) { - FeatureContent( - modifier.fillMaxSize(), + } + .syncShortcutModifier { component.showProjectSync() }, component, rootSnackbar, navWidth, diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AppUpdateBanner.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AppUpdateBanner.kt deleted file mode 100644 index cc51235c2..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AppUpdateBanner.kt +++ /dev/null @@ -1,101 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projectselection - -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.about_update_available -import com.darkrockstudios.apps.hammer.about_update_checking -import com.darkrockstudios.apps.hammer.about_update_downloading -import com.darkrockstudios.apps.hammer.about_update_failed -import com.darkrockstudios.apps.hammer.about_update_install_button -import com.darkrockstudios.apps.hammer.about_update_installing -import com.darkrockstudios.apps.hammer.about_update_later_button -import com.darkrockstudios.apps.hammer.about_update_quit_notice -import com.darkrockstudios.apps.hammer.about_update_retry_button -import com.darkrockstudios.apps.hammer.about_update_up_to_date -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNoticeStrip -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.update_dialog_open_release_button -import kotlin.math.roundToInt - -private const val PERCENT = 100f - -/** "42%" for a 0..1 fraction; built here so the string resource needs no escaped percent sign. */ -fun percentLabel(fraction: Float): String = "${(fraction * PERCENT).roundToInt()}%" - -/** - * The one-line description of an update state, shared by the project-list banner and the - * About screen row, or null when there is nothing to say. - */ -@Composable -fun appUpdateDescription(state: AppUpdateState): String? = when (state) { - AppUpdateState.Checking -> Res.string.about_update_checking.get() - AppUpdateState.UpToDate -> Res.string.about_update_up_to_date.get() - is AppUpdateState.Available -> Res.string.about_update_available.get(state.version) - is AppUpdateState.Downloading -> - Res.string.about_update_downloading.get(state.version, percentLabel(state.fraction)) - - is AppUpdateState.Installing -> Res.string.about_update_installing.get(state.version) - is AppUpdateState.Failed -> Res.string.about_update_failed.get(state.version, state.reason) - AppUpdateState.Idle, - AppUpdateState.Unsupported -> null -} - -/** - * The strip above the project list that offers a newer release. Nothing is drawn until a check - * has found one, and nothing ever is on a build that cannot update itself. - */ -@Composable -fun AppUpdateBanner( - state: AppUpdateState, - onUpdate: () -> Unit, - onOpenRelease: () -> Unit, - onDismiss: () -> Unit, - modifier: Modifier = Modifier, -) { - val title = appUpdateDescription(state) ?: return - when (state) { - is AppUpdateState.Available -> if (!state.dismissed) { - HdNoticeStrip( - title = title, - detail = if (state.installable) Res.string.about_update_quit_notice.get() else null, - primaryLabel = if (state.installable) { - Res.string.about_update_install_button.get(state.version) - } else { - Res.string.update_dialog_open_release_button.get() - }, - onPrimary = if (state.installable) onUpdate else onOpenRelease, - secondaryLabel = Res.string.about_update_later_button.get(), - onSecondary = onDismiss, - modifier = modifier, - ) - } - - is AppUpdateState.Downloading -> HdNoticeStrip( - title = title, - progress = state.fraction, - modifier = modifier, - ) - - is AppUpdateState.Installing -> HdNoticeStrip( - title = title, - modifier = modifier, - ) - - is AppUpdateState.Failed -> HdNoticeStrip( - title = title, - primaryLabel = Res.string.about_update_retry_button.get(), - onPrimary = onUpdate, - secondaryLabel = Res.string.update_dialog_open_release_button.get(), - onSecondary = onOpenRelease, - modifier = modifier, - ) - - // Described, but only the About row says so. - AppUpdateState.Checking, - AppUpdateState.UpToDate, - AppUpdateState.Idle, - AppUpdateState.Unsupported -> Unit - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportStoryDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportStoryDialog.kt index 965eb0abc..41bf4b7e1 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportStoryDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportStoryDialog.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.common.projectselection import androidx.compose.foundation.* import androidx.compose.foundation.layout.* -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.items import androidx.compose.material.icons.Icons import androidx.compose.material.icons.automirrored.filled.Article import androidx.compose.material.icons.filled.Folder @@ -12,7 +10,6 @@ import androidx.compose.runtime.* import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import androidx.compose.ui.window.DialogProperties @@ -23,15 +20,12 @@ import com.darkrockstudios.apps.hammer.common.compose.NameKind import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.rememberNameValidation import com.darkrockstudios.apps.hammer.common.compose.designsystem.* -import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors +import com.darkrockstudios.apps.hammer.common.data.ChapterHeadingLevel import com.darkrockstudios.apps.hammer.common.data.ImportFormat import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy import com.darkrockstudios.apps.hammer.common.data.RtfSplitStrategy import com.darkrockstudios.apps.hammer.common.data.importer.ImportPreview -import com.darkrockstudios.apps.hammer.common.data.importer.LARGE_SCENE_WORD_COUNT import com.darkrockstudios.apps.hammer.common.data.importer.PreviewItem -import com.darkrockstudios.apps.hammer.common.util.formatDecimalSeparator import org.jetbrains.compose.resources.StringResource import com.darkrockstudios.apps.hammer.common.compose.resources.get @@ -44,7 +38,6 @@ fun ImportStoryDialog( projectName: String, options: ImportOptions, preview: ImportPreview, - isParsing: Boolean, onProjectNameChange: (String) -> Unit, onCancel: () -> Unit, onOptionsChange: (ImportOptions) -> Unit, @@ -65,7 +58,6 @@ fun ImportStoryDialog( projectName = projectName, options = options, preview = preview, - isParsing = isParsing, onProjectNameChange = onProjectNameChange, onCancel = onCancel, onOptionsChange = onOptionsChange, @@ -80,7 +72,6 @@ internal fun ImportStoryContent( projectName: String, options: ImportOptions, preview: ImportPreview, - isParsing: Boolean, onProjectNameChange: (String) -> Unit, onCancel: () -> Unit, onOptionsChange: (ImportOptions) -> Unit, @@ -107,7 +98,6 @@ internal fun ImportStoryContent( ImportMasthead( options = options, preview = preview, - isParsing = isParsing, onClose = onCancel, ) HdFolioDivider() @@ -141,22 +131,13 @@ internal fun ImportStoryContent( Spacer(modifier = Modifier.height(Ui.Padding.XL)) when (options.format) { - ImportFormat.Markdown -> { - HdHairlineSegmentedPicker( - title = Res.string.project_home_import_heading_label.get(), - options = MarkdownSplitStrategy.entries, - selected = options.markdownSplitStrategy, - onSelect = { onOptionsChange(options.copy(markdownSplitStrategy = it)) }, - label = { (it.labelRes()).get() }, - ) - if (options.markdownSplitStrategy == MarkdownSplitStrategy.Pattern) { - Spacer(modifier = Modifier.height(Ui.Padding.L)) - ChapterPatternField( - pattern = options.markdownChapterPattern, - onPatternChange = { onOptionsChange(options.copy(markdownChapterPattern = it)) }, - ) - } - } + ImportFormat.Markdown -> HdHairlineSegmentedPicker( + title = Res.string.project_home_import_heading_label.get(), + options = ChapterHeadingLevel.entries, + selected = options.chapterHeadingLevel, + onSelect = { onOptionsChange(options.copy(chapterHeadingLevel = it)) }, + label = { (it.labelRes()).get() }, + ) ImportFormat.Rtf -> { HdHairlineSegmentedPicker( @@ -168,9 +149,10 @@ internal fun ImportStoryContent( ) if (options.rtfSplitStrategy == RtfSplitStrategy.Pattern) { Spacer(modifier = Modifier.height(Ui.Padding.L)) - ChapterPatternField( - pattern = options.rtfChapterPattern, - onPatternChange = { onOptionsChange(options.copy(rtfChapterPattern = it)) }, + FormField( + value = options.rtfChapterPattern, + onValueChange = { onOptionsChange(options.copy(rtfChapterPattern = it)) }, + label = Res.string.project_home_import_pattern_label.get(), ) } } @@ -186,44 +168,32 @@ internal fun ImportStoryContent( Spacer(modifier = Modifier.height(Ui.Padding.XL)) - ImportPreviewPane(preview, isParsing, Modifier.weight(1f)) + ImportPreviewPane(preview, Modifier.weight(1f)) } ImportFooter( onCancel = onCancel, onConfirm = onConfirm, - confirmEnabled = !isParsing && !preview.isEmpty && nameValidation.isValid, + confirmEnabled = !preview.isEmpty && nameValidation.isValid, ) } } } -@Composable -private fun ChapterPatternField(pattern: String, onPatternChange: (String) -> Unit) { - FormField( - value = pattern, - onValueChange = onPatternChange, - label = Res.string.project_home_import_pattern_label.get(), - ) -} - @Composable private fun ImportMasthead( options: ImportOptions, preview: ImportPreview, - isParsing: Boolean, onClose: () -> Unit, ) { - val meta = remember(options, preview.totalScenes, preview.isEmpty, isParsing) { + val meta = remember(options, preview.totalScenes, preview.isEmpty) { buildList { add(options.format.metaLabel()) when (options.format) { - ImportFormat.Markdown -> add(options.markdownSplitStrategy.name.uppercase()) + ImportFormat.Markdown -> add(options.chapterHeadingLevel.name.uppercase()) ImportFormat.Rtf -> add(options.rtfSplitStrategy.name.uppercase()) } - if (isParsing) { - add("READING") - } else if (!preview.isEmpty) { + if (!preview.isEmpty) { add("${preview.totalScenes} SCENES") } } @@ -272,11 +242,7 @@ private fun ImportFooter( } @Composable -private fun ImportPreviewPane( - preview: ImportPreview, - isParsing: Boolean, - modifier: Modifier = Modifier, -) { +private fun ImportPreviewPane(preview: ImportPreview, modifier: Modifier = Modifier) { Column(modifier) { Row( modifier = Modifier.fillMaxWidth(), @@ -284,7 +250,7 @@ private fun ImportPreviewPane( verticalAlignment = Alignment.CenterVertically, ) { HdMonoLabel(Res.string.project_home_import_preview_label.get()) - if (!isParsing && !preview.isEmpty) { + if (!preview.isEmpty) { HdMonoLabel( Res.string.project_home_import_preview_count.get( preview.totalScenes, @@ -293,9 +259,6 @@ private fun ImportPreviewPane( } } Spacer(modifier = Modifier.height(Ui.Padding.S)) - if (!isParsing) { - LargeSceneWarning(remember(preview) { preview.oversizedScenes }) - } Box( modifier = Modifier .fillMaxWidth() @@ -306,20 +269,7 @@ private fun ImportPreviewPane( shape = RectangleShape, ), ) { - if (isParsing) { - Row( - modifier = Modifier.fillMaxWidth().padding(Ui.Padding.L), - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M, Alignment.CenterHorizontally), - verticalAlignment = Alignment.CenterVertically, - ) { - CircularProgressIndicator( - modifier = Modifier.size(18.dp), - strokeWidth = 2.dp, - color = MaterialTheme.colorScheme.primary, - ) - HdMonoLabel(Res.string.project_home_import_preview_reading.get()) - } - } else if (preview.isEmpty) { + if (preview.isEmpty) { Box( modifier = Modifier .fillMaxWidth() @@ -329,13 +279,20 @@ private fun ImportPreviewPane( HdMonoLabel(Res.string.project_home_import_preview_empty.get()) } } else { - // A manuscript can split into thousands of scenes; only compose the visible rows. - val rows = remember(preview) { preview.toRows() } - LazyColumn(contentPadding = PaddingValues(Ui.Padding.M)) { - items(rows) { row -> - when (row) { - is PreviewRow.Group -> PreviewGroupRow(row.name) - is PreviewRow.Scene -> PreviewSceneRow(row) + Column( + modifier = Modifier + .verticalScroll(rememberScrollState()) + .padding(Ui.Padding.M), + ) { + preview.items.forEach { item -> + when (item) { + is PreviewItem.Scene -> PreviewSceneRow(item.name, indented = false) + is PreviewItem.Group -> { + PreviewGroupRow(item.name) + item.scenes.forEach { childScene -> + PreviewSceneRow(childScene.name, indented = true) + } + } } } } @@ -344,47 +301,6 @@ private fun ImportPreviewPane( } } -/** Amber notice when the import would produce a scene over [LARGE_SCENE_WORD_COUNT]. Never blocks the import. */ -@Composable -private fun LargeSceneWarning(oversized: List) { - if (oversized.isEmpty()) return - - val message = if (oversized.size == 1) { - Res.string.project_home_import_large_scene_one.get( - oversized.first().wordCount.formatDecimalSeparator(), - ) - } else { - Res.string.project_home_import_large_scene_many.get( - oversized.size, - oversized.minOf { it.wordCount }.formatDecimalSeparator(), - ) - } - - HdWarningNotice( - label = Res.string.project_home_import_large_scene_label.get(), - message = message, - ) - Spacer(modifier = Modifier.height(Ui.Padding.S)) -} - -/** One flat row of the preview tree: a group header, or a scene at top level or inside a group. */ -private sealed interface PreviewRow { - class Group(val name: String) : PreviewRow - class Scene(val item: PreviewItem.Scene, val indented: Boolean) : PreviewRow -} - -private fun ImportPreview.toRows(): List = buildList { - items.forEach { item -> - when (item) { - is PreviewItem.Scene -> add(PreviewRow.Scene(item, indented = false)) - is PreviewItem.Group -> { - add(PreviewRow.Group(item.name)) - item.scenes.forEach { add(PreviewRow.Scene(it, indented = true)) } - } - } - } -} - @Composable private fun PreviewGroupRow(name: String) { Row( @@ -407,41 +323,25 @@ private fun PreviewGroupRow(name: String) { } @Composable -private fun PreviewSceneRow(row: PreviewRow.Scene) { - val oversized = row.item.isOversized +private fun PreviewSceneRow(name: String, indented: Boolean) { Row( modifier = Modifier .fillMaxWidth() - .padding(start = if (row.indented) Ui.Padding.L else 0.dp, top = 2.dp, bottom = 2.dp), + .padding(start = if (indented) Ui.Padding.L else 0.dp, top = 2.dp, bottom = 2.dp), verticalAlignment = Alignment.CenterVertically, ) { - val amber = LocalHammerColors.current.warning Icon( Icons.AutoMirrored.Filled.Article, contentDescription = null, - tint = if (oversized) amber else MaterialTheme.colorScheme.onSurfaceVariant, + tint = MaterialTheme.colorScheme.onSurfaceVariant, modifier = Modifier.size(18.dp), ) Spacer(modifier = Modifier.width(Ui.Padding.S)) Text( - row.item.name, + name, style = MaterialTheme.typography.bodyMedium, color = MaterialTheme.colorScheme.onSurface, - maxLines = 1, - overflow = TextOverflow.Ellipsis, - modifier = Modifier.weight(1f), ) - if (oversized) { - Spacer(modifier = Modifier.width(Ui.Padding.S)) - HdMonoLabel( - text = Res.string.project_home_import_scene_word_count.get( - row.item.wordCount.formatDecimalSeparator(), - ), - color = amber, - maxLines = 1, - softWrap = false, - ) - } } } @@ -450,11 +350,10 @@ private fun ImportFormat.metaLabel(): String = when (this) { ImportFormat.Rtf -> "RTF" } -private fun MarkdownSplitStrategy.labelRes(): StringResource = when (this) { - MarkdownSplitStrategy.Auto -> Res.string.project_home_import_heading_auto - MarkdownSplitStrategy.H1 -> Res.string.project_home_import_heading_h1 - MarkdownSplitStrategy.H2 -> Res.string.project_home_import_heading_h2 - MarkdownSplitStrategy.Pattern -> Res.string.project_home_import_split_pattern +private fun ChapterHeadingLevel.labelRes(): StringResource = when (this) { + ChapterHeadingLevel.Auto -> Res.string.project_home_import_heading_auto + ChapterHeadingLevel.H1 -> Res.string.project_home_import_heading_h1 + ChapterHeadingLevel.H2 -> Res.string.project_home_import_heading_h2 } private fun RtfSplitStrategy.labelRes(): StringResource = when (this) { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/LinkifyChangelog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/LinkifyChangelog.kt deleted file mode 100644 index aa12a46bb..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/LinkifyChangelog.kt +++ /dev/null @@ -1,68 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projectselection - -import androidx.compose.ui.text.AnnotatedString -import androidx.compose.ui.text.LinkAnnotation -import androidx.compose.ui.text.SpanStyle -import androidx.compose.ui.text.TextLinkStyles -import androidx.compose.ui.text.buildAnnotatedString -import androidx.compose.ui.text.withLink - -/** - * Makes links in the changelog clickable while leaving everything else verbatim. Deliberately - * not a markdown renderer: changelog entries lead with `[New]` / `[Fix]` tags, which a real - * parser mangles. Only `[label](url)` and bare http(s) urls are touched. - */ -fun linkifyChangelog(text: String, linkStyle: SpanStyle): AnnotatedString { - val styles = TextLinkStyles(style = linkStyle) - return buildAnnotatedString { - var index = 0 - while (index < text.length) { - val match = LINK.find(text, index) - if (match == null) { - append(text.substring(index)) - break - } - - append(text.substring(index, match.range.first)) - - val label = match.groupValues[1] - val markdownUrl = match.groupValues[2] - if (markdownUrl.isNotEmpty()) { - withLink(LinkAnnotation.Url(markdownUrl, styles)) { append(label) } - index = match.range.last + 1 - } else { - val url = trimBareUrl(match.value) - withLink(LinkAnnotation.Url(url, styles)) { append(url) } - index = match.range.first + url.length - } - } - } -} - -/** - * Drops sentence punctuation that butted up against a bare url. A closing paren only counts - * as punctuation when it has no opener inside the url, so `…/Foo_(Bar)` survives while - * `(see https://example.com)` doesn't swallow the wrapping paren. - */ -private fun trimBareUrl(matched: String): String { - var url = matched - while (url.isNotEmpty()) { - val last = url.last() - val isTrailing = when (last) { - ')' -> url.count { it == ')' } > url.count { it == '(' } - else -> last in SENTENCE_PUNCTUATION - } - if (!isTrailing) break - url = url.dropLast(1) - } - return url -} - -/** - * The url of a markdown link may itself contain parentheses, so one nested balanced pair is - * allowed before the `)` that closes the link — otherwise `…/Rich_Text_Format_(RTF)` truncates. - */ -private val LINK = - Regex("""\[([^]\n]*)]\((https?://(?:[^()\s]|\([^()\s]*\))*)\)|https?://\S+""") - -private const val SENTENCE_PUNCTUATION = ".,;:!?" diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectDeleteDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectDeleteDialog.kt index 6af690603..05c5beb85 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectDeleteDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectDeleteDialog.kt @@ -110,7 +110,6 @@ fun ProjectDeleteDialog( hint = projectDef.name, singleLine = true, imeAction = ImeAction.Done, - autoCorrectEnabled = false, error = if (showMismatch) "Does not match" else null, ) } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectListUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectListUi.kt index ddedb711e..726b903d9 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectListUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectListUi.kt @@ -1,16 +1,19 @@ package com.darkrockstudios.apps.hammer.common.projectselection import androidx.compose.animation.AnimatedVisibility +import androidx.compose.animation.fadeIn +import androidx.compose.animation.fadeOut +import androidx.compose.animation.slideInVertically +import androidx.compose.animation.slideOutVertically import androidx.compose.foundation.background import androidx.compose.foundation.border import androidx.compose.foundation.clickable import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.BoxScope import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.PaddingValues import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.Spacer +import androidx.compose.foundation.layout.fillMaxHeight import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.height @@ -27,7 +30,7 @@ import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.Icon import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf @@ -37,8 +40,10 @@ import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.clipToBounds +import androidx.compose.ui.geometry.Offset import androidx.compose.ui.graphics.RectangleShape +import androidx.compose.ui.input.nestedscroll.NestedScrollConnection +import androidx.compose.ui.input.nestedscroll.NestedScrollSource import androidx.compose.ui.input.nestedscroll.nestedScroll import androidx.compose.ui.platform.testTag import androidx.compose.ui.text.font.FontStyle @@ -53,7 +58,6 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.Projec import com.darkrockstudios.apps.hammer.common.components.projectselection.projectslist.ProjectsList import com.darkrockstudios.apps.hammer.common.components.projectselection.projectslist.filterProjects import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarGutter import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.Toaster @@ -61,16 +65,12 @@ import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdScrollAwayFooter -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdScrollAwayFooterState import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSortMenu import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSortOption import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagChip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdToolButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdScrollAwayFooterState import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.data.search.parseQuery import com.darkrockstudios.apps.hammer.common.protocolmismatch.ProtocolMismatchDialog import com.darkrockstudios.apps.hammer.common.reauthentication.ReauthenticationUi @@ -114,7 +114,6 @@ private val NarrowContentPadding: Dp = Ui.Padding.XL /** Tags the "Create Project" affordance (masthead button when wide, bottom bar when narrow). */ const val CreateProjectButtonTestTag = "create-project-button" -const val ProjectListTestTag = "project-list" internal enum class ProjectsSortMode( override val labelRes: StringResource, @@ -161,9 +160,7 @@ private fun applySort(projects: List, mode: ProjectsSortMode): List fun ProjectListUi( component: ProjectsList, rootSnackbar: RootSnackbarHostState, - modifier: Modifier = Modifier, - /** A slip laid under the masthead, given the page's inset; composes nothing when there is no notice. */ - notice: @Composable (Modifier) -> Unit = {}, + modifier: Modifier = Modifier ) { // Cut at WindowWidthSizeClass.Compact (600dp) rather than the project-wide // 720dp `isWide` so portrait tablets keep the desktop masthead instead of @@ -192,11 +189,18 @@ fun ProjectListUi( } } - val listState: LazyListState = rememberLazyListState() - val createBarState = rememberHdScrollAwayFooterState() - // Always reachable when the list can't scroll down to it. - val createBarVisible = - !isWide && (!listState.canScrollForward || !createBarState.isHiddenByScroll) + // Same scroll-away pattern as the scene list outline button: hide the + // bar when the user scrolls down, reveal it on any upward scroll. + var createBarVisible by remember { mutableStateOf(true) } + val scrollConnection = remember { + object : NestedScrollConnection { + override fun onPreScroll(available: Offset, source: NestedScrollSource): Offset { + if (available.y < -1f) createBarVisible = false + else if (available.y > 1f) createBarVisible = true + return Offset.Zero + } + } + } Column( modifier = modifier.fillMaxSize(), @@ -225,8 +229,6 @@ fun ProjectListUi( HdFolioDivider() - notice(Modifier.padding(start = horizontalPadding, end = horizontalPadding, top = 12.dp, bottom = 12.dp)) - AnimatedVisibility(visible = showSearchBar) { SearchStrip( query = query, @@ -245,17 +247,13 @@ fun ProjectListUi( ColumnHeader(showLastOpen = isWide) - Box(modifier = Modifier.weight(1f).clipToBounds()) { + Box(modifier = Modifier.weight(1f)) { + val listState: LazyListState = rememberLazyListState() LazyColumn( modifier = Modifier .fillMaxSize() - .testTag(ProjectListTestTag) - .nestedScroll(createBarState.nestedScrollConnection), + .nestedScroll(scrollConnection), state = listState, - contentPadding = PaddingValues( - end = MpScrollBarGutter, - bottom = if (isWide) 0.dp else createBarState.height, - ), ) { if (visibleProjects.isEmpty()) { item(key = "empty") { @@ -283,16 +281,22 @@ fun ProjectListUi( } } MpScrollBarList( - modifier = scrollBarOverlay(), + modifier = Modifier.align(Alignment.CenterEnd).fillMaxHeight(), state = listState, ) + } - BottomCreateBar( - state = createBarState, + if (!isWide) { + AnimatedVisibility( visible = createBarVisible, - onCreate = component::showCreate, - horizontalPadding = horizontalPadding, - ) + enter = slideInVertically(initialOffsetY = { it }) + fadeIn(), + exit = slideOutVertically(targetOffsetY = { it }) + fadeOut(), + ) { + BottomCreateBar( + onCreate = component::showCreate, + horizontalPadding = horizontalPadding, + ) + } } FooterFolio( @@ -308,7 +312,6 @@ fun ProjectListUi( projectName = state.importProjectName, options = state.importOptions, preview = state.importPreview, - isParsing = state.isParsingImport, onProjectNameChange = component::updateImportProjectName, onCancel = component::cancelImportDialog, onOptionsChange = component::updateImportOptions, @@ -503,7 +506,7 @@ private fun ColumnHeader(showLastOpen: Boolean) { .fillMaxWidth() .padding( start = 4.dp + Ui.Padding.XL, - end = Ui.Padding.L + MpScrollBarGutter, + end = Ui.Padding.L, top = Ui.Padding.M, bottom = Ui.Padding.M, ), @@ -596,25 +599,25 @@ private fun FooterFolio( } @Composable -private fun BoxScope.BottomCreateBar( - state: HdScrollAwayFooterState, - visible: Boolean, +private fun BottomCreateBar( onCreate: () -> Unit, horizontalPadding: Dp, ) { - HdScrollAwayFooter( - state = state, - visible = visible, - containerColor = MaterialTheme.colorScheme.surfaceContainerLow, - dividerColor = MaterialTheme.colorScheme.outline, - contentPadding = PaddingValues( - horizontal = horizontalPadding, - vertical = Ui.Padding.L, - ), + HorizontalDivider( + modifier = Modifier.fillMaxWidth(), + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outline, + ) + Box( + modifier = Modifier + .fillMaxWidth() + .background(MaterialTheme.colorScheme.surfaceContainerLow) + .padding(horizontal = horizontalPadding, vertical = Ui.Padding.L), + contentAlignment = Alignment.Center, ) { Box( modifier = Modifier - .weight(1f) + .fillMaxWidth() .height(44.dp) .testTag(CreateProjectButtonTestTag) .background(MaterialTheme.colorScheme.primary) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectScaffold.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectScaffold.kt index a374cb2f3..bd95f23a1 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectScaffold.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectScaffold.kt @@ -1,20 +1,17 @@ package com.darkrockstudios.apps.hammer.common.projectselection -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.BoxWithConstraints import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.WindowInsets -import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.material.ExperimentalMaterialApi import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Scaffold -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.ExperimentalMaterial3WindowSizeClassApi +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.calculateWindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.ExperimentalComposeApi import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue import androidx.compose.ui.Modifier import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.common.components.projectselection.ProjectSelection @@ -22,53 +19,28 @@ import com.darkrockstudios.apps.hammer.common.compose.defaultScaffold import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdBottomBar import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRail -import com.darkrockstudios.apps.hammer.common.compose.rememberWindowSizeClass import com.darkrockstudios.apps.hammer.common.compose.rootElement import com.darkrockstudios.apps.hammer.common.util.getAppVersionString -import com.darkrockstudios.cairn.CairnAboutOverlay -import com.darkrockstudios.cairn.CairnAppId -import com.darkrockstudios.cairn.CairnConfig @OptIn( + ExperimentalMaterial3WindowSizeClassApi::class, ExperimentalMaterialApi::class, ExperimentalComposeApi::class, ) @Composable fun ProjectSelectScaffold(component: ProjectSelection) { - var showStudio by remember { mutableStateOf(false) } + val windowSizeClass = calculateWindowSizeClass() - // The overlay is hoisted above the nav rail/bottom bar so its ceremony - // covers the whole window, not just the content pane. - BoxWithConstraints(modifier = Modifier.fillMaxSize()) { - val windowSizeClass = rememberWindowSizeClass(constraints) - when (windowSizeClass.widthSizeClass) { - WindowWidthSizeClass.Compact -> CompactNavigation( - component = component, - onShowStudio = { showStudio = true }, - ) - - WindowWidthSizeClass.Medium, - WindowWidthSizeClass.Expanded -> RailNavigation( - component = component, - onShowStudio = { showStudio = true }, - ) - } - - CairnAboutOverlay( - visible = showStudio, - config = CairnConfig( - currentAppId = CairnAppId.Hammer, - // Cairn stamps its own "v", ours already carries one. - versionName = getAppVersionString().removePrefix("v"), - ), - onDismissed = { showStudio = false }, - ) + when (windowSizeClass.widthSizeClass) { + WindowWidthSizeClass.Compact -> CompactNavigation(component) + WindowWidthSizeClass.Medium, + WindowWidthSizeClass.Expanded -> RailNavigation(component) } } @OptIn(ExperimentalMaterialApi::class, ExperimentalComposeApi::class) @Composable -private fun CompactNavigation(component: ProjectSelection, onShowStudio: () -> Unit) { +private fun CompactNavigation(component: ProjectSelection) { val stackState by component.stack.subscribeAsState() Scaffold( modifier = Modifier.defaultScaffold(), @@ -76,7 +48,6 @@ private fun CompactNavigation(component: ProjectSelection, onShowStudio: () -> U content = { scaffoldPadding -> ProjectSelectionUi( component, - onShowStudio = onShowStudio, modifier = Modifier.rootElement(scaffoldPadding), ) }, @@ -93,7 +64,7 @@ private fun CompactNavigation(component: ProjectSelection, onShowStudio: () -> U @OptIn(ExperimentalMaterialApi::class, ExperimentalComposeApi::class) @Composable -private fun RailNavigation(component: ProjectSelection, onShowStudio: () -> Unit) { +private fun RailNavigation(component: ProjectSelection) { val stackState by component.stack.subscribeAsState() val navRailState by component.navRailState.subscribeAsState() Scaffold( @@ -117,7 +88,7 @@ private fun RailNavigation(component: ProjectSelection, onShowStudio: () -> Unit }, ) - ProjectSelectionUi(component, onShowStudio = onShowStudio) + ProjectSelectionUi(component) } }, ) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectionUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectionUi.kt index 544935c62..f40d54660 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectionUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ProjectSelectionUi.kt @@ -66,7 +66,6 @@ fun ProjectSelection.Locations.toHdBottomBarDestination(): HdBottomBarDestinatio @Composable fun ProjectSelectionUi( component: ProjectSelection, - onShowStudio: () -> Unit, modifier: Modifier = Modifier ) { // SetScreenCharacteristics only fires inside ProjectRootUi by default, @@ -77,7 +76,6 @@ fun ProjectSelectionUi( val rootSnackbar = rememberRootSnackbarHostState() val stackState by component.stack.subscribeAsState() - val appUpdate by component.appUpdate.subscribeAsState() Box(modifier = modifier) { Children( stack = stackState, @@ -97,16 +95,6 @@ fun ProjectSelectionUi( is ProjectSelection.Destination.ProjectsListDestination -> ProjectListUi( destination.component, rootSnackbar, - // Only the list carries the update notice: the About screen has its own row. - notice = { noticeModifier -> - AppUpdateBanner( - state = appUpdate, - onUpdate = component::updateApp, - onOpenRelease = component::openLatestRelease, - onDismiss = component::dismissUpdate, - modifier = noticeModifier, - ) - }, ) is ProjectSelection.Destination.StoryIdeasDestination -> StoryIdeasUi( @@ -116,7 +104,6 @@ fun ProjectSelectionUi( is ProjectSelection.Destination.AboutAppDestination -> AboutAppUi( destination.component, - onShowStudio = onShowStudio, ) } } @@ -126,7 +113,7 @@ fun ProjectSelectionUi( modifier = Modifier.fillMaxWidth().align(Alignment.BottomCenter) ) - ChangelogDialog(component) + UpdateAvailableDialog(component) } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ChangelogDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/UpdateAvailableDialog.kt similarity index 68% rename from composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ChangelogDialog.kt rename to composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/UpdateAvailableDialog.kt index 35593cda4..298f74d2c 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ChangelogDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/UpdateAvailableDialog.kt @@ -12,9 +12,7 @@ import androidx.compose.runtime.* import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.text.SpanStyle import androidx.compose.ui.text.font.FontWeight -import androidx.compose.ui.text.style.TextDecoration import androidx.compose.ui.unit.dp import androidx.compose.ui.unit.sp import com.arkivanov.decompose.extensions.compose.subscribeAsState @@ -28,18 +26,20 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMastheadAct import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.theme.hammerMonoFontFamily +import korlibs.io.lang.format /** - * The release notes baked into the app by `prepareForRelease`. Never hits the network. - * Notes render as plain monospace text apart from links, which [linkifyChangelog] makes - * clickable — see that function for why this isn't a markdown renderer. + * GitHub release `body` is rendered verbatim as plain text — if a future + * contributor wants markdown rendering, add a real renderer rather than + * swapping in an unstyled drop-in. */ @Composable -fun ChangelogDialog(component: ProjectSelection) { - val state by component.changelog.subscribeAsState() +fun UpdateAvailableDialog(component: ProjectSelection) { + val state by component.updateNotification.subscribeAsState() + val tag = state.latestVersionTag AnimatedDialog( - visible = state.visible && state.notes != null, - onCloseRequest = component::dismissChangelog, + visible = state.visible && tag != null, + onCloseRequest = { component.dismissUpdateNotification(remember = false) }, modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center, ) { @@ -55,35 +55,54 @@ fun ChangelogDialog(component: ProjectSelection) { ) { Column { HdMasthead( - section = "CHANGES", - leadingMeta = listOfNotNull(state.version, state.date), + section = "UPDATE", + leadingMeta = listOfNotNull(tag), trailing = { HdMastheadAction( label = "× CLOSE", - onClick = component::dismissChangelog, + onClick = { component.dismissUpdateNotification(remember = false) }, ) }, ) HdFolioDivider() - Body(notes = state.notes) + Body( + isNewVersionAvailable = state.isNewVersionAvailable, + tag = tag.orEmpty(), + releaseName = state.releaseName, + releaseBody = state.releaseBody, + ) HorizontalDivider( color = MaterialTheme.colorScheme.outlineVariant, thickness = 1.dp, ) - Footer(onOpenRelease = component::openLatestRelease) + Footer( + onOpenRelease = component::openReleaseUrl, + onDismiss = { component.dismissUpdateNotification(remember = true) }, + manuallyTriggered = state.manuallyTriggered, + ) } } } } @Composable -private fun Body(notes: String?) { +private fun Body( + isNewVersionAvailable: Boolean, + tag: String, + releaseName: String?, + releaseBody: String?, +) { + val title = if (isNewVersionAvailable) { + Res.string.update_dialog_title.get() + } else { + Res.string.update_dialog_title_current.get().format(tag) + } Column( modifier = Modifier.padding(start = 26.dp, end = 26.dp, top = 22.dp, bottom = 22.dp), verticalArrangement = Arrangement.spacedBy(16.dp), ) { Text( - text = Res.string.changelog_dialog_title.get(), + text = title, style = MaterialTheme.typography.headlineSmall.copy( fontWeight = FontWeight.Normal, letterSpacing = (-0.26).sp, @@ -91,18 +110,21 @@ private fun Body(notes: String?) { ), color = MaterialTheme.colorScheme.onSurface, ) - ReleaseNotesSection(notes = notes) + if (!releaseName.isNullOrBlank()) { + Text( + text = releaseName, + style = MaterialTheme.typography.bodyMedium, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) + } + ReleaseNotesSection(releaseBody = releaseBody) } } @Composable -private fun ReleaseNotesSection(notes: String?) { +private fun ReleaseNotesSection(releaseBody: String?) { var expanded by remember { mutableStateOf(true) } val scroll = rememberScrollState() - val linkStyle = SpanStyle( - color = MaterialTheme.colorScheme.primary, - textDecoration = TextDecoration.Underline, - ) Column(verticalArrangement = Arrangement.spacedBy(8.dp)) { Row( modifier = Modifier @@ -116,10 +138,10 @@ private fun ReleaseNotesSection(notes: String?) { HdMonoLabel(text = Res.string.update_dialog_release_notes_section.get()) } AnimatedVisibility(visible = expanded) { - val text = notes?.takeIf { it.isNotBlank() } + val text = releaseBody?.takeIf { it.isNotBlank() } ?: Res.string.update_dialog_release_notes_empty.get() Text( - text = linkifyChangelog(text, linkStyle), + text = text, fontFamily = hammerMonoFontFamily(), fontSize = 12.sp, lineHeight = 18.sp, @@ -136,7 +158,11 @@ private fun ReleaseNotesSection(notes: String?) { } @Composable -private fun Footer(onOpenRelease: () -> Unit) { +private fun Footer( + onOpenRelease: () -> Unit, + onDismiss: () -> Unit, + manuallyTriggered: Boolean, +) { Row( modifier = Modifier .fillMaxWidth() @@ -146,6 +172,14 @@ private fun Footer(onOpenRelease: () -> Unit) { horizontalArrangement = Arrangement.spacedBy(10.dp), ) { Spacer(modifier = Modifier.weight(1f)) + if (!manuallyTriggered) { + TextButton( + onClick = onDismiss, + shape = RoundedCornerShape(4.dp), + ) { + Text(Res.string.update_dialog_dismiss_button.get()) + } + } OutlinedButton( onClick = onOpenRelease, shape = RoundedCornerShape(4.dp), diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.kt index 9bde86f49..b7b3bf37c 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.kt @@ -1,33 +1,13 @@ package com.darkrockstudios.apps.hammer.common.projectselection.about -import androidx.compose.foundation.Image -import androidx.compose.foundation.background -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.Spacer -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.size -import androidx.compose.foundation.layout.widthIn -import androidx.compose.foundation.rememberScrollState -import androidx.compose.foundation.verticalScroll +import androidx.compose.foundation.* +import androidx.compose.foundation.layout.* import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.Icon import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass +import androidx.compose.runtime.* import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.vector.ImageVector @@ -37,48 +17,23 @@ import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.about_attribution_header -import com.darkrockstudios.apps.hammer.about_attribution_libraries_button -import com.darkrockstudios.apps.hammer.about_attribution_studio_button -import com.darkrockstudios.apps.hammer.about_community_discord_link -import com.darkrockstudios.apps.hammer.about_community_github_link -import com.darkrockstudios.apps.hammer.about_community_header -import com.darkrockstudios.apps.hammer.about_community_reddit_link -import com.darkrockstudios.apps.hammer.about_community_studio_attribution -import com.darkrockstudios.apps.hammer.about_description -import com.darkrockstudios.apps.hammer.about_studio_header -import com.darkrockstudios.apps.hammer.about_version_changes_button -import com.darkrockstudios.apps.hammer.about_version_github_button -import com.darkrockstudios.apps.hammer.app_name +import com.darkrockstudios.apps.hammer.* import com.darkrockstudios.apps.hammer.common.components.projectselection.aboutapp.AboutApp import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCatalogueCard -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineSection -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel +import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.icons.AboutIcons import com.darkrockstudios.apps.hammer.common.compose.icons.Discord import com.darkrockstudios.apps.hammer.common.compose.icons.Github import com.darkrockstudios.apps.hammer.common.compose.icons.Reddit import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.changelog.supportsInAppChangelog -import com.darkrockstudios.apps.hammer.hammer_icon +import korlibs.io.lang.format import org.jetbrains.compose.resources.painterResource private val MaxColumnWidth = 880.dp @Composable -fun AboutAppUi( - component: AboutApp, - onShowStudio: () -> Unit, - modifier: Modifier = Modifier, -) { +fun AboutAppUi(component: AboutApp, modifier: Modifier = Modifier) { var showLibraries by remember { mutableStateOf(false) } val state by component.state.subscribeAsState() val screen = LocalScreenCharacteristic.current @@ -88,125 +43,93 @@ fun AboutAppUi( val outerVertical: Dp = if (isCompact) Ui.Padding.L else 28.dp val sectionCount = 4 + platformAboutSectionCount - Box(modifier = modifier.fillMaxSize()) { + Column( + modifier = modifier + .fillMaxSize() + .background(MaterialTheme.colorScheme.surface), + ) { + Breadcrumb(isCompact = isCompact) + HdFolioDivider() + Column( modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.surface), + .weight(1f) + .fillMaxWidth() + .verticalScroll(rememberScrollState()) + .padding(horizontal = outerHorizontal, vertical = outerVertical), ) { - Breadcrumb(isCompact = isCompact) - HdFolioDivider() - - val scrollState = rememberScrollState() Box( modifier = Modifier - .weight(1f) - .fillMaxWidth(), + .widthIn(max = MaxColumnWidth) + .fillMaxWidth() + .align(Alignment.CenterHorizontally), ) { - Column( - modifier = Modifier - .fillMaxSize() - .verticalScroll(scrollState) - .padding(horizontal = outerHorizontal, vertical = outerVertical), - ) { - Box( - modifier = Modifier - .widthIn(max = MaxColumnWidth) - .fillMaxWidth() - .align(Alignment.CenterHorizontally), + Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { + Hero(isCompact = isCompact) + + HdHairlineSection( + section = 1, + title = "MANUSCRIPT", + contentSpacing = 12.dp, ) { - Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { - Hero(isCompact = isCompact) - - HdHairlineSection( - section = 1, - title = Res.string.about_studio_header.get(), - contentSpacing = 14.dp, - ) { - Text( - text = Res.string.about_community_studio_attribution.get(), - style = MaterialTheme.typography.bodyLarge, - color = MaterialTheme.colorScheme.onSurface, - ) - HdHairlineButton( - label = Res.string.about_attribution_studio_button.get(), - onClick = onShowStudio, - ) - } - - HdHairlineSection( - section = 2, - title = Res.string.about_community_header.get(), - contentSpacing = 0.dp, - ) { - CommunityLink( - label = Res.string.about_community_discord_link.get(), - icon = AboutIcons.Discord, - onClick = component::openDiscord, - ) - CommunityRowDivider() - CommunityLink( - label = Res.string.about_community_reddit_link.get(), - icon = AboutIcons.Reddit, - onClick = component::openReddit, - ) - CommunityRowDivider() - CommunityLink( - label = Res.string.about_community_github_link.get(), - icon = AboutIcons.Github, - onClick = component::openGithub, - ) - } - - VersionCard( - state = state, - onViewChangelog = component::viewChangelog, - onOpenLatestRelease = component::openLatestRelease, - onCheckForUpdate = component::checkForUpdate, - onUpdateApp = component::updateApp, - ) - - AttributionSection( - onShowLibraries = { showLibraries = true }, - ) - - PlatformAboutSection(component, section = 5) - - Spacer(Modifier.height(8.dp)) - } + Text( + text = Res.string.about_description_line_two.get(), + style = MaterialTheme.typography.bodyLarge, + color = MaterialTheme.colorScheme.onSurface, + ) } + + HdHairlineSection( + section = 2, + title = Res.string.about_community_header.get(), + contentSpacing = 0.dp, + ) { + CommunityLink( + label = Res.string.about_community_discord_link.get(), + icon = AboutIcons.Discord, + onClick = component::openDiscord, + ) + CommunityRowDivider() + CommunityLink( + label = Res.string.about_community_reddit_link.get(), + icon = AboutIcons.Reddit, + onClick = component::openReddit, + ) + CommunityRowDivider() + CommunityLink( + label = Res.string.about_community_github_link.get(), + icon = AboutIcons.Github, + onClick = component::openGithub, + ) + } + + VersionCard(state, onViewReleaseDetails = component::viewReleaseDetails) + + HdHairlineSection( + section = 4, + title = Res.string.about_attribution_header.get(), + contentSpacing = 14.dp, + ) { + HdHairlineButton( + label = Res.string.about_attribution_libraries_button.get(), + onClick = { showLibraries = true }, + ) + } + + PlatformAboutSection(component, section = 5) + + Spacer(Modifier.height(8.dp)) } - - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, - ) } - - FolioCaption( - horizontalPadding = outerHorizontal, - sectionCount = sectionCount, - ) } - LibrariesUi(showLibraries) { showLibraries = false } - } -} - -@Composable -private fun AttributionSection( - onShowLibraries: () -> Unit, -) { - HdHairlineSection( - section = 4, - title = Res.string.about_attribution_header.get(), - contentSpacing = 14.dp, - ) { - HdHairlineButton( - label = Res.string.about_attribution_libraries_button.get(), - onClick = onShowLibraries, + FolioCaption( + horizontalPadding = outerHorizontal, + sectionCount = sectionCount, ) } + + LibrariesUi(showLibraries) { showLibraries = false } } @Composable @@ -307,43 +230,46 @@ private fun CommunityRowDivider() { ) } -@OptIn(ExperimentalLayoutApi::class) @Composable -private fun VersionCard( - state: AboutApp.State, - onViewChangelog: () -> Unit, - onOpenLatestRelease: () -> Unit, - onCheckForUpdate: () -> Unit, - onUpdateApp: () -> Unit, -) { +private fun VersionCard(state: AboutApp.State, onViewReleaseDetails: () -> Unit) { + val statusGreeble = if (state.newVersionAvailable) "UPDATE AVAILABLE" else "UP TO DATE" + val latestGreeble = state.latestVersion?.let { "LATEST $it" } + val latest = state.latestVersion + val message = if (state.newVersionAvailable && latest != null) { + Res.string.about_version_new_available_message.get().format(latest) + } else { + Res.string.about_version_up_to_date.get() + } + val messageColor = if (state.newVersionAvailable) { + MaterialTheme.colorScheme.primary + } else { + MaterialTheme.colorScheme.onSurface + } + val buttonLabel = if (state.newVersionAvailable) { + Res.string.about_version_view_update_button.get() + } else { + Res.string.about_version_view_notes_button.get() + } + HdCatalogueCard( topStart = "§ III · VERSION", - topEnd = "INSTALLED", + topEnd = statusGreeble, bottomStart = state.currentVersion, + bottomEnd = latestGreeble, ) { - // FlowRow, not Row: the two labels wrap instead of clipping on a narrow screen. - FlowRow( - horizontalArrangement = Arrangement.spacedBy(14.dp), - verticalArrangement = Arrangement.spacedBy(14.dp), - ) { - if (supportsInAppChangelog) { + Column(verticalArrangement = Arrangement.spacedBy(14.dp)) { + Text( + text = message, + style = MaterialTheme.typography.bodyMedium, + color = messageColor, + ) + if (latest != null) { HdHairlineButton( - label = Res.string.about_version_changes_button.get(), - onClick = onViewChangelog, + label = buttonLabel, + onClick = onViewReleaseDetails, + emphasised = state.newVersionAvailable, ) } - HdHairlineButton( - label = Res.string.about_version_github_button.get(), - onClick = onOpenLatestRelease, - ) - } - if (state.appUpdate !is AppUpdateState.Unsupported) { - Spacer(Modifier.height(16.dp)) - AppUpdateStatus( - state = state.appUpdate, - onCheckForUpdate = onCheckForUpdate, - onUpdateApp = onUpdateApp, - ) } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AppUpdateStatus.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AppUpdateStatus.kt deleted file mode 100644 index 53f921bb3..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AppUpdateStatus.kt +++ /dev/null @@ -1,96 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projectselection.about - -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.about_update_check_button -import com.darkrockstudios.apps.hammer.about_update_install_button -import com.darkrockstudios.apps.hammer.about_update_retry_button -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineProgressBar -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.projectselection.appUpdateDescription - -/** - * The update row on the About screen's version card. Hidden on builds that cannot update, so - * store builds show no trace of it. A release this install cannot install itself is only - * announced; the card's existing release-page button covers the rest. - */ -@OptIn(ExperimentalLayoutApi::class) -@Composable -fun AppUpdateStatus( - state: AppUpdateState, - onCheckForUpdate: () -> Unit, - onUpdateApp: () -> Unit, - modifier: Modifier = Modifier, -) { - if (state is AppUpdateState.Unsupported) return - - Column( - modifier = modifier, - verticalArrangement = Arrangement.spacedBy(12.dp), - ) { - appUpdateDescription(state)?.let { text -> - Text( - text = text, - style = MaterialTheme.typography.bodyMedium, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - if (state is AppUpdateState.Downloading) { - HdHairlineProgressBar(progress = state.fraction) - } - FlowRow( - horizontalArrangement = Arrangement.spacedBy(14.dp), - verticalArrangement = Arrangement.spacedBy(14.dp), - ) { - when (state) { - is AppUpdateState.Available -> { - if (state.installable) { - HdHairlineButton( - label = Res.string.about_update_install_button.get(state.version), - onClick = onUpdateApp, - emphasised = true, - ) - } - CheckButton(onCheckForUpdate) - } - - is AppUpdateState.Failed -> { - HdHairlineButton( - label = Res.string.about_update_retry_button.get(), - onClick = onUpdateApp, - emphasised = true, - ) - CheckButton(onCheckForUpdate) - } - - AppUpdateState.Checking -> CheckButton(onCheckForUpdate, enabled = false) - - AppUpdateState.Idle, - AppUpdateState.UpToDate -> CheckButton(onCheckForUpdate) - - is AppUpdateState.Downloading, - is AppUpdateState.Installing, - AppUpdateState.Unsupported -> Unit - } - } - } -} - -@Composable -private fun CheckButton(onClick: () -> Unit, enabled: Boolean = true) { - HdHairlineButton( - label = Res.string.about_update_check_button.get(), - onClick = onClick, - enabled = enabled, - ) -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/CopyDiagnosticsButton.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/CopyDiagnosticsButton.kt deleted file mode 100644 index 90af3c45f..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/CopyDiagnosticsButton.kt +++ /dev/null @@ -1,60 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projectselection.about - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.rememberCoroutineScope -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import com.darkrockstudios.apps.hammer.Res -import com.darkrockstudios.apps.hammer.about_logs_copy_diagnostics_button -import com.darkrockstudios.apps.hammer.about_logs_copy_diagnostics_failed -import com.darkrockstudios.apps.hammer.about_logs_copy_diagnostics_success -import com.darkrockstudios.apps.hammer.common.buildDiagnosticsReport -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.rememberClipboardCopier -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.launch - -/** - * Puts the startup banner and the tail of the current log on the clipboard, so a bug report can - * carry its own diagnostics without the reporter having to find, zip, and attach a log file. - */ -@Composable -fun CopyDiagnosticsButton( - logDirectoryPath: String, - onStatus: (String) -> Unit, - modifier: Modifier = Modifier, -) { - val scope = rememberCoroutineScope() - val copyToClipboard = rememberClipboardCopier() - var copying by remember { mutableStateOf(false) } - - val successMessage = Res.string.about_logs_copy_diagnostics_success.get() - val failedMessage = Res.string.about_logs_copy_diagnostics_failed.get() - - HdHairlineButton( - label = Res.string.about_logs_copy_diagnostics_button.get(), - enabled = !copying, - modifier = modifier, - onClick = { - copying = true - scope.launch { - val message = try { - copyToClipboard(buildDiagnosticsReport(logDirectoryPath)) - successMessage - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - Napier.e("Failed to copy diagnostics", e) - failedMessage - } - copying = false - onStatus(message) - } - }, - ) -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/AccountSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/AccountSettingsUi.kt index 43ba6ebec..2ad4de7fd 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/AccountSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/AccountSettingsUi.kt @@ -7,7 +7,7 @@ import androidx.compose.foundation.verticalScroll import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.rememberCoroutineScope @@ -21,15 +21,12 @@ import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.* import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettings import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.Toaster import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors -import com.darkrockstudios.apps.hammer.common.compose.theme.oledBlackThemeAvailable import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.data.globalsettings.InitialProjectScreen import com.darkrockstudios.apps.hammer.common.data.globalsettings.UiTheme @@ -63,115 +60,104 @@ internal fun AccountSettingsUi( Breadcrumb(isCompact = isCompact) HdFolioDivider() - val scrollState = rememberScrollState() - Box( + Column( modifier = Modifier .weight(1f) - .fillMaxWidth(), + .fillMaxWidth() + .verticalScroll(rememberScrollState()) + .padding(horizontal = outerHorizontal, vertical = outerVertical), ) { - Column( + Box( modifier = Modifier - .fillMaxSize() - .verticalScroll(scrollState) - .padding(horizontal = outerHorizontal, vertical = outerVertical), + .widthIn(max = MaxColumnWidth) + .fillMaxWidth() + .align(Alignment.CenterHorizontally), ) { - Box( - modifier = Modifier - .widthIn(max = MaxColumnWidth) - .fillMaxWidth() - .align(Alignment.CenterHorizontally), - ) { - Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { - Hero( - loggedIn = state.serverIsLoggedIn, - email = state.currentEmail, - isCompact = isCompact, + Column(verticalArrangement = Arrangement.spacedBy(64.dp)) { + Hero( + loggedIn = state.serverIsLoggedIn, + email = state.currentEmail, + isCompact = isCompact, + ) + + HdHairlineSection( + section = 1, + title = Res.string.settings_theme_label.get(), + headerTrailing = { + HdMonoLabel(text = uiThemeLabel(state.uiTheme)) + }, + contentSpacing = 12.dp, + ) { + HdHairlineSegmentedPicker( + options = UiTheme.entries, + selected = state.uiTheme, + onSelect = { component.setUiTheme(it) }, + label = { uiThemeLabel(it) }, ) - - HdHairlineSection( - section = 1, - title = Res.string.settings_theme_label.get(), - headerTrailing = { - HdMonoLabel(text = uiThemeLabel(state.uiTheme)) - }, - contentSpacing = 12.dp, - ) { - HdHairlineSegmentedPicker( - options = UiTheme.entries.filter { it != UiTheme.OledBlack || oledBlackThemeAvailable }, - selected = state.uiTheme, - onSelect = { component.setUiTheme(it) }, - label = { uiThemeLabel(it) }, - ) - } - - HdHairlineSection( - section = 2, - title = Res.string.settings_initial_screen_label.get(), - headerTrailing = { - HdMonoLabel(text = initialScreenLabel(state.initialProjectScreen)) - }, - contentSpacing = 12.dp, - ) { - HdHairlineSegmentedPicker( - options = InitialProjectScreen.entries, - selected = state.initialProjectScreen, - onSelect = { component.setInitialProjectScreen(it) }, - label = { initialScreenLabel(it) }, - ) - } - - HdHairlineSection( - section = 3, - title = Res.string.settings_spellcheck_heading.get(), - contentSpacing = 18.dp, - ) { - SpellCheckSettingsContent(component.spellCheckSettings) - } - - ServerSettingsUi( - component = component, - scope = scope, - rootSnackbar = rootSnackbar, - ) - - HdHairlineSection( - section = 5, - title = Res.string.settings_backups_header.get(), - headerTrailing = { - HdMonoLabel( - text = "${state.maxBackups} / ${GlobalSettings.MAX_BACKUPS}", - ) - }, - contentSpacing = 16.dp, - ) { - BackupsSettingsUi(component, scope) - } - - HdHairlineSection( - section = 6, - title = Res.string.settings_platform_settings_title.get(), - contentSpacing = 16.dp, - ) { - PlatformSettingsUi(component.platformSettings) - } - - HdHairlineSection( - section = 7, - title = Res.string.settings_example_project_header.get(), - contentSpacing = 14.dp, - ) { - ExampleProjectSection(component, rootSnackbar) - } - - Spacer(Modifier.height(8.dp)) } + + HdHairlineSection( + section = 2, + title = Res.string.settings_initial_screen_label.get(), + headerTrailing = { + HdMonoLabel(text = initialScreenLabel(state.initialProjectScreen)) + }, + contentSpacing = 12.dp, + ) { + HdHairlineSegmentedPicker( + options = InitialProjectScreen.entries, + selected = state.initialProjectScreen, + onSelect = { component.setInitialProjectScreen(it) }, + label = { initialScreenLabel(it) }, + ) + } + + HdHairlineSection( + section = 3, + title = Res.string.settings_spellcheck_heading.get(), + contentSpacing = 18.dp, + ) { + SpellCheckSettingsContent(component.spellCheckSettings) + } + + ServerSettingsUi( + component = component, + scope = scope, + rootSnackbar = rootSnackbar, + ) + + HdHairlineSection( + section = 5, + title = Res.string.settings_backups_header.get(), + headerTrailing = { + HdMonoLabel( + text = "${state.maxBackups} / ${GlobalSettings.MAX_BACKUPS}", + ) + }, + contentSpacing = 16.dp, + ) { + BackupsSettingsUi(component, scope) + } + + HdHairlineSection( + section = 6, + title = Res.string.settings_platform_settings_title.get(), + contentSpacing = 16.dp, + ) { + PlatformSettingsUi(component.platformSettings) + } + + HdHairlineSection( + section = 7, + title = Res.string.settings_example_project_header.get(), + contentSpacing = 14.dp, + ) { + ExampleProjectSection(component, rootSnackbar) + } + + Spacer(Modifier.height(8.dp)) } } - - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, - ) } FolioCaption( @@ -316,7 +302,6 @@ private fun FolioCaption( private fun uiThemeLabel(theme: UiTheme): String = when (theme) { UiTheme.Light -> Res.string.settings_theme_light.get() UiTheme.Dark -> Res.string.settings_theme_dark.get() - UiTheme.OledBlack -> Res.string.settings_theme_oled_black.get() UiTheme.FollowSystem -> Res.string.settings_theme_followsystem.get() } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/MergeProjectsDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/MergeProjectsDialog.kt deleted file mode 100644 index d7019c6dc..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/MergeProjectsDialog.kt +++ /dev/null @@ -1,196 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.projectselection.settings - -import androidx.compose.foundation.BorderStroke -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.layout.widthIn -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Surface -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.sp -import androidx.compose.ui.window.DialogProperties -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.* -import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettings -import com.darkrockstudios.apps.hammer.common.compose.AnimatedDialogContainer -import com.darkrockstudios.apps.hammer.common.compose.ConfirmationDialog -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdButtonBar -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineSegmentedPicker -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMasthead -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMastheadAction -import com.darkrockstudios.apps.hammer.common.compose.resources.get - -private val DialogMaxWidth = 480.dp - -enum class MergeMode { - Merge, - Replace, -} - -/** - * Raised in place of the server setup dialog when logging in to a new server would merge real local - * work into it. A sibling of [ServerSetupDialog] and [TermsOfServiceDialog] rather than a child, so - * the two never stack. - */ -@Composable -fun MergeProjectsDialog(component: AccountSettings) { - val state by component.state.subscribeAsState() - - var renderInternal by remember { mutableStateOf(state.mergePrompt) } - LaunchedEffect(state.mergePrompt) { if (state.mergePrompt) renderInternal = true } - - // Keyed on renderInternal, not mergePrompt: the choice has to outlive the exit animation, and - // resetting on close would visibly snap the picker back to Merge on the way out. - var mode by rememberSaveable(renderInternal) { mutableStateOf(MergeMode.Merge) } - var confirmReplace by rememberSaveable(renderInternal) { mutableStateOf(false) } - - if (renderInternal) { - AnimatedDialogContainer( - isOpen = state.mergePrompt, - onDismissRequest = { component.cancelMergePrompt() }, - onClosed = { renderInternal = false }, - properties = DialogProperties(usePlatformDefaultWidth = false), - ) { - MergeProjectsDialogContent( - mode = mode, - onModeChange = { mode = it }, - onCancel = { component.cancelMergePrompt() }, - onContinue = { - when (mode) { - MergeMode.Merge -> component.chooseMerge() - MergeMode.Replace -> confirmReplace = true - } - }, - modifier = Modifier.predictiveBackTransform(), - ) - } - } - - ConfirmationDialog( - visible = confirmReplace, - title = Res.string.merge_projects_replace_confirm_title.get(), - message = Res.string.merge_projects_replace_confirm_message.get(), - confirmLabel = Res.string.merge_projects_replace_confirm_button.get(), - cancelLabel = Res.string.confirm_dialog_negative.get(), - onConfirm = { - confirmReplace = false - component.chooseReplace() - }, - onDismiss = { confirmReplace = false }, - destructive = true, - kind = "DELETE", - ) -} - -/** - * The static chrome of [MergeProjectsDialog] without the [AnimatedDialogContainer] wrapper. - * Render this directly in a `@Preview`: the Desktop preview renderer can't advance the enter - * animation, so only this settles to an opaque frame. - */ -@Composable -fun MergeProjectsDialogContent( - mode: MergeMode, - onModeChange: (MergeMode) -> Unit, - onCancel: () -> Unit, - onContinue: () -> Unit, - modifier: Modifier = Modifier, -) { - Surface( - modifier = modifier - .padding(Ui.Padding.M) - .widthIn(max = DialogMaxWidth) - .fillMaxWidth(), - shape = RectangleShape, - color = MaterialTheme.colorScheme.surface, - contentColor = MaterialTheme.colorScheme.onSurface, - border = BorderStroke( - width = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ), - ) { - Column { - HdMasthead( - section = "SYNC PROJECTS", - trailing = { - HdMastheadAction(label = "× CLOSE", onClick = onCancel) - }, - ) - HdFolioDivider() - - Text( - text = Res.string.merge_projects_dialog_title.get(), - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier - .fillMaxWidth() - .padding( - start = Ui.Padding.XL, - end = Ui.Padding.XL, - top = Ui.Padding.L, - bottom = Ui.Padding.S, - ), - ) - - Column( - modifier = Modifier - .fillMaxWidth() - .padding( - start = Ui.Padding.XL, - end = Ui.Padding.XL, - top = Ui.Padding.L, - bottom = Ui.Padding.L, - ), - verticalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - HdHairlineSegmentedPicker( - title = Res.string.merge_projects_mode_label.get(), - options = MergeMode.entries, - selected = mode, - onSelect = onModeChange, - label = { it.label() }, - ) - - Text( - text = mode.explanation(), - style = MaterialTheme.typography.bodyMedium.copy(lineHeight = 22.sp), - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - - HdButtonBar( - cancelLabel = Res.string.settings_server_setup_cancel_button.get(), - primaryLabel = Res.string.merge_projects_continue_button.get(), - onCancel = onCancel, - onPrimary = onContinue, - primaryDanger = mode == MergeMode.Replace, - ) - } - } -} - -@Composable -private fun MergeMode.label(): String = when (this) { - MergeMode.Merge -> Res.string.merge_projects_mode_merge.get() - MergeMode.Replace -> Res.string.merge_projects_mode_replace.get() -} - -@Composable -private fun MergeMode.explanation(): String = when (this) { - MergeMode.Merge -> Res.string.merge_projects_explain_merge.get() - MergeMode.Replace -> Res.string.merge_projects_explain_replace.get() -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSettingsUi.kt index 958fdd155..ae4c99735 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSettingsUi.kt @@ -120,7 +120,6 @@ fun ServerSettingsUi( Toaster(component, rootSnackbar) ServerSetupDialog(component, scope) - MergeProjectsDialog(component) TermsOfServiceDialog(component) if (showHelpDialog) { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSetupDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSetupDialog.kt index aa926ef35..aacece4c7 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSetupDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/ServerSetupDialog.kt @@ -9,16 +9,17 @@ import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape import androidx.compose.ui.text.input.ImeAction -import androidx.compose.ui.text.input.KeyboardCapitalization import androidx.compose.ui.text.input.KeyboardType +import androidx.compose.ui.text.input.PasswordVisualTransformation +import androidx.compose.ui.text.input.VisualTransformation import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import androidx.compose.ui.window.DialogProperties import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.* -import com.darkrockstudios.apps.hammer.base.validate.PasswordValidator import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.AccountSettings import com.darkrockstudios.apps.hammer.common.compose.AnimatedDialogContainer +import com.darkrockstudios.apps.hammer.common.compose.SimpleConfirm import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.resources.get @@ -70,6 +71,7 @@ fun ServerSetupDialogContent( val state by component.state.subscribeAsState() var passwordVisible by rememberSaveable(state.serverSetup) { mutableStateOf(false) } + var confirmDeleteLocal by rememberSaveable(state.serverSetup) { mutableStateOf(null) } var showHelpDialog by rememberSaveable { mutableStateOf(false) } val existingServer = rememberSaveable(state.serverSetup) { state.serverWorking.not() @@ -131,41 +133,44 @@ fun ServerSetupDialogContent( placeholder = Res.string.settings_server_setup_url_hint.get(), singleLine = true, imeAction = ImeAction.Next, - capitalization = KeyboardCapitalization.None, - autoCorrectEnabled = false, keyboardType = KeyboardType.Uri, enabled = !state.serverWorking && !existingServer, ) - if (state.serverUrlInsecure) { - HdMonoLabel( - text = "! " + Res.string.settings_server_setup_insecure_warning.get(), - color = MaterialTheme.colorScheme.error, - ) - } - - HdEmailField( + HdHairlineField( label = "EMAIL", value = state.serverEmail ?: "", onValueChange = { component.updateServerEmail(it) }, placeholder = Res.string.settings_server_setup_email_hint.get(), + singleLine = true, + imeAction = ImeAction.Next, + keyboardType = KeyboardType.Email, enabled = !state.serverWorking && !existingServer, ) - HdPasswordField( + HdHairlineField( label = "PASSWORD", value = state.serverPassword ?: "", onValueChange = { component.updateServerPassword(it) }, - visible = passwordVisible, - onVisibleChange = { passwordVisible = it }, placeholder = Res.string.settings_server_setup_password_hint.get(), - hint = Res.string.settings_server_setup_password_requirements.get( - PasswordValidator.MIN_LENGTH, - PasswordValidator.MAX_LENGTH, - ), + singleLine = true, + imeAction = ImeAction.Done, + keyboardType = KeyboardType.Password, + visualTransformation = if (passwordVisible) VisualTransformation.None + else PasswordVisualTransformation(), enabled = !state.serverWorking, ) + HdHairlineToggleRow( + checked = passwordVisible, + onCheckedChange = { passwordVisible = it }, + label = if (passwordVisible) { + Res.string.settings_server_setup_password_hide.get() + } else { + Res.string.settings_server_setup_password_show.get() + }, + ) + state.serverError?.let { error -> HdMonoLabel( text = "! $error", @@ -179,29 +184,55 @@ fun ServerSetupDialogContent( color = MaterialTheme.colorScheme.outlineVariant, ) - // The component decides whether a login needs the merge/replace prompt; the UI only - // ever asks for the non-destructive setup. - fun setupServer(create: Boolean) { - component.setupServer( - url = state.serverUrl ?: "", - email = state.serverEmail ?: "", - password = state.serverPassword ?: "", - create = create, - replaceLocalContent = false, - ) - } - ActionRow( working = state.serverWorking, isLoggedIn = state.serverIsLoggedIn, canCreate = state.currentUrl == null, onCancel = { scope.launch { component.cancelServerSetup() } }, - onCreate = { setupServer(create = true) }, - onLogin = { setupServer(create = false) }, + onCreate = { confirmDeleteLocal = true }, + onLogin = { + if (state.serverIsLoggedIn.not()) { + confirmDeleteLocal = false + } else { + component.setupServer( + url = state.serverUrl ?: "", + email = state.serverEmail ?: "", + password = state.serverPassword ?: "", + create = false, + removeLocalContent = false, + ) + } + }, ) } } + confirmDeleteLocal?.let { create -> + fun setupServer(create: Boolean, removeLocal: Boolean) { + component.setupServer( + url = state.serverUrl ?: "", + email = state.serverEmail ?: "", + password = state.serverPassword ?: "", + create = create, + removeLocalContent = removeLocal, + ) + } + + SimpleConfirm( + title = Res.string.remove_local_dialog_title.get(), + message = Res.string.remove_local_dialog_message.get(), + implicitCancel = false, + onDismiss = { + setupServer(create, false) + confirmDeleteLocal = null + }, + onConfirm = { + setupServer(create, true) + confirmDeleteLocal = null + }, + ) + } + if (showHelpDialog) { ServerSetupHelpDialog(onDismiss = { showHelpDialog = false }) } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/SpellCheckSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/SpellCheckSettingsUi.kt index 1e48d0349..c6c6bede0 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/SpellCheckSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/SpellCheckSettingsUi.kt @@ -13,6 +13,7 @@ import androidx.compose.runtime.getValue import androidx.compose.runtime.remember import androidx.compose.runtime.rememberCoroutineScope import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.alpha import androidx.compose.ui.graphics.RectangleShape import androidx.compose.ui.text.SpanStyle import androidx.compose.ui.text.buildAnnotatedString @@ -30,8 +31,6 @@ import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.notice_experimental_label import com.darkrockstudios.apps.hammer.settings_spellcheck_enable -import com.darkrockstudios.apps.hammer.settings_spellcheck_encyclopedia_enable -import com.darkrockstudios.apps.hammer.settings_spellcheck_encyclopedia_enable_hint import com.darkrockstudios.apps.hammer.settings_spellcheck_in_focus_enable import com.darkrockstudios.apps.hammer.settings_spellcheck_notice import kotlinx.coroutines.launch @@ -39,7 +38,6 @@ import kotlinx.coroutines.launch @Composable internal fun SpellCheckSettingsContent( component: SpellCheckSettings, - showEncyclopediaToggle: Boolean = true, ) { val state by component.state.subscribeAsState() val scope = rememberCoroutineScope() @@ -51,19 +49,17 @@ internal fun SpellCheckSettingsContent( label = Res.string.settings_spellcheck_enable.get(), onCheckedChange = { scope.launch { component.setSpellcheckEnable(it) } }, ) - HdHairlineToggleRow( - checked = state.spellCheckingInFocusEnabled, - label = Res.string.settings_spellcheck_in_focus_enable.get(), - enabled = state.spellCheckingEnabled, - onCheckedChange = { scope.launch { component.setSpellCheckingInFocusEnabled(it) } }, - ) - if (showEncyclopediaToggle) { + Box( + modifier = Modifier.alpha(if (state.spellCheckingEnabled) 1f else 0.45f), + ) { HdHairlineToggleRow( - checked = state.spellCheckingEncyclopediaEnabled, - label = Res.string.settings_spellcheck_encyclopedia_enable.get(), - hint = Res.string.settings_spellcheck_encyclopedia_enable_hint.get(), - enabled = state.spellCheckingEnabled, - onCheckedChange = { scope.launch { component.setSpellCheckEncyclopediaEnabled(it) } }, + checked = state.spellCheckingInFocusEnabled, + label = Res.string.settings_spellcheck_in_focus_enable.get(), + onCheckedChange = { + if (state.spellCheckingEnabled) { + scope.launch { component.setSpellCheckingInFocusEnabled(it) } + } + }, ) } SpellCheckDictionaryControl( diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/backups/BackupsSettingsUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/backups/BackupsSettingsUi.kt index 92dc9f571..24d79ff2f 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/backups/BackupsSettingsUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/backups/BackupsSettingsUi.kt @@ -9,7 +9,6 @@ import androidx.compose.material3.Text import androidx.compose.runtime.* import androidx.compose.ui.Modifier import androidx.compose.ui.text.input.ImeAction -import androidx.compose.ui.text.input.KeyboardType import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.* @@ -60,7 +59,6 @@ fun BackupsSettingsUi( }, hint = "1–${GlobalSettings.MAX_BACKUPS}", imeAction = ImeAction.Done, - keyboardType = KeyboardType.Number, error = if (isMaxBackupsError) { Res.string.settings_server_max_backups_error.get(GlobalSettings.MAX_BACKUPS) } else { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/storyideas/StoryIdeasUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/storyideas/StoryIdeasUi.kt index fecf80c66..34319a280 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/storyideas/StoryIdeasUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/storyideas/StoryIdeasUi.kt @@ -40,7 +40,6 @@ import androidx.compose.foundation.verticalScroll import androidx.compose.foundation.lazy.staggeredgrid.LazyVerticalStaggeredGrid import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridCells import androidx.compose.foundation.lazy.staggeredgrid.StaggeredGridItemSpan -import androidx.compose.foundation.lazy.staggeredgrid.rememberLazyStaggeredGridState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Add import androidx.compose.material.icons.filled.Search @@ -58,8 +57,6 @@ import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.rememberCoroutineScope -import androidx.compose.runtime.saveable.Saver -import androidx.compose.runtime.saveable.listSaver import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment @@ -78,8 +75,6 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.storyi import com.darkrockstudios.apps.hammer.common.compose.CollapseWhileTyping import com.darkrockstudios.apps.hammer.common.compose.DetailViewDropdownMenu import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarColumn -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarStaggeredGrid import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.SimpleConfirm import com.darkrockstudios.apps.hammer.common.compose.Ui @@ -107,13 +102,11 @@ import com.darkrockstudios.apps.hammer.common.compose.rememberMainDispatcher import com.darkrockstudios.apps.hammer.common.compose.rememberStrRes import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.saveShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.data.MenuItemDescriptor import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeaError import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeasRepository import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.data.isSuccess -import com.darkrockstudios.apps.hammer.common.data.search.markdownContains import com.darkrockstudios.apps.hammer.common.data.tagindex.TagCount import com.darkrockstudios.apps.hammer.common.util.format import com.darkrockstudios.apps.hammer.ideas_archive_button @@ -185,7 +178,6 @@ import kotlin.time.Instant import androidx.compose.foundation.lazy.staggeredgrid.items as staggeredItems const val IDEAS_CREATE_FAB_TAG = "ideas-create-fab" -const val IDEAS_EDITOR_TITLE_TAG = "ideas-editor-title" const val IDEAS_EDITOR_BODY_TAG = "ideas-editor-body" const val IDEAS_EDITOR_CONFIRM_TAG = "ideas-editor-confirm" const val IDEAS_EDITOR_CANCEL_TAG = "ideas-editor-cancel" @@ -204,24 +196,9 @@ private enum class IdeasSortMode( TitleAsc(Res.string.ideas_sort_title_az, Res.string.ideas_sort_glyph_title_az), } -private val IdeasSortModeSaver = Saver( - save = { it.name }, - restore = { IdeasSortMode.valueOf(it) }, -) - -private val TagSetSaver = listSaver, String>( - save = { it.toList() }, - restore = { it.toSet() }, -) - private fun StoryIdea.wordCount(): Int = content.split(Regex("\\s+")).count { it.isNotBlank() } -/** An idea matches on its body read as prose, or on its plain-text title. */ -internal fun ideaMatchesQuery(idea: StoryIdea, query: String): Boolean = - markdownContains(idea.content, query) || - idea.title?.contains(query, ignoreCase = true) == true - private fun StoryIdea.displayTitle(): String = title ?: content.firstNonBlankLine() private fun applySort(ideas: List, mode: IdeasSortMode): List = when (mode) { @@ -246,12 +223,10 @@ fun StoryIdeasUi( contentKey = { it != null }, label = "StoryIdeasEditorSwap", ) { editor -> - val draft = state.draft - if (editor != null && draft != null) { + if (editor != null) { IdeaDetail( component = component, editor = editor, - draft = draft, rootSnackbar = rootSnackbar, sharedTransitionScope = this@SharedTransitionLayout, animatedVisibilityScope = this@AnimatedContent, @@ -280,12 +255,8 @@ private fun IdeasBrowse( val isWide = screen.isWide var searchQuery by rememberSaveable { mutableStateOf("") } - var sortMode by rememberSaveable(stateSaver = IdeasSortModeSaver) { - mutableStateOf(IdeasSortMode.DateDesc) - } - var activeTags by rememberSaveable(stateSaver = TagSetSaver) { - mutableStateOf>(emptySet()) - } + var sortMode by remember { mutableStateOf(IdeasSortMode.DateDesc) } + var activeTags by remember { mutableStateOf>(emptySet()) } var showArchived by rememberSaveable { mutableStateOf(false) } var showSearchBar by rememberSaveable { mutableStateOf(false) } @@ -313,7 +284,10 @@ private fun IdeasBrowse( val byText = if (query.isBlank()) { scopedIdeas } else { - scopedIdeas.filter { ideaMatchesQuery(it, query) } + scopedIdeas.filter { idea -> + idea.content.contains(query, ignoreCase = true) || + idea.title?.contains(query, ignoreCase = true) == true + } } val byTags = if (activeTags.isEmpty()) { byText @@ -476,56 +450,47 @@ private fun IdeasBrowse( ) } - val gridState = rememberLazyStaggeredGridState() - Box(modifier = Modifier.weight(1f)) { - LazyVerticalStaggeredGrid( - state = gridState, - columns = StaggeredGridCells.Adaptive(400.dp), - modifier = Modifier.fillMaxSize(), - contentPadding = PaddingValues( - horizontal = Ui.Padding.XL, - vertical = Ui.Padding.L, - ), - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - if (visibleIdeas.isEmpty()) { - item(span = StaggeredGridItemSpan.FullLine) { - Box( - modifier = Modifier - .fillMaxWidth() - .padding(vertical = Ui.Padding.XXL), - contentAlignment = Alignment.Center, - ) { - Text( - text = (if (showArchived) Res.string.ideas_list_empty_archived - else Res.string.ideas_list_empty).get(), - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } + LazyVerticalStaggeredGrid( + columns = StaggeredGridCells.Adaptive(400.dp), + modifier = Modifier.fillMaxSize(), + contentPadding = PaddingValues( + horizontal = Ui.Padding.XL, + vertical = Ui.Padding.L, + ), + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), + ) { + if (visibleIdeas.isEmpty()) { + item(span = StaggeredGridItemSpan.FullLine) { + Box( + modifier = Modifier + .fillMaxWidth() + .padding(vertical = Ui.Padding.XXL), + contentAlignment = Alignment.Center, + ) { + Text( + text = (if (showArchived) Res.string.ideas_list_empty_archived + else Res.string.ideas_list_empty).get(), + style = MaterialTheme.typography.headlineSmall, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) } } - - staggeredItems( - items = visibleIdeas, - key = { idea -> idea.id.id }, - ) { idea -> - IdeaCard( - idea = idea, - activeTags = activeTags, - onTagClick = toggleTag, - sharedTransitionScope = sharedTransitionScope, - animatedVisibilityScope = animatedVisibilityScope, - modifier = Modifier.padding(bottom = Ui.Padding.L), - onClick = { component.editIdea(idea.id) }, - ) - } } - MpScrollBarStaggeredGrid( - modifier = scrollBarOverlay(), - state = gridState, - ) + staggeredItems( + items = visibleIdeas, + key = { idea -> idea.id.id }, + ) { idea -> + IdeaCard( + idea = idea, + activeTags = activeTags, + onTagClick = toggleTag, + sharedTransitionScope = sharedTransitionScope, + animatedVisibilityScope = animatedVisibilityScope, + modifier = Modifier.padding(bottom = Ui.Padding.L), + onClick = { component.editIdea(idea.id) }, + ) + } } } @@ -670,7 +635,6 @@ private fun IdeaStamps(idea: StoryIdea) { private fun IdeaDetail( component: StoryIdeas, editor: StoryIdeas.Editor, - draft: StoryIdeas.Draft, rootSnackbar: RootSnackbarHostState, sharedTransitionScope: SharedTransitionScope, animatedVisibilityScope: AnimatedVisibilityScope, @@ -682,18 +646,34 @@ private fun IdeaDetail( val existing = (editor as? StoryIdeas.Editor.Edit)?.idea val isCreate = existing == null - // The draft lives in the component so a configuration change can't take unsaved text with it. - val isEditing = draft.isEditing - val isDirty = draft.isDirty + // Creating starts straight in edit mode; an existing idea opens read-only. + var isEditing by rememberSaveable(editor) { mutableStateOf(isCreate) } + var titleText by remember(editor) { mutableStateOf(existing?.title.orEmpty()) } + var contentText by remember(editor) { mutableStateOf(existing?.content.orEmpty()) } + var tags by remember(editor) { mutableStateOf(existing?.tags?.toList().orEmpty()) } + // A tag typed into the field but not yet committed with Enter/comma; folded in on save + // so it can't be silently dropped. + var tagDraft by remember(editor) { mutableStateOf("") } + // The view body reflects saved edits without waiting for the state flow to round-trip. + var savedTitle by remember(editor) { mutableStateOf(existing?.title) } + var savedContent by remember(editor) { mutableStateOf(existing?.content.orEmpty()) } + var savedTags by remember(editor) { mutableStateOf(existing?.tags ?: emptySet()) } - var confirmDelete by rememberSaveable { mutableStateOf(false) } - var confirmDiscard by rememberSaveable { mutableStateOf(false) } - var confirmClose by rememberSaveable { mutableStateOf(false) } - var confirmPromote by rememberSaveable { mutableStateOf(false) } + var confirmDelete by remember { mutableStateOf(false) } + var confirmDiscard by remember { mutableStateOf(false) } + var confirmClose by remember { mutableStateOf(false) } + var confirmPromote by remember { mutableStateOf(false) } - val charCount = draft.content.length + val isDirty = isEditing && ( + titleText != savedTitle.orEmpty() || + contentText != savedContent || + tags.toSet() != savedTags || + tagDraft.isNotBlank() + ) + + val charCount = contentText.length val overLimit = charCount > StoryIdea.MAX_CONTENT_LENGTH - val canSave = draft.content.isNotBlank() && !overLimit + val canSave = contentText.isNotBlank() && !overLimit suspend fun showError(error: IdeaError) { when (error) { @@ -713,20 +693,43 @@ private fun IdeaDetail( val saveChanges: () -> Unit = { scope.launch { - when (val result = component.saveDraft()) { - StoryIdeas.SaveResult.Created -> + val title = titleText.trim().ifEmpty { null } + val pendingTag = tagDraft.trim().removePrefix("#") + val allTags = if (pendingTag.isEmpty()) tags.toSet() else tags.toSet() + pendingTag + val error = if (existing == null) { + component.createIdea(title, contentText, allTags) + } else { + component.saveIdea(existing.id, title, contentText, allTags) + } + if (error == IdeaError.NONE) { + if (isCreate) { + withContext(mainDispatcher) { component.closeEditor() } rootSnackbar.showSnackbar(strRes.get(Res.string.ideas_toast_created)) - - StoryIdeas.SaveResult.Saved -> + } else { + withContext(mainDispatcher) { + savedTitle = title + savedContent = contentText + savedTags = allTags + tags = allTags.toList() + tagDraft = "" + isEditing = false + } rootSnackbar.showSnackbar(strRes.get(Res.string.ideas_toast_saved)) - - is StoryIdeas.SaveResult.Failed -> showError(result.error) + } + } else { + showError(error) } } } val cancelEdit: () -> Unit = { - if (isDirty) confirmDiscard = true else component.discardEdit() + if (isDirty) { + confirmDiscard = true + } else if (isCreate) { + component.closeEditor() + } else { + isEditing = false + } } val requestClose: () -> Unit = { @@ -820,7 +823,7 @@ private fun IdeaDetail( idea = existing, sharedTransitionScope = sharedTransitionScope, animatedVisibilityScope = animatedVisibilityScope, - onEdit = component::beginEdit, + onEdit = { isEditing = true }, onSave = saveChanges, onCancel = cancelEdit, onPromote = { confirmPromote = true }, @@ -834,13 +837,13 @@ private fun IdeaDetail( if (isEditing) { EditBody( - titleText = draft.title, - onTitleChanged = component::updateTitle, - tags = draft.tags, - onTagsChanged = component::updateTags, - onTagDraftChanged = component::updateTagDraft, - contentText = draft.content, - onContentChanged = component::updateContent, + titleText = titleText, + onTitleChanged = { titleText = it }, + tags = tags, + onTagsChanged = { tags = it }, + onTagDraftChanged = { tagDraft = it }, + contentText = contentText, + onContentChanged = { contentText = it }, suggestTags = component::suggestTags, modifier = Modifier.weight(1f), ) @@ -848,17 +851,17 @@ private fun IdeaDetail( EditStatusFooter(charCount = charCount, overLimit = overLimit) } else { ViewBody( - title = draft.savedTitle, - markdown = draft.savedContent, - tags = draft.savedTags, + title = savedTitle, + markdown = savedContent, + tags = savedTags, idea = existing, sharedTransitionScope = sharedTransitionScope, animatedVisibilityScope = animatedVisibilityScope, - onEnterEdit = component::beginEdit, + onEnterEdit = { isEditing = true }, modifier = Modifier.weight(1f, fill = false), ) - ViewFolioFooter(markdown = draft.savedContent, tagCount = draft.savedTags.size) + ViewFolioFooter(markdown = savedContent, tagCount = savedTags.size) } } } @@ -876,7 +879,10 @@ private fun IdeaDetail( if (confirmClose || isCreate) { component.closeEditor() } else { - component.discardEdit() + titleText = savedTitle.orEmpty() + contentText = savedContent + tags = savedTags.toList() + isEditing = false } confirmDiscard = false confirmClose = false @@ -1067,84 +1073,77 @@ private fun ViewBody( modifier: Modifier = Modifier, ) = with(sharedTransitionScope) { val scrollState = rememberScrollState() - Box(modifier = modifier) { - Column( - modifier = Modifier - .fillMaxWidth() - .verticalScroll(scrollState) - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), - ) { - title?.let { - Text( - text = it, - style = MaterialTheme.typography.headlineSmall, - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier - .padding(bottom = Ui.Padding.M) - .then( - if (idea != null) { - Modifier.sharedElement( - sharedContentState = rememberSharedContentState( - key = "idea-title-${idea.id.id}", - ), - animatedVisibilityScope = animatedVisibilityScope, - ) - } else { - Modifier - } - ), - ) - } - - idea?.let { IdeaStamps(it) } - - if (tags.isNotEmpty()) { - FlowRow( - modifier = Modifier - .fillMaxWidth() - .padding(top = Ui.Padding.M, bottom = Ui.Padding.L), - horizontalArrangement = Arrangement.spacedBy(6.dp), - verticalArrangement = Arrangement.spacedBy(6.dp), - ) { - tags.sorted().forEach { tag -> - HdTagChip( - label = tag, - active = true, - onClick = {}, - ) - } - } - - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - modifier = Modifier.padding(bottom = Ui.Padding.L), - ) - } - - MarkdownView( - markdown = markdown, + Column( + modifier = modifier + .fillMaxWidth() + .verticalScroll(scrollState) + .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), + ) { + title?.let { + Text( + text = it, + style = MaterialTheme.typography.headlineSmall, + color = MaterialTheme.colorScheme.onSurface, modifier = Modifier - .fillMaxWidth() + .padding(bottom = Ui.Padding.M) .then( if (idea != null) { Modifier.sharedElement( sharedContentState = rememberSharedContentState( - key = "idea-content-${idea.id.id}", + key = "idea-title-${idea.id.id}", ), animatedVisibilityScope = animatedVisibilityScope, ) } else { Modifier } - ) - .clickable(onClick = onEnterEdit), + ), ) } - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, + idea?.let { IdeaStamps(it) } + + if (tags.isNotEmpty()) { + FlowRow( + modifier = Modifier + .fillMaxWidth() + .padding(top = Ui.Padding.M, bottom = Ui.Padding.L), + horizontalArrangement = Arrangement.spacedBy(6.dp), + verticalArrangement = Arrangement.spacedBy(6.dp), + ) { + tags.sorted().forEach { tag -> + HdTagChip( + label = tag, + active = true, + onClick = {}, + ) + } + } + + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + modifier = Modifier.padding(bottom = Ui.Padding.L), + ) + } + + MarkdownView( + markdown = markdown, + modifier = Modifier + .fillMaxWidth() + .then( + if (idea != null) { + Modifier.sharedElement( + sharedContentState = rememberSharedContentState( + key = "idea-content-${idea.id.id}", + ), + animatedVisibilityScope = animatedVisibilityScope, + ) + } else { + Modifier + } + ) + .clickable(onClick = onEnterEdit), ) } } @@ -1170,7 +1169,6 @@ private fun EditBody( onValueChange = onTitleChanged, placeholder = Res.string.ideas_title_placeholder.get(), onFocusChanged = { titleFocused = it }, - testTag = IDEAS_EDITOR_TITLE_TAG, modifier = Modifier .fillMaxWidth() .padding(horizontal = Ui.Padding.XL) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ConflictCommon.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ConflictCommon.kt index ae3484e5d..ebc6acf74 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ConflictCommon.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ConflictCommon.kt @@ -14,8 +14,8 @@ import androidx.compose.foundation.text.selection.SelectionContainer import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/EncyclopediaEntryConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/EncyclopediaEntryConflict.kt index a1870df0c..45d72e72c 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/EncyclopediaEntryConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/EncyclopediaEntryConflict.kt @@ -14,7 +14,7 @@ import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.verticalScroll import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/NoteConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/NoteConflict.kt index 03db224de..75ebb0f9e 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/NoteConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/NoteConflict.kt @@ -6,7 +6,7 @@ import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.padding import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.verticalScroll -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectDataConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectDataConflict.kt index c08157484..16fdd12b5 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectDataConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectDataConflict.kt @@ -13,8 +13,8 @@ import androidx.compose.foundation.selection.selectable import androidx.compose.foundation.verticalScroll import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf @@ -36,22 +36,14 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdConflictFie import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.data.projectdata.mergeDictionaryWords import com.darkrockstudios.apps.hammer.sync_conflict_project_data_cadence_day import com.darkrockstudios.apps.hammer.sync_conflict_project_data_cadence_week -import com.darkrockstudios.apps.hammer.sync_conflict_project_data_dictionary_merged import com.darkrockstudios.apps.hammer.sync_conflict_project_data_explanation -import com.darkrockstudios.apps.hammer.common.spellcheck.displayName -import com.darkrockstudios.apps.hammer.common.util.Locale import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_author -import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_dictionary -import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_language import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_tags import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_theme import com.darkrockstudios.apps.hammer.sync_conflict_project_data_field_word_goal import com.darkrockstudios.apps.hammer.sync_conflict_project_data_resolve_button -import com.darkrockstudios.apps.hammer.sync_conflict_project_data_value_off -import com.darkrockstudios.apps.hammer.sync_conflict_project_data_value_on import com.darkrockstudios.apps.hammer.sync_conflict_project_data_value_unset import com.darkrockstudios.apps.hammer.sync_conflict_tab_local import com.darkrockstudios.apps.hammer.sync_conflict_tab_remote @@ -68,20 +60,13 @@ internal fun ProjectDataConflict( var themeChoice by remember { mutableStateOf(DataChoice.LOCAL) } var goalChoice by remember { mutableStateOf(DataChoice.LOCAL) } var tagsChoice by remember { mutableStateOf(DataChoice.LOCAL) } - var languageChoice by remember { mutableStateOf(DataChoice.LOCAL) } - var dictionaryChoice by remember { mutableStateOf(DataChoice.LOCAL) } val authorConflict = conflictState.local.authorName != conflictState.server.authorName val themeConflict = conflictState.local.theme != conflictState.server.theme val goalConflict = conflictState.local.wordCountGoal != conflictState.server.wordCountGoal val tagsConflict = conflictState.local.tags != conflictState.server.tags - val languageConflict = conflictState.local.language != conflictState.server.language - val dictionaryConflict = - conflictState.local.encyclopediaDictionary != conflictState.server.encyclopediaDictionary val unsetLabel = Res.string.sync_conflict_project_data_value_unset.get() - val onLabel = Res.string.sync_conflict_project_data_value_on.get() - val offLabel = Res.string.sync_conflict_project_data_value_off.get() val localLabel = Res.string.sync_conflict_tab_local.get() val remoteLabel = Res.string.sync_conflict_tab_remote.get() val dayLabel = Res.string.sync_conflict_project_data_cadence_day.get() @@ -149,38 +134,6 @@ internal fun ProjectDataConflict( stackVertical = stackVertical, ) - PerFieldChoice( - label = Res.string.sync_conflict_project_data_field_language.get(), - conflict = languageConflict, - localValue = displayLanguage(conflictState.local.language, unsetLabel), - serverValue = displayLanguage(conflictState.server.language, unsetLabel), - selected = languageChoice, - onSelect = { languageChoice = it }, - localLabel = localLabel, - remoteLabel = remoteLabel, - stackVertical = stackVertical, - ) - - PerFieldChoice( - label = Res.string.sync_conflict_project_data_field_dictionary.get(), - conflict = dictionaryConflict, - localValue = if (conflictState.local.encyclopediaDictionary) onLabel else offLabel, - serverValue = if (conflictState.server.encyclopediaDictionary) onLabel else offLabel, - selected = dictionaryChoice, - onSelect = { dictionaryChoice = it }, - localLabel = localLabel, - remoteLabel = remoteLabel, - stackVertical = stackVertical, - ) - - if (conflictState.local.dictionaryWords != conflictState.server.dictionaryWords) { - Text( - text = Res.string.sync_conflict_project_data_dictionary_merged.get(), - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - Row( modifier = Modifier.fillMaxWidth(), horizontalArrangement = Arrangement.End, @@ -196,8 +149,6 @@ internal fun ProjectDataConflict( themeChoice = themeChoice, goalChoice = goalChoice, tagsChoice = tagsChoice, - languageChoice = languageChoice, - dictionaryChoice = dictionaryChoice, ) ) }, @@ -300,16 +251,11 @@ private fun buildResolved( themeChoice: DataChoice, goalChoice: DataChoice, tagsChoice: DataChoice, - languageChoice: DataChoice, - dictionaryChoice: DataChoice, ): ProjectData = ProjectData( authorName = if (authorChoice == DataChoice.LOCAL) local.authorName else server.authorName, theme = if (themeChoice == DataChoice.LOCAL) local.theme else server.theme, wordCountGoal = if (goalChoice == DataChoice.LOCAL) local.wordCountGoal else server.wordCountGoal, tags = if (tagsChoice == DataChoice.LOCAL) local.tags else server.tags, - language = if (languageChoice == DataChoice.LOCAL) local.language else server.language, - encyclopediaDictionary = if (dictionaryChoice == DataChoice.LOCAL) local.encyclopediaDictionary else server.encyclopediaDictionary, - dictionaryWords = mergeDictionaryWords(local, server), ) private fun displayString(value: String?, unsetLabel: String): String = @@ -321,9 +267,6 @@ private fun displayTheme(theme: ProjectTheme?, unsetLabel: String): String = private fun displayTags(tags: Set, unsetLabel: String): String = if (tags.isEmpty()) unsetLabel else tags.sorted().joinToString(" ") { "#$it" } -private fun displayLanguage(tag: String?, unsetLabel: String): String = - if (tag.isNullOrBlank()) unsetLabel else Locale.forLanguageTag(tag).displayName() - private fun displayWordGoal(goal: WordCountGoal?, unsetLabel: String, dayLabel: String, weekLabel: String): String { if (goal == null) return unsetLabel val cadence = when (goal.cadence) { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectSynchronizationUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectSynchronizationUi.kt index 8da1b4228..1ee78f0e1 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectSynchronizationUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/ProjectSynchronizationUi.kt @@ -10,8 +10,9 @@ import androidx.compose.foundation.lazy.rememberLazyListState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Info import androidx.compose.material3.* -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass -import com.darkrockstudios.apps.hammer.common.compose.rememberWindowSizeClass +import androidx.compose.material3.windowsizeclass.ExperimentalMaterial3WindowSizeClassApi +import androidx.compose.material3.windowsizeclass.WindowSizeClass +import androidx.compose.material3.windowsizeclass.calculateWindowSizeClass import androidx.compose.runtime.* import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Alignment @@ -35,6 +36,7 @@ import kotlinx.coroutines.withContext private val DialogMaxWidth = 800.dp private val DialogBodyMinHeight = 280.dp +@OptIn(ExperimentalMaterial3WindowSizeClassApi::class) @Composable internal fun ProjectSynchronization( component: ProjectSynchronization, @@ -57,15 +59,14 @@ internal fun ProjectSynchronization( onClosed = { component.endSync() }, properties = DialogProperties(usePlatformDefaultWidth = false), ) { - BoxWithConstraints { - ProjectSynchronizationContent( - component = component, - showSnackbar = showSnackbar, - screenCharacteristics = rememberWindowSizeClass(constraints), - modifier = Modifier.predictiveBackTransform(), - onClose = requestClose, - ) - } + val screenCharacteristics = calculateWindowSizeClass() + ProjectSynchronizationContent( + component = component, + showSnackbar = showSnackbar, + screenCharacteristics = screenCharacteristics, + modifier = Modifier.predictiveBackTransform(), + onClose = requestClose, + ) } if (confirmCancel) { diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneConflict.kt index c9d553286..e0a9ca893 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneConflict.kt @@ -6,7 +6,7 @@ import androidx.compose.foundation.layout.* import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.verticalScroll import androidx.compose.material3.MaterialTheme -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.* import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Modifier diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneDraftConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneDraftConflict.kt index debcbe55f..5ac96cc24 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneDraftConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/SceneDraftConflict.kt @@ -6,7 +6,7 @@ import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.padding import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.verticalScroll -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/TimelineEventConflict.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/TimelineEventConflict.kt index a7b56f238..afcba128f 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/TimelineEventConflict.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/projectsync/TimelineEventConflict.kt @@ -6,7 +6,7 @@ import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.padding import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.verticalScroll -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/reauthentication/ReauthenticationUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/reauthentication/ReauthenticationUi.kt index 47e37bdfb..43b867ac3 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/reauthentication/ReauthenticationUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/reauthentication/ReauthenticationUi.kt @@ -10,6 +10,10 @@ import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape +import androidx.compose.ui.text.input.ImeAction +import androidx.compose.ui.text.input.KeyboardType +import androidx.compose.ui.text.input.PasswordVisualTransformation +import androidx.compose.ui.text.input.VisualTransformation import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import androidx.compose.ui.window.DialogProperties @@ -137,16 +141,29 @@ internal fun ReauthenticationContent( selectable = true, ) - HdPasswordField( + HdHairlineField( label = Res.string.settings_server_setup_password_hint.get(), value = state.serverPassword, onValueChange = onPasswordChange, - visible = passwordVisible, - onVisibleChange = onPasswordVisibleChange, placeholder = Res.string.settings_server_setup_password_hint.get(), + singleLine = true, + imeAction = ImeAction.Done, + keyboardType = KeyboardType.Password, + visualTransformation = if (passwordVisible) VisualTransformation.None + else PasswordVisualTransformation(), enabled = !state.serverWorking, ) + HdHairlineToggleRow( + checked = passwordVisible, + onCheckedChange = onPasswordVisibleChange, + label = if (passwordVisible) { + Res.string.settings_server_setup_password_hide.get() + } else { + Res.string.settings_server_setup_password_show.get() + }, + ) + state.serverError?.let { error -> HdMonoLabel( text = "! $error", diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/OutlineOverviewUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/OutlineOverviewUi.kt index d7d3fe0d3..312530b29 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/OutlineOverviewUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/OutlineOverviewUi.kt @@ -1,5 +1,7 @@ package com.darkrockstudios.apps.hammer.common.storyeditor +import androidx.compose.animation.* +import androidx.compose.animation.core.animateFloatAsState import androidx.compose.foundation.background import androidx.compose.foundation.border import androidx.compose.foundation.clickable @@ -11,35 +13,30 @@ import androidx.compose.foundation.lazy.itemsIndexed import androidx.compose.foundation.lazy.rememberLazyListState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Close +import androidx.compose.material.icons.filled.KeyboardArrowDown import androidx.compose.material3.* import androidx.compose.runtime.* import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.rotate import androidx.compose.ui.graphics.RectangleShape import androidx.compose.ui.input.pointer.pointerInput import androidx.compose.ui.text.font.FontStyle import androidx.compose.ui.text.font.FontWeight import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.text.style.TextOverflow import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.* import com.darkrockstudios.apps.hammer.common.components.storyeditor.outlineoverview.OutlineOverview import com.darkrockstudios.apps.hammer.common.compose.AnimatedFullScreenDialog -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarGutter -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterDropdown -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterHeader -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterRailItem -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterRow -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEndMark import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSceneBreak import com.darkrockstudios.apps.hammer.common.compose.designsystem.romanNumeral import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.data.SceneItem import kotlinx.coroutines.launch @@ -49,9 +46,7 @@ private const val FRONTISPIECE_ITEM_COUNT = 1 private data class OutlineChapter( val chapter: OutlineOverview.OutlineItem.ChapterOutline?, val scenes: List, -) { - fun title(untitled: String): String = chapter?.sceneItem?.name ?: untitled -} +) private fun groupByChapter(items: List): List { if (items.isEmpty()) return emptyList() @@ -104,10 +99,6 @@ fun OutlineOverviewContent( val state by component.state.subscribeAsState() val chapters = remember(state.overview) { groupByChapter(state.overview) } - val untitled = untitledChapter() - val chapterRows = remember(chapters, untitled) { - chapters.map { HdChapterRow(title = it.title(untitled), sceneCount = it.scenes.size) } - } val totalScenes = remember(chapters) { chapters.sumOf { it.scenes.size } } val totalChapters = chapters.count { it.chapter != null } @@ -181,7 +172,7 @@ fun OutlineOverviewContent( .fillMaxWidth(), ) { ChapterRail( - chapters = chapterRows, + chapters = chapters, activeChapterIndex = activeChapterIndex, onJumpTo = scrollToChapter, modifier = Modifier @@ -204,10 +195,10 @@ fun OutlineOverviewContent( ) } } else { - HdChapterDropdown( - rows = chapterRows, - selectedIndex = activeChapterIndex, - onSelect = scrollToChapter, + ChapterDropdown( + chapters = chapters, + activeChapterIndex = activeChapterIndex, + onJumpTo = scrollToChapter, ) ReadingColumn( chapters = chapters, @@ -316,7 +307,7 @@ private fun CloseButton(onClose: () -> Unit) { @Composable private fun ChapterRail( - chapters: List, + chapters: List, activeChapterIndex: Int, onJumpTo: (Int) -> Unit, modifier: Modifier = Modifier, @@ -333,27 +324,86 @@ private fun ChapterRail( bottom = Ui.Padding.M, ), ) - val railState = rememberLazyListState() - Box { - LazyColumn( - modifier = Modifier.fillMaxSize(), - state = railState, - contentPadding = PaddingValues(end = MpScrollBarGutter), - ) { - itemsIndexed(chapters, key = { idx, _ -> "rail-$idx" }) { index, ch -> - HdChapterRailItem( - index = index, - row = ch, - selected = index == activeChapterIndex, - onClick = { onJumpTo(index) }, - ) - } + LazyColumn(modifier = Modifier.fillMaxSize()) { + itemsIndexed(chapters, key = { idx, _ -> "rail-$idx" }) { index, ch -> + ChapterRailItem( + index = index, + chapter = ch, + selected = index == activeChapterIndex, + onClick = { onJumpTo(index) }, + ) } + } + } +} - MpScrollBarList( - modifier = scrollBarOverlay(), - state = railState, +@Composable +private fun ChapterRailItem( + index: Int, + chapter: OutlineChapter, + selected: Boolean, + onClick: () -> Unit, +) { + val accent = MaterialTheme.colorScheme.primary + val rowBg = if (selected) { + MaterialTheme.colorScheme.surfaceContainer + } else { + MaterialTheme.colorScheme.surfaceContainerLow + } + + Row( + modifier = Modifier + .fillMaxWidth() + .height(IntrinsicSize.Min) + .background(rowBg) + .clickable(onClick = onClick), + verticalAlignment = Alignment.Top, + ) { + Box( + modifier = Modifier + .width(2.dp) + .fillMaxHeight() + .background(if (selected) accent else androidx.compose.ui.graphics.Color.Transparent), + ) + Row( + modifier = Modifier + .fillMaxWidth() + .padding( + start = Ui.Padding.L, + end = Ui.Padding.XL, + top = Ui.Padding.L, + bottom = Ui.Padding.L, + ), + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), + verticalAlignment = Alignment.Top, + ) { + Text( + text = romanNumeral(index + 1), + style = MaterialTheme.typography.titleLarge, + fontWeight = FontWeight.Light, + color = if (selected) { + MaterialTheme.colorScheme.onSurface + } else { + MaterialTheme.colorScheme.onSurfaceVariant + }, + modifier = Modifier.widthIn(min = 24.dp), ) + Column( + modifier = Modifier.weight(1f), + verticalArrangement = Arrangement.spacedBy(2.dp), + ) { + Text( + text = chapter.chapter?.sceneItem?.name ?: untitledChapter(), + style = MaterialTheme.typography.titleSmall, + fontWeight = if (selected) FontWeight.Medium else FontWeight.Normal, + color = MaterialTheme.colorScheme.onSurface, + maxLines = 1, + overflow = TextOverflow.Ellipsis, + ) + HdMonoLabel( + text = Res.string.scene_list_outline_overview_scene_count.get(chapter.scenes.size), + ) + } } } } @@ -362,6 +412,103 @@ private fun ChapterRail( private fun untitledChapter(): String = Res.string.scene_list_outline_overview_untitled_chapter.get() +@Composable +private fun ChapterDropdown( + chapters: List, + activeChapterIndex: Int, + onJumpTo: (Int) -> Unit, +) { + var expanded by remember { mutableStateOf(false) } + val rotation by animateFloatAsState( + targetValue = if (expanded) 180f else 0f, + label = "outlineChapterDropdownRotation", + ) + val current = chapters.getOrNull(activeChapterIndex) + + Column(modifier = Modifier.fillMaxWidth()) { + Row( + modifier = Modifier + .fillMaxWidth() + .background(MaterialTheme.colorScheme.surfaceContainerLow) + .clickable { expanded = !expanded } + .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.L), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), + ) { + HdMonoLabel(text = Res.string.scene_list_outline_overview_jump_to.get()) + Row( + modifier = Modifier.weight(1f), + verticalAlignment = Alignment.Bottom, + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), + ) { + Text( + text = romanNumeral(activeChapterIndex + 1), + style = MaterialTheme.typography.titleMedium, + fontWeight = FontWeight.Light, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) + Text( + text = current?.chapter?.sceneItem?.name ?: untitledChapter(), + style = MaterialTheme.typography.titleMedium, + fontWeight = FontWeight.Medium, + color = MaterialTheme.colorScheme.onSurface, + maxLines = 1, + overflow = TextOverflow.Ellipsis, + ) + } + HdMonoLabel( + text = Res.string.scene_list_outline_overview_position.get( + activeChapterIndex + 1, + chapters.size, + ), + ) + Icon( + imageVector = Icons.Default.KeyboardArrowDown, + contentDescription = null, + tint = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier + .size(20.dp) + .rotate(rotation), + ) + } + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + + AnimatedVisibility( + visible = expanded, + enter = expandVertically() + fadeIn(), + exit = shrinkVertically() + fadeOut(), + ) { + Column( + modifier = Modifier + .fillMaxWidth() + .heightIn(max = 320.dp) + .background(MaterialTheme.colorScheme.surface), + ) { + LazyColumn(modifier = Modifier.fillMaxWidth()) { + itemsIndexed(chapters, key = { idx, _ -> "drop-$idx" }) { idx, ch -> + ChapterRailItem( + index = idx, + chapter = ch, + selected = idx == activeChapterIndex, + onClick = { + onJumpTo(idx) + expanded = false + }, + ) + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + } + } + } + } + } +} + @Composable private fun ReadingColumn( chapters: List, @@ -372,38 +519,31 @@ private fun ReadingColumn( modifier: Modifier = Modifier, ) { val horizontalPad = if (wide) Ui.Padding.XXL else Ui.Padding.XL - Box(modifier = modifier) { - LazyColumn( - modifier = Modifier.fillMaxSize(), - state = listState, - contentPadding = PaddingValues( - start = horizontalPad, - end = horizontalPad, - top = Ui.Padding.XXL, - bottom = Ui.Padding.XXL, - ), - ) { - item(key = "frontispiece") { - Frontispiece(projectName = projectName) - } - itemsIndexed(chapters, key = { idx, _ -> "ch-$idx" }) { index, ch -> - ChapterBlock( - chapterIndex = index, - chapter = ch, - showSeparator = index < chapters.size - 1, - wide = wide, - onSceneClick = onSceneClick, - ) - } - item(key = "end") { - HdEndMark(label = Res.string.scene_list_outline_overview_end.get()) - } + LazyColumn( + modifier = modifier, + state = listState, + contentPadding = PaddingValues( + start = horizontalPad, + end = horizontalPad, + top = Ui.Padding.XXL, + bottom = Ui.Padding.XXL, + ), + ) { + item(key = "frontispiece") { + Frontispiece(projectName = projectName) + } + itemsIndexed(chapters, key = { idx, _ -> "ch-$idx" }) { index, ch -> + ChapterBlock( + chapterIndex = index, + chapter = ch, + showSeparator = index < chapters.size - 1, + wide = wide, + onSceneClick = onSceneClick, + ) + } + item(key = "end") { + EndOfOutline() } - - MpScrollBarList( - modifier = scrollBarOverlay(), - state = listState, - ) } } @@ -458,10 +598,9 @@ private fun ChapterBlock( } Column(modifier = Modifier.fillMaxWidth().padding(bottom = 48.dp)) { - HdChapterHeader( + ChapterHeader( index = chapterIndex, - title = chapter.title(untitledChapter()), - sceneCount = chapter.scenes.size, + chapter = chapter, wide = wide, ) Spacer(Modifier.height(Ui.Padding.XXL)) @@ -481,11 +620,52 @@ private fun ChapterBlock( } if (showSeparator) { Spacer(Modifier.height(Ui.Padding.XXL)) - HdSceneBreak() + Box( + modifier = Modifier.fillMaxWidth(), + contentAlignment = Alignment.Center, + ) { + Text( + text = "· · ·", + style = MaterialTheme.typography.titleLarge.copy(letterSpacing = 8.sp), + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) + } } } } +@Composable +private fun ChapterHeader( + index: Int, + chapter: OutlineChapter, + wide: Boolean, +) { + val titleStyle = if (wide) { + MaterialTheme.typography.headlineLarge + } else { + MaterialTheme.typography.headlineMedium + } + Column(verticalArrangement = Arrangement.spacedBy(Ui.Padding.M)) { + HdMonoLabel( + text = Res.string.scene_list_outline_overview_chapter_eyebrow.get( + romanNumeral(index + 1), + chapter.scenes.size, + ), + ) + Text( + text = chapter.chapter?.sceneItem?.name ?: untitledChapter(), + style = titleStyle, + fontWeight = FontWeight.Light, + color = MaterialTheme.colorScheme.onSurface, + ) + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + modifier = Modifier.padding(top = Ui.Padding.M), + ) + } +} + @Composable private fun SceneBlock( chapterRoman: String, @@ -534,6 +714,21 @@ private fun SceneBlock( } } +@Composable +private fun EndOfOutline() { + Column( + modifier = Modifier.fillMaxWidth().padding(top = Ui.Padding.L), + horizontalAlignment = Alignment.CenterHorizontally, + verticalArrangement = Arrangement.spacedBy(Ui.Padding.L), + ) { + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + HdMonoLabel(text = Res.string.scene_list_outline_overview_end.get()) + } +} + @Composable private fun EmptyOutline(modifier: Modifier = Modifier) { Box( diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/StoryEditorUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/StoryEditorUi.kt index 7b22bcf4e..70d6e3cf5 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/StoryEditorUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/StoryEditorUi.kt @@ -30,7 +30,6 @@ import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.rightBorder import com.darkrockstudios.apps.hammer.common.storyeditor.drafts.DraftCompareUi import com.darkrockstudios.apps.hammer.common.storyeditor.drafts.DraftsListUi -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.ReaderModeUi import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.SceneEditorUi import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.SceneListUi import com.darkrockstudios.apps.hammer.scene_editor_no_scene_selected @@ -192,10 +191,6 @@ private fun DetailsPane( is StoryEditor.ChildDestination.Detail.DraftCompareDestination -> { DraftCompareUi(component = child.component) } - - is StoryEditor.ChildDestination.Detail.ReaderDestination -> { - ReaderModeUi(component = child.component) - } } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/drafts/DraftCompareUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/drafts/DraftCompareUi.kt index 7f178a4a9..ac80350e2 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/drafts/DraftCompareUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/drafts/DraftCompareUi.kt @@ -5,8 +5,7 @@ import androidx.compose.foundation.layout.* import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.material3.VerticalDivider -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.* import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Modifier @@ -22,20 +21,14 @@ import com.darkrockstudios.apps.hammer.base.diff.OffsetMap import com.darkrockstudios.apps.hammer.common.components.storyeditor.drafts.DraftCompare import com.darkrockstudios.apps.hammer.common.compose.* import com.darkrockstudios.apps.hammer.common.compose.designsystem.* -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles +import com.darkrockstudios.apps.hammer.common.compose.markdown.updateMarkdownConfiguration import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors -import com.darkrockstudios.apps.hammer.common.data.SceneContent -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.loadSceneContent -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.sceneDiffText +import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.getInitialEditorContent import com.darkrockstudios.texteditor.CharLineOffset -import com.darkrockstudios.texteditor.RichTextStyles import com.darkrockstudios.texteditor.TextEditor import com.darkrockstudios.texteditor.TextEditorRange -import com.darkrockstudios.texteditor.markdown.MarkdownExtension import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.rememberTextEditorStyle import com.darkrockstudios.texteditor.richstyle.HighlightSpanStyle import com.darkrockstudios.texteditor.richstyle.RichSpan import com.darkrockstudios.texteditor.state.TextEditorState @@ -57,17 +50,6 @@ fun DraftCompareUi(component: DraftCompare) { val screen = LocalScreenCharacteristic.current val state by component.state.subscribeAsState() val draftName = component.draftDef.draftName - val richTextStyles = LocalRichTextStyles.current - - // Hoisted above the width branch: the two layouts are separate composables, so building - // the editors inside them would discard the user's merge edits on a resize or rotate - // while component.mergedContent still pointed at the torn-down editor. - val draftMarkdown = key(state.draftContent) { - rememberSceneContentEditor(state.draftContent, richTextStyles) - } - val currentMarkdown = key(state.sceneContent) { - rememberSceneContentEditor(state.sceneContent, richTextStyles) - } Column(modifier = Modifier.fillMaxSize()) { HdMasthead( @@ -87,44 +69,35 @@ fun DraftCompareUi(component: DraftCompare) { when (screen.windowWidthClass) { WindowWidthSizeClass.Compact, WindowWidthSizeClass.Medium -> { - CompactDraftCompareUi( - modifier = Modifier.fillMaxSize(), - component = component, - draftMarkdown = draftMarkdown, - currentMarkdown = currentMarkdown, - ) + CompactDraftCompareUi(Modifier.fillMaxSize(), component) } else -> { - ExpandedDraftCompareUi( - modifier = Modifier.fillMaxSize(), - component = component, - draftMarkdown = draftMarkdown, - currentMarkdown = currentMarkdown, - ) + ExpandedDraftCompareUi(Modifier.fillMaxSize(), component) } } } } @Composable -private fun CompactDraftCompareUi( - modifier: Modifier, - component: DraftCompare, - draftMarkdown: MarkdownExtension, - currentMarkdown: MarkdownExtension, -) { +private fun CompactDraftCompareUi(modifier: Modifier, component: DraftCompare) { var pane by rememberSaveable { mutableIntStateOf(PANE_DRAFT) } + val state by component.state.subscribeAsState() + val markdownConfig = LocalMarkdownConfig.current val draftLabel = Res.string.draft_compare_tab_title_draft.get() val currentLabel = Res.string.draft_compare_tab_title_current.get() - // Only one pane is composed at a time here, so the panes' own seeding effects can't - // be relied on to feed both sides of the diff. - LaunchedEffect(draftMarkdown) { - component.submitDraftText(sceneDiffText(draftMarkdown)) + val draftState = key(state.draftContent) { + rememberTextEditorState(getInitialEditorContent(state.draftContent, markdownConfig)) } - LaunchedEffect(currentMarkdown) { - component.onCurrentTextChanged(sceneDiffText(currentMarkdown)) + val currentState = key(state.sceneContent) { + rememberTextEditorState(getInitialEditorContent(state.sceneContent, markdownConfig)) + } + LaunchedEffect(draftState) { + component.submitDraftText(draftState.getAllText().text) + } + LaunchedEffect(currentState) { + component.onCurrentTextChanged(currentState.getAllText().text) } Column(modifier = modifier) { @@ -143,29 +116,32 @@ private fun CompactDraftCompareUi( modifier = Modifier.fillMaxSize(), sectionNumber = 1, component = component, - markdownExtension = draftMarkdown, + textEditorState = draftState, ) } else { CurrentPane( modifier = Modifier.fillMaxSize(), sectionNumber = 1, component = component, - markdownExtension = currentMarkdown, + textEditorState = currentState, ) } } } @Composable -private fun ExpandedDraftCompareUi( - modifier: Modifier, - component: DraftCompare, - draftMarkdown: MarkdownExtension, - currentMarkdown: MarkdownExtension, -) { +private fun ExpandedDraftCompareUi(modifier: Modifier, component: DraftCompare) { val state by component.state.subscribeAsState() - val draftState = draftMarkdown.editorState - val currentState = currentMarkdown.editorState + val markdownConfig = LocalMarkdownConfig.current + + // Hoist both editor states here so we can wire synchronized scrolling between the panes. + // Each is keyed on its content so it rebuilds when the draft / scene finishes loading. + val draftState = key(state.draftContent) { + rememberTextEditorState(getInitialEditorContent(state.draftContent, markdownConfig)) + } + val currentState = key(state.sceneContent) { + rememberTextEditorState(getInitialEditorContent(state.sceneContent, markdownConfig)) + } SyncScrolling( leftState = draftState, @@ -179,7 +155,7 @@ private fun ExpandedDraftCompareUi( modifier = Modifier.weight(1f).fillMaxHeight(), sectionNumber = 1, component = component, - markdownExtension = draftMarkdown, + textEditorState = draftState, ) VerticalDivider( color = MaterialTheme.colorScheme.outlineVariant, @@ -189,7 +165,7 @@ private fun ExpandedDraftCompareUi( modifier = Modifier.weight(1f).fillMaxHeight(), sectionNumber = 2, component = component, - markdownExtension = currentMarkdown, + textEditorState = currentState, ) } } @@ -199,16 +175,15 @@ private fun DraftPane( modifier: Modifier, sectionNumber: Int, component: DraftCompare, - markdownExtension: MarkdownExtension, + textEditorState: TextEditorState, ) { val strRes = rememberStrRes() val state by component.state.subscribeAsState() val deletedHighlight = rememberDeletedHighlight() - val textEditorState = markdownExtension.editorState // The draft is read-only, so its rendered text never changes — submit it once for the diff. - LaunchedEffect(markdownExtension) { - component.submitDraftText(sceneDiffText(markdownExtension)) + LaunchedEffect(textEditorState) { + component.submitDraftText(textEditorState.getAllText().text) } val spans = if (state.showDiff) state.diffResult?.leftSpans.orEmpty() else emptyList() DiffHighlightEffect(textEditorState, spans, deletedHighlight) @@ -255,7 +230,6 @@ private fun DraftPane( TextEditor( modifier = Modifier.fillMaxSize(), state = textEditorState, - style = rememberTextEditorStyle(textStyle = LocalEditorTextStyle.current), enabled = false, ) } @@ -267,24 +241,30 @@ private fun CurrentPane( modifier: Modifier, sectionNumber: Int, component: DraftCompare, - markdownExtension: MarkdownExtension, + textEditorState: TextEditorState, ) { val state by component.state.subscribeAsState() + val markdownConfig = LocalMarkdownConfig.current val insertedHighlight = rememberInsertedHighlight() - val textEditorState = markdownExtension.editorState - LaunchedEffect(markdownExtension) { + val markdownExtension = remember(textEditorState) { textEditorState.withMarkdown(markdownConfig) } + + LaunchedEffect(markdownExtension, markdownConfig) { + markdownExtension.updateMarkdownConfiguration(markdownConfig) + } + + LaunchedEffect(textEditorState) { // Seed the diff with the initial text, then watch for edits. `collectLatest` cancels the // previous lambda when a new edit arrives, so the `delay` acts as a per-keystroke debounce: // the diff recompute only fires after the user stops typing for [DIFF_RECOMPUTE_DELAY_MS]. // The merged-content update runs synchronously before the delay so picking the current // draft always uses the latest text. Submitting the editor's rendered text (not the // markdown) keeps the diff in the same coordinate space the highlights are drawn in. - component.onCurrentTextChanged(sceneDiffText(markdownExtension)) + component.onCurrentTextChanged(textEditorState.getAllText().text) textEditorState.editOperations.collectLatest { _ -> component.onMergedContentChanged(ComposeRichText(markdownExtension)) delay(DIFF_RECOMPUTE_DELAY_MS) - component.onCurrentTextChanged(sceneDiffText(markdownExtension)) + component.onCurrentTextChanged(textEditorState.getAllText().text) } } @@ -328,31 +308,11 @@ private fun CurrentPane( TextEditor( modifier = Modifier.fillMaxSize(), state = textEditorState, - style = rememberTextEditorStyle(textStyle = LocalEditorTextStyle.current), ) } } } -/** An editor seeded with [content], keeping the block structure markdown carries. */ -@Composable -private fun rememberSceneContentEditor( - content: SceneContent?, - richTextStyles: RichTextStyles, -): MarkdownExtension { - val editorState = rememberTextEditorState() - val markdownExtension = remember(editorState) { - editorState.richTextStyles = richTextStyles - editorState.withMarkdown(HammerMarkdownConfiguration).also { loadSceneContent(it, content) } - } - // Both panes restyle together; the styles are otherwise baked in at import time and - // the two would drift apart on a font size or theme change. - LaunchedEffect(markdownExtension, richTextStyles) { - editorState.updateRichTextStyles(richTextStyles) - } - return markdownExtension -} - @Composable private fun rememberDeletedHighlight(): HighlightSpanStyle { val danger = LocalHammerColors.current.danger diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/focusmode/FocusModeUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/focusmode/FocusModeUi.kt index 06590e9ba..d732d3e31 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/focusmode/FocusModeUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/focusmode/FocusModeUi.kt @@ -6,7 +6,6 @@ import androidx.compose.animation.shrinkVertically import androidx.compose.foundation.background import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.BoxWithConstraints import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.PaddingValues import androidx.compose.foundation.layout.Row @@ -30,70 +29,53 @@ import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.style.TextIndent import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.TextEditorDefaults import com.darkrockstudios.apps.hammer.common.components.storyeditor.focusmode.FocusMode -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.clampEditorWidth import com.darkrockstudios.apps.hammer.common.compose.ComposeRichText -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.LocalRichTextStyles +import com.darkrockstudios.apps.hammer.common.compose.LocalMarkdownConfig import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.findShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdResizeHandle -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdResizeHandleState +import com.darkrockstudios.apps.hammer.common.compose.markdown.updateMarkdownConfiguration import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownFormatBar import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.textSizeShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.withParagraphIndent import com.darkrockstudios.apps.hammer.common.data.UpdateSource -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.loadSceneContent -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.sceneContentMarkdown -import com.darkrockstudios.apps.hammer.common.utils.addToDictionaryMenuItems +import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.getInitialEditorContent import com.darkrockstudios.apps.hammer.common.utils.toEditorSpellChecker -import com.darkrockstudios.apps.hammer.scene_editor_add_to_dictionary import com.darkrockstudios.apps.hammer.scene_editor_menu_item_close import com.darkrockstudios.texteditor.find.FindBar import com.darkrockstudios.texteditor.find.rememberFindState -import com.darkrockstudios.texteditor.markdown.withMarkdown import com.darkrockstudios.texteditor.rememberTextEditorStyle import com.darkrockstudios.texteditor.spellcheck.SpellCheckingTextEditor +import com.darkrockstudios.texteditor.spellcheck.markdown.withMarkdown import com.darkrockstudios.texteditor.spellcheck.rememberSpellCheckState -import kotlinx.coroutines.withContext @Composable fun FocusModeUi(component: FocusMode) { val state by component.state.subscribeAsState() val lastForceUpdate by component.lastForceUpdate.subscribeAsState() - val richTextStyles = LocalRichTextStyles.current - val defaultDispatcher = rememberDefaultDispatcher() + val markdownConfig = LocalMarkdownConfig.current - val addToDictionaryLabel = Res.string.scene_editor_add_to_dictionary.get() - val spellCheckMenuItems = remember(addToDictionaryLabel, component) { - addToDictionaryMenuItems(addToDictionaryLabel, component::addWordToDictionary) - } val editorSpellChecker = remember(state.spellChecker) { state.spellChecker.toEditorSpellChecker() } val textEditorState = rememberSpellCheckState( spellChecker = editorSpellChecker, - initialText = null, + initialText = getInitialEditorContent(state.sceneBuffer?.content, markdownConfig), enableSpellChecking = state.spellCheckingEnabled, ) - val markdownExtension = remember { - textEditorState.textState.richTextStyles = richTextStyles - textEditorState.textState.withMarkdown(HammerMarkdownConfiguration) - } + val markdownExtension = remember { textEditorState.withMarkdown(markdownConfig) } val findState = rememberFindState(textEditorState.textState) var showFindBar by remember { mutableStateOf(false) } - LaunchedEffect(richTextStyles) { - textEditorState.textState.updateRichTextStyles(richTextStyles) + LaunchedEffect(markdownConfig) { + markdownExtension.updateMarkdownConfiguration(markdownConfig) } var hasReceivedInitialBuffer by remember { mutableStateOf(false) } @@ -102,12 +84,8 @@ fun FocusModeUi(component: FocusMode) { state.sceneBuffer?.let { buffer -> // Always update on first buffer (initial load), or when external update occurs if (!hasReceivedInitialBuffer || buffer.source != UpdateSource.Editor) { - val sceneMarkdown = withContext(defaultDispatcher) { - sceneContentMarkdown(buffer.content) - } - loadSceneContent(markdownExtension, sceneMarkdown) - // Squiggles are decoration, so the editor takes input the moment the - // text is in and the check catches up behind it. + val newContent = getInitialEditorContent(buffer.content, markdownConfig) + textEditorState.textState.setText(newContent) hasReceivedInitialBuffer = true } } @@ -137,11 +115,6 @@ fun FocusModeUi(component: FocusMode) { .fillMaxSize() .focusModeChromePadding() .findShortcutModifier { showFindBar = true } - .textSizeShortcutModifier( - onIncrease = component::increaseTextSize, - onDecrease = component::decreaseTextSize, - onReset = component::resetTextSize, - ) ) { Row( modifier = Modifier @@ -179,43 +152,25 @@ fun FocusModeUi(component: FocusMode) { ) } - BoxWithConstraints(modifier = Modifier.fillMaxSize()) { - val widthState = rememberHdResizeHandleState( - persistedWidth = state.editorMaxWidth, - availableWidth = maxWidth, - clampWidth = ::clampEditorWidth, - onCommit = component::setEditorMaxWidth, - onReset = component::resetEditorMaxWidth, - ) - val editorMaxWidth = widthState.width - - Row( - modifier = Modifier.fillMaxSize(), - horizontalArrangement = Arrangement.Center - ) { - if (widthState.showHandle) { - HdResizeHandle( - onOutwardDrag = widthState::onOutwardDrag, - onDragEnd = widthState::onDragEnd, - onReset = widthState::reset, - ) - } - - SpellCheckingTextEditor( - state = textEditorState, - contentPadding = PaddingValues(Ui.Padding.XL), - enabled = hasReceivedInitialBuffer, - spellCheckMenuItems = spellCheckMenuItems, - style = rememberTextEditorStyle( - textStyle = LocalEditorTextStyle.current.withParagraphIndent(), - focusedBorderColor = Color.Transparent, + Row( + modifier = Modifier.fillMaxSize(), + horizontalArrangement = Arrangement.Center + ) { + SpellCheckingTextEditor( + state = textEditorState, + contentPadding = PaddingValues(Ui.Padding.XL), + enabled = hasReceivedInitialBuffer, + style = rememberTextEditorStyle( + textStyle = TextStyle.Default.copy( + textIndent = TextIndent(firstLine = 24.sp) ), - modifier = Modifier - .background(MaterialTheme.colorScheme.surfaceColorAtElevation(1.dp)) - .fillMaxHeight() - .widthIn(TextEditorDefaults.MIN_WIDTH, editorMaxWidth), - ) - } + focusedBorderColor = Color.Transparent, + ), + modifier = Modifier + .background(MaterialTheme.colorScheme.surfaceColorAtElevation(1.dp)) + .fillMaxHeight() + .widthIn(128.dp, TextEditorDefaults.MAX_WIDTH), + ) } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/readermode/ReaderModeUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/readermode/ReaderModeUi.kt deleted file mode 100644 index 69356d77e..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/readermode/ReaderModeUi.kt +++ /dev/null @@ -1,478 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.storyeditor.readermode - -import androidx.compose.foundation.background -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.* -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.LazyListState -import androidx.compose.foundation.lazy.items -import androidx.compose.foundation.lazy.rememberLazyListState -import androidx.compose.material3.HorizontalDivider -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.material3.surfaceColorAtElevation -import androidx.compose.runtime.* -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.semantics.contentDescription -import androidx.compose.ui.semantics.semantics -import androidx.compose.ui.text.TextStyle -import androidx.compose.ui.text.font.FontFamily -import androidx.compose.ui.text.font.FontStyle -import androidx.compose.ui.text.font.FontWeight -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.sp -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.* -import com.darkrockstudios.apps.hammer.common.TextEditorDefaults -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.clampEditorWidth -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList -import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.* -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownView -import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import kotlinx.coroutines.flow.distinctUntilChanged -import kotlin.math.roundToInt - -const val READER_MODE_LIST_TAG = "reader-mode-list" -const val READER_MODE_EDIT_TAG = "reader-mode-edit" -const val READER_MODE_HEADINGS_TOGGLE_TAG = "reader-mode-headings-toggle" -const val READER_MODE_INCREASE_FONT_TAG = "reader-mode-increase-font" -const val READER_MODE_DECREASE_FONT_TAG = "reader-mode-decrease-font" -const val READER_MODE_SCENE_BREAK_TAG = "reader-mode-scene-break" -const val READER_MODE_NEXT_CHAPTER_TAG = "reader-mode-next-chapter" -const val READER_MODE_PREVIOUS_CHAPTER_TAG = "reader-mode-previous-chapter" - -fun readerSceneHeadingTag(sceneId: Int) = "reader-mode-scene-heading-$sceneId" -fun readerSceneBodyTag(sceneId: Int) = "reader-mode-scene-body-$sceneId" - -/** One lazy item of the reading column. [scene] is the scene the row counts as when it tops the viewport. */ -private sealed interface ReaderRow { - val key: String - val scene: SceneItem? - - data class ChapterHeader(override val scene: SceneItem?) : ReaderRow { - override val key = "chapter-header" - } - - data class SceneHeading(override val scene: SceneItem, val number: Int) : ReaderRow { - override val key = "heading-${scene.id}" - } - - data class SceneBreak(override val scene: SceneItem) : ReaderRow { - override val key = "break-${scene.id}" - } - - data class Body(override val scene: SceneItem, val markdown: String) : ReaderRow { - override val key = "body-${scene.id}" - } - - data object EmptyChapter : ReaderRow { - override val key = "empty-chapter" - override val scene: SceneItem? = null - } - - data class ChapterNav(override val scene: SceneItem?) : ReaderRow { - override val key = "chapter-nav" - } -} - -private fun buildReaderRows( - scenes: List, - showSceneHeadings: Boolean, - isLoading: Boolean, -): List = buildList { - add(ReaderRow.ChapterHeader(scenes.firstOrNull()?.sceneItem)) - scenes.forEachIndexed { index, scene -> - if (showSceneHeadings) { - add(ReaderRow.SceneHeading(scene.sceneItem, number = index + 1)) - } else if (index > 0) { - add(ReaderRow.SceneBreak(scene.sceneItem)) - } - add(ReaderRow.Body(scene.sceneItem, scene.markdown)) - } - if (scenes.isEmpty() && !isLoading) add(ReaderRow.EmptyChapter) - add(ReaderRow.ChapterNav(scenes.lastOrNull()?.sceneItem)) -} - -// The chapter's first scene scrolls to the very top so the chapter header stays in view. -private fun List.scrollIndexFor(sceneId: Int): Int { - val index = indexOfFirst { it !is ReaderRow.ChapterHeader && it.scene?.id == sceneId } - val firstSceneIndex = indexOfFirst { it !is ReaderRow.ChapterHeader && it.scene != null } - return if (index == firstSceneIndex) 0 else index -} - -@Composable -fun ReaderModeUi(component: ReaderMode, modifier: Modifier = Modifier) { - val state by component.state.subscribeAsState() - val screen = LocalScreenCharacteristic.current - val compact = !screen.isWide - val chapterIndex = state.activeChapterIndex - - Column(modifier = modifier.fillMaxSize()) { - HdMasthead( - section = Res.string.reader_mode_section.get(), - modifier = Modifier.windowInsetsPadding(WindowInsets.statusBars), - leadingMeta = if (compact || chapterIndex < 0) { - emptyList() - } else { - listOf(Res.string.reader_mode_position.get(chapterIndex + 1, state.chapters.size)) - }, - trailing = { - if (!compact) { - ReaderTools(state = state, component = component) - } - if (chapterIndex >= 0) { - HdMastheadAction( - label = Res.string.reader_mode_edit.get(), - onClick = { component.editScene() }, - modifier = Modifier.testTag(READER_MODE_EDIT_TAG), - ) - } - if (screen.needsExplicitClose) { - HdMastheadAction(label = Res.string.reader_mode_close.get(), onClick = component::close) - } - }, - ) - HdFolioDivider() - - if (compact) { - if (chapterIndex >= 0) { - val chapterRows = remember(state.chapters) { - state.chapters.map { HdChapterRow(title = it.chapter.name, sceneCount = it.sceneCount) } - } - HdChapterDropdown( - rows = chapterRows, - selectedIndex = chapterIndex, - onSelect = { component.showChapter(state.chapters[it].chapter.id) }, - ) - } - Row( - modifier = Modifier - .fillMaxWidth() - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.M), - horizontalArrangement = Arrangement.End, - ) { - ReaderTools(state = state, component = component) - } - HorizontalDivider(thickness = Dp.Hairline, color = MaterialTheme.colorScheme.outlineVariant) - } - - if (chapterIndex < 0) { - EmptyStory(modifier = Modifier.weight(1f)) - } else { - ReadingPane( - state = state, - component = component, - chapterIndex = chapterIndex, - wide = !compact, - modifier = Modifier.weight(1f).fillMaxWidth(), - ) - } - } -} - -@Composable -private fun ReaderTools(state: ReaderMode.State, component: ReaderMode) { - val decreaseLabel = Res.string.reader_mode_decrease_font_size.get() - val increaseLabel = Res.string.reader_mode_increase_font_size.get() - val resetLabel = Res.string.reader_mode_reset_font_size.get() - val headingsLabel = Res.string.reader_mode_toggle_scene_headings.get() - - Row( - verticalAlignment = Alignment.CenterVertically, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), - ) { - HdToolButton( - active = false, - onClick = component::decreaseFontSize, - modifier = Modifier - .testTag(READER_MODE_DECREASE_FONT_TAG) - .semantics { contentDescription = decreaseLabel }, - ) { - ToolGlyph("A−") - } - HdMonoLabel( - text = state.fontSize.roundToInt().toString(), - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier - .clickable(onClickLabel = resetLabel, onClick = component::resetFontSize) - .padding(Ui.Padding.S), - ) - HdToolButton( - active = false, - onClick = component::increaseFontSize, - modifier = Modifier - .testTag(READER_MODE_INCREASE_FONT_TAG) - .semantics { contentDescription = increaseLabel }, - ) { - ToolGlyph("A+") - } - HdToolButton( - active = state.showSceneHeadings, - onClick = component::toggleSceneHeadings, - modifier = Modifier - .testTag(READER_MODE_HEADINGS_TOGGLE_TAG) - .semantics { contentDescription = headingsLabel }, - ) { - ToolGlyph("§") - } - } -} - -@Composable -private fun ToolGlyph(text: String) { - Text( - text = text, - fontFamily = FontFamily.Monospace, - fontWeight = FontWeight.Medium, - fontSize = 12.sp, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) -} - -@Composable -private fun ReadingPane( - state: ReaderMode.State, - component: ReaderMode, - chapterIndex: Int, - wide: Boolean, - modifier: Modifier = Modifier, -) { - val rows = remember(state.scenes, state.showSceneHeadings, state.isLoading) { - buildReaderRows(state.scenes, state.showSceneHeadings, state.isLoading) - } - val listState = key(state.activeChapterId) { rememberLazyListState() } - - if (!state.isLoading) { - LaunchedEffect(listState, rows) { - snapshotFlow { rows.getOrNull(listState.firstVisibleItemIndex)?.scene } - .distinctUntilChanged() - .collect { component.sceneInView(it) } - } - } - - // A jump within the chapter on screen animates; landing in a freshly opened chapter does not. - var settledChapterId by remember { mutableStateOf(null) } - LaunchedEffect(state.scrollToSceneId, rows, state.isLoading) { - if (state.isLoading) return@LaunchedEffect - val sceneId = state.scrollToSceneId - if (sceneId != null) { - val index = rows.scrollIndexFor(sceneId) - if (index >= 0) { - // Offset past the top content padding, or the previous scene shows through it. - val offset = if (index > 0) listState.layoutInfo.beforeContentPadding else 0 - if (settledChapterId == state.activeChapterId) { - listState.animateScrollToItem(index, offset) - } else { - listState.scrollToItem(index, offset) - } - } - component.scrollHandled() - } - settledChapterId = state.activeChapterId - } - - val readerTextStyle = remember(state.fontSize) { TextStyle(fontSize = state.fontSize.sp) } - - BoxWithConstraints(modifier = modifier) { - val widthState = rememberHdResizeHandleState( - persistedWidth = state.editorMaxWidth, - availableWidth = maxWidth, - clampWidth = ::clampEditorWidth, - onCommit = component::setEditorMaxWidth, - onReset = component::resetEditorMaxWidth, - ) - - Row( - modifier = Modifier.fillMaxSize(), - horizontalArrangement = Arrangement.Center, - ) { - if (widthState.showHandle) { - HdResizeHandle( - onOutwardDrag = widthState::onOutwardDrag, - onDragEnd = widthState::onDragEnd, - onReset = widthState::reset, - ) - } - - CompositionLocalProvider(LocalEditorTextStyle provides readerTextStyle) { - ReadingColumn( - rows = rows, - state = state, - component = component, - chapterIndex = chapterIndex, - wide = wide, - listState = listState, - modifier = Modifier - .background(MaterialTheme.colorScheme.surfaceColorAtElevation(1.dp)) - .fillMaxHeight() - .widthIn(TextEditorDefaults.MIN_WIDTH, widthState.width) - .fillMaxWidth(), - ) - } - } - - MpScrollBarList( - modifier = scrollBarOverlay(), - state = listState, - ) - } -} - -@Composable -private fun ReadingColumn( - rows: List, - state: ReaderMode.State, - component: ReaderMode, - chapterIndex: Int, - wide: Boolean, - listState: LazyListState, - modifier: Modifier = Modifier, -) { - val chapter = state.chapters[chapterIndex] - val horizontalPad = if (wide) Ui.Padding.XXL else Ui.Padding.XL - - LazyColumn( - modifier = modifier.testTag(READER_MODE_LIST_TAG), - state = listState, - contentPadding = PaddingValues(horizontal = horizontalPad, vertical = Ui.Padding.XXL), - ) { - items(rows, key = { it.key }, contentType = { it::class }) { row -> - when (row) { - is ReaderRow.ChapterHeader -> HdChapterHeader( - index = chapterIndex, - title = chapter.chapter.name, - sceneCount = chapter.sceneCount, - wide = wide, - modifier = Modifier.padding(bottom = Ui.Padding.XXL), - ) - - is ReaderRow.SceneHeading -> SceneHeading( - chapterIndex = chapterIndex, - row = row, - wide = wide, - onClick = { component.editScene(row.scene) }, - ) - - is ReaderRow.SceneBreak -> HdSceneBreak( - modifier = Modifier - .testTag(READER_MODE_SCENE_BREAK_TAG) - .padding(vertical = Ui.Padding.XL), - ) - - is ReaderRow.Body -> MarkdownView( - markdown = row.markdown, - modifier = Modifier.fillMaxWidth().testTag(readerSceneBodyTag(row.scene.id)), - importDuringComposition = true, - isSelectable = true, - ) - - ReaderRow.EmptyChapter -> Text( - text = Res.string.reader_mode_empty_chapter.get(), - style = MaterialTheme.typography.bodyLarge, - fontStyle = FontStyle.Italic, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - - is ReaderRow.ChapterNav -> ChapterNav( - hasPrevious = chapterIndex > 0, - hasNext = chapterIndex < state.chapters.lastIndex, - onPrevious = component::previousChapter, - onNext = component::nextChapter, - ) - } - } - } -} - -@Composable -private fun SceneHeading( - chapterIndex: Int, - row: ReaderRow.SceneHeading, - wide: Boolean, - onClick: () -> Unit, -) { - Row( - modifier = Modifier - .fillMaxWidth() - .padding(top = if (row.number > 1) Ui.Padding.XXL else 0.dp, bottom = Ui.Padding.L) - .testTag(readerSceneHeadingTag(row.scene.id)) - .clickable(onClick = onClick), - verticalAlignment = Alignment.Bottom, - horizontalArrangement = Arrangement.spacedBy(Ui.Padding.L), - ) { - HdMonoLabel(text = "§ ${romanNumeral(chapterIndex + 1)}.${row.number}") - Text( - text = row.scene.name, - style = if (wide) MaterialTheme.typography.titleLarge else MaterialTheme.typography.titleMedium, - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier.weight(1f, fill = false), - ) - HdMonoLabel(text = "↗") - } -} - -@Composable -private fun ChapterNav( - hasPrevious: Boolean, - hasNext: Boolean, - onPrevious: () -> Unit, - onNext: () -> Unit, -) { - Column(modifier = Modifier.fillMaxWidth().padding(top = Ui.Padding.XXL)) { - if (hasPrevious || hasNext) { - Row( - modifier = Modifier.fillMaxWidth(), - horizontalArrangement = Arrangement.SpaceBetween, - ) { - if (hasPrevious) { - HdHairlineButton( - label = Res.string.reader_mode_previous_chapter.get(), - onClick = onPrevious, - modifier = Modifier.testTag(READER_MODE_PREVIOUS_CHAPTER_TAG), - ) - } else { - Spacer(Modifier) - } - if (hasNext) { - HdHairlineButton( - label = Res.string.reader_mode_next_chapter.get(), - onClick = onNext, - modifier = Modifier.testTag(READER_MODE_NEXT_CHAPTER_TAG), - ) - } - } - } - if (!hasNext) { - HdEndMark( - label = Res.string.reader_mode_end.get(), - modifier = Modifier.padding(top = Ui.Padding.L), - ) - } - } -} - -@Composable -private fun EmptyStory(modifier: Modifier = Modifier) { - Box( - modifier = modifier.fillMaxWidth(), - contentAlignment = Alignment.Center, - ) { - Text( - text = Res.string.reader_mode_empty_story.get(), - style = MaterialTheme.typography.bodyLarge, - fontStyle = FontStyle.Italic, - textAlign = TextAlign.Center, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } -} diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SaveDraftDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SaveDraftDialog.kt index c8148650a..8f8e9efba 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SaveDraftDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SaveDraftDialog.kt @@ -10,7 +10,6 @@ import androidx.compose.material3.Icon import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.runtime.* -import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.text.font.FontWeight @@ -37,7 +36,7 @@ internal fun SaveDraftDialog( val strRes = rememberStrRes() val scope = rememberCoroutineScope() val mainDispatcher = rememberMainDispatcher() - var draftName by rememberSaveable { mutableStateOf("") } + var draftName by remember { mutableStateOf("") } val metadataState by component.sceneMetadataComponent.state.subscribeAsState() val currentDraftName = metadataState.metadata.currentDraftName diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneContentUtils.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneContentUtils.kt index 63933e780..d206bc9de 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneContentUtils.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneContentUtils.kt @@ -1,73 +1,26 @@ package com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor +import androidx.compose.ui.text.AnnotatedString +import com.darkrockstudios.apps.hammer.common.compose.ComposeRichText import com.darkrockstudios.apps.hammer.common.data.SceneContent -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.richstyle.HorizontalRuleSpanStyle -import com.darkrockstudios.texteditor.richstyle.ImageBlockSpanStyle +import com.darkrockstudios.texteditor.markdown.MarkdownConfiguration +import com.darkrockstudios.texteditor.markdown.toAnnotatedStringFromMarkdown -/** Private Use Area, so they can never collide with anything a writer types. */ -private val HR_MARKER = Char(0xE000) -private val IMAGE_MARKER = Char(0xE001) - -/** - * Horizontal rules and code fences live in the editor's rich span manager, not in the - * AnnotatedString, so scene content has to travel as markdown and be imported. - * Round-tripping it as an AnnotatedString silently drops every block. Images need an - * ImageProvider the editors don't supply, so they import as literal text. - */ -fun loadSceneContent(markdown: MarkdownExtension, sceneContent: SceneContent?) { - loadSceneContent(markdown, sceneContentMarkdown(sceneContent)) -} - -fun loadSceneContent(markdown: MarkdownExtension, sceneMarkdown: String) { - markdown.importMarkdown(sceneMarkdown) -} - -/** - * Serializing a buffer that holds a live editor walks its whole document, so callers on - * the main thread should do this off it first. [MarkdownExtension.exportAsMarkdown] reads - * a single immutable snapshot and is safe from any thread. - */ -fun sceneContentMarkdown(sceneContent: SceneContent?): String = - sceneContent?.coerceMarkdown() ?: "" - -/** - * The editor's rendered text with block placeholders swapped for distinct sentinels. - * Rules and images both render as a lone space, so a plain diff cannot tell a scene - * break from a blank line and silently drops one during a draft merge. The swap is - * length-preserving to keep the result in the editor's coordinate space, which is - * what the diff highlight spans are drawn in. - */ -fun sceneDiffText(markdown: MarkdownExtension): String { - val text = markdown.editorState.getAllText().text - val markers = blockMarkersByLine(markdown) - if (markers.isEmpty()) return text - - val chars = StringBuilder(text) - var line = 0 - var lineStart = 0 - while (true) { - val newline = chars.indexOf("\n", lineStart) - val end = if (newline == -1) chars.length else newline - val marker = markers[line] - // Only a bare placeholder line is a block; anything longer is real prose. - if (marker != null && end - lineStart == 1) { - chars[lineStart] = marker +fun getInitialEditorContent( + sceneContent: SceneContent?, + markdownConfig: MarkdownConfiguration +): AnnotatedString { + return if (sceneContent != null) { + val composeText = sceneContent.platformRepresentation as? ComposeRichText + val markdown = sceneContent.markdown + if (composeText != null) { + composeText.getAnnotatedString() + } else if (markdown != null) { + markdown.toAnnotatedStringFromMarkdown(markdownConfig) + } else { + error("Should be impossible to not have either platform rep or markdown") } - if (newline == -1) break - lineStart = newline + 1 - line++ + } else { + AnnotatedString("") } - return chars.toString() -} - -private fun blockMarkersByLine(markdown: MarkdownExtension): Map = - markdown.editorState.richSpanManager.getAllRichSpans() - .mapNotNull { span -> - when (span.style) { - is HorizontalRuleSpanStyle -> span.range.start.line to HR_MARKER - is ImageBlockSpanStyle -> span.range.start.line to IMAGE_MARKER - else -> null - } - } - .toMap() +} \ No newline at end of file diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneEditorUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneEditorUi.kt index 8386208f0..4affc36a8 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneEditorUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneEditorUi.kt @@ -40,46 +40,36 @@ import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.testTag +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.style.TextIndent import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.TextEditorDefaults import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditor -import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.clampEditorWidth import com.darkrockstudios.apps.hammer.common.compose.AnimatedDialog import com.darkrockstudios.apps.hammer.common.compose.ComposeRichText -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.LocalRichTextStyles +import com.darkrockstudios.apps.hammer.common.compose.LocalMarkdownConfig import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher import com.darkrockstudios.apps.hammer.common.compose.Toaster import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.findShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdResizeHandle -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdResizeHandleState +import com.darkrockstudios.apps.hammer.common.compose.markdown.updateMarkdownConfiguration import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownFormatBar import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.markdownFormatShortcuts -import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.compose.saveShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.textSizeShortcutModifier -import com.darkrockstudios.apps.hammer.common.compose.withParagraphIndent import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.SceneDeleteDialog -import com.darkrockstudios.apps.hammer.common.utils.addToDictionaryMenuItems import com.darkrockstudios.apps.hammer.common.utils.toEditorSpellChecker -import com.darkrockstudios.apps.hammer.scene_editor_add_to_dictionary import com.darkrockstudios.texteditor.find.FindBar import com.darkrockstudios.texteditor.find.rememberFindState -import com.darkrockstudios.texteditor.markdown.withMarkdown import com.darkrockstudios.texteditor.rememberTextEditorStyle import com.darkrockstudios.texteditor.spellcheck.SpellCheckMode import com.darkrockstudios.texteditor.spellcheck.SpellCheckingTextEditor +import com.darkrockstudios.texteditor.spellcheck.markdown.withMarkdown import com.darkrockstudios.texteditor.spellcheck.rememberSpellCheckState import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext const val SCENE_EDITOR_TEXT_TAG = "scene-editor-text" const val SCENE_EDITOR_SAVE_TAG = "scene-editor-save" @@ -94,33 +84,25 @@ fun SceneEditorUi( ) { val state by component.state.subscribeAsState() val lastForceUpdate by component.lastForceUpdate.subscribeAsState() - val richTextStyles = LocalRichTextStyles.current + val markdownConfig = LocalMarkdownConfig.current val scope = rememberCoroutineScope() - val defaultDispatcher = rememberDefaultDispatcher() - val addToDictionaryLabel = Res.string.scene_editor_add_to_dictionary.get() - val spellCheckMenuItems = remember(addToDictionaryLabel, component) { - addToDictionaryMenuItems(addToDictionaryLabel, component::addWordToDictionary) - } val editorSpellChecker = remember(state.spellChecker) { state.spellChecker.toEditorSpellChecker() } val textEditorState = rememberSpellCheckState( spellChecker = editorSpellChecker, - initialText = null, + initialText = getInitialEditorContent(state.sceneBuffer?.content, markdownConfig), enableSpellChecking = state.spellCheckingEnabled, spellCheckMode = SpellCheckMode.Word, ) - val markdownExtension = remember { - textEditorState.textState.richTextStyles = richTextStyles - textEditorState.textState.withMarkdown(HammerMarkdownConfiguration) - } + val markdownExtension = remember { textEditorState.withMarkdown(markdownConfig) } val findState = rememberFindState(textEditorState.textState) var showFindBar by remember { mutableStateOf(false) } - LaunchedEffect(richTextStyles) { - textEditorState.textState.updateRichTextStyles(richTextStyles) + LaunchedEffect(markdownConfig) { + markdownExtension.updateMarkdownConfiguration(markdownConfig) } var hasReceivedInitialBuffer by remember { mutableStateOf(false) } @@ -130,12 +112,8 @@ fun SceneEditorUi( state.sceneBuffer?.let { buffer -> // Always update on first buffer (initial load), or when external update occurs if (!hasReceivedInitialBuffer || buffer.source != UpdateSource.Editor) { - val sceneMarkdown = withContext(defaultDispatcher) { - sceneContentMarkdown(buffer.content) - } - loadSceneContent(markdownExtension, sceneMarkdown) - // Squiggles are decoration, so the editor takes input the moment the - // text is in and the check catches up behind it. + val newContent = getInitialEditorContent(buffer.content, markdownConfig) + textEditorState.textState.setText(newContent) hasReceivedInitialBuffer = true } } @@ -165,17 +143,8 @@ fun SceneEditorUi( CircularProgressIndicator() } } else { - val widthState = rememberHdResizeHandleState( - persistedWidth = state.editorMaxWidth, - availableWidth = boxWithConstraintsScope.maxWidth, - clampWidth = ::clampEditorWidth, - onCommit = component::setEditorMaxWidth, - onReset = component::resetEditorMaxWidth, - ) - val editorMaxWidth = widthState.width - - val remainingWidth = remember(boxWithConstraintsScope.maxWidth, editorMaxWidth) { - boxWithConstraintsScope.maxWidth - editorMaxWidth + val remainingWidth = remember(boxWithConstraintsScope.maxWidth) { + boxWithConstraintsScope.maxWidth - TextEditorDefaults.MAX_WIDTH } val isWide = remember(remainingWidth) { remainingWidth >= SCENE_METADATA_MIN_WIDTH } SideEffect { component.setLayoutMode(isWide) } @@ -187,11 +156,6 @@ fun SceneEditorUi( modifier = Modifier .fillMaxHeight() .findShortcutModifier { showFindBar = true } - .textSizeShortcutModifier( - onIncrease = component::increaseTextSize, - onDecrease = component::decreaseTextSize, - onReset = component::resetTextSize, - ) .saveShortcutModifier { scope.launch { component.storeSceneContent() } } .markdownFormatShortcuts(markdownExtension) ) { @@ -229,21 +193,14 @@ fun SceneEditorUi( modifier = Modifier.fillMaxSize(), horizontalArrangement = Arrangement.Center ) { - if (widthState.showHandle) { - HdResizeHandle( - onOutwardDrag = widthState::onOutwardDrag, - onDragEnd = widthState::onDragEnd, - onReset = widthState::reset, - ) - } - SpellCheckingTextEditor( state = textEditorState, contentPadding = PaddingValues(Ui.Padding.XL), enabled = hasReceivedInitialBuffer, - spellCheckMenuItems = spellCheckMenuItems, style = rememberTextEditorStyle( - textStyle = LocalEditorTextStyle.current.withParagraphIndent(), + textStyle = TextStyle.Default.copy( + textIndent = TextIndent(firstLine = 24.sp) + ), focusedBorderColor = Color.Transparent, unfocusedBorderColor = Color.Transparent, ), @@ -251,7 +208,7 @@ fun SceneEditorUi( .testTag(SCENE_EDITOR_TEXT_TAG) .background(MaterialTheme.colorScheme.surfaceColorAtElevation(1.dp)) .fillMaxHeight() - .widthIn(TextEditorDefaults.MIN_WIDTH, editorMaxWidth), + .widthIn(128.dp, TextEditorDefaults.MAX_WIDTH), ) HorizontalDivider(modifier = Modifier.fillMaxHeight().width(1.dp)) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneMetadataPanelUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneMetadataPanelUi.kt index c20f2c3d2..e8a9d1a3d 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneMetadataPanelUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/SceneMetadataPanelUi.kt @@ -17,7 +17,6 @@ import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp -import androidx.compose.ui.text.input.KeyboardCapitalization import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.* import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.scenemetadata.SceneMetadataPanel @@ -26,7 +25,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType -import com.darkrockstudios.apps.hammer.common.data.tagindex.replaceTagPrefix import com.darkrockstudios.apps.hammer.common.encyclopedia.EntryRefChipLabel import com.darkrockstudios.apps.hammer.common.util.format import kotlinx.datetime.TimeZone @@ -44,9 +42,6 @@ private fun EntryType.bucket(): RefBucket = when (this) { else -> RefBucket.Other } -private fun RefBucket.types(): Set = - EntryType.entries.filterTo(mutableSetOf()) { it.bucket() == this } - @Composable private fun RefBucket.label(): String = when (this) { RefBucket.Characters -> Res.string.scene_editor_metadata_references_characters_label.get() @@ -77,199 +72,191 @@ fun SceneMetadataPanelUi( color = MaterialTheme.colorScheme.surfaceContainerLow, tonalElevation = 0.dp, ) { - val scrollState = rememberScrollState() - Box { - Column(modifier = Modifier.verticalScroll(scrollState)) { + Column(modifier = Modifier.verticalScroll(rememberScrollState())) { - Row( - modifier = Modifier - .fillMaxWidth() - .padding(start = Ui.Padding.M, end = Ui.Padding.L, top = Ui.Padding.S, bottom = Ui.Padding.S), - verticalAlignment = Alignment.CenterVertically, + Row( + modifier = Modifier + .fillMaxWidth() + .padding(start = Ui.Padding.M, end = Ui.Padding.L, top = Ui.Padding.S, bottom = Ui.Padding.S), + verticalAlignment = Alignment.CenterVertically, + ) { + IconButton( + onClick = closeMetadata, + modifier = Modifier.size(36.dp), ) { - IconButton( - onClick = closeMetadata, - modifier = Modifier.size(36.dp), - ) { - Icon( - imageVector = Icons.Default.Close, - contentDescription = Res.string.scene_editor_metadata_hide_button.get(), - tint = MaterialTheme.colorScheme.onSurface, - ) - } - Spacer(Modifier.width(Ui.Padding.S)) + Icon( + imageVector = Icons.Default.Close, + contentDescription = Res.string.scene_editor_metadata_hide_button.get(), + tint = MaterialTheme.colorScheme.onSurface, + ) + } + Spacer(Modifier.width(Ui.Padding.S)) + Text( + text = Res.string.scene_editor_metadata_title.get(), + style = MaterialTheme.typography.titleMedium, + color = MaterialTheme.colorScheme.onSurface, + ) + } + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + + Row( + modifier = Modifier + .fillMaxWidth() + .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.L), + verticalAlignment = Alignment.Bottom, + ) { + Column(modifier = Modifier.weight(1f).padding(end = Ui.Padding.M)) { Text( - text = Res.string.scene_editor_metadata_title.get(), + text = state.sceneItem.name, + style = MaterialTheme.typography.titleLarge, + color = MaterialTheme.colorScheme.onSurface, + ) + HdEntityId( + prefix = "SCN", + id = state.sceneItem.id, + modifier = Modifier.padding(top = 2.dp), + ) + } + Row(verticalAlignment = Alignment.Bottom) { + HdMonoLabel( + text = Res.string.scene_editor_metadata_word_count_label.get().removeSuffix(":"), + modifier = Modifier.padding(end = 6.dp, bottom = 2.dp), + ) + Text( + text = "${state.wordCount}", style = MaterialTheme.typography.titleMedium, color = MaterialTheme.colorScheme.onSurface, ) } - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - - Row( - modifier = Modifier - .fillMaxWidth() - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.L), - verticalAlignment = Alignment.Bottom, - ) { - Column(modifier = Modifier.weight(1f).padding(end = Ui.Padding.M)) { - Text( - text = state.sceneItem.name, - style = MaterialTheme.typography.titleLarge, - color = MaterialTheme.colorScheme.onSurface, - ) - HdEntityId( - prefix = "SCN", - id = state.sceneItem.id, - modifier = Modifier.padding(top = 2.dp), - ) - } - Row(verticalAlignment = Alignment.Bottom) { - HdMonoLabel( - text = Res.string.scene_editor_metadata_word_count_label.get().removeSuffix(":"), - modifier = Modifier.padding(end = 6.dp, bottom = 2.dp), - ) - Text( - text = "${state.wordCount}", - style = MaterialTheme.typography.titleMedium, - color = MaterialTheme.colorScheme.onSurface, - ) - } - } - TimestampStrip( - created = state.metadata.created, - edited = state.metadata.lastEdited, - ) - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) - - Column(modifier = Modifier.padding(Ui.Padding.XL)) { - - HdHairlineField( - label = Res.string.scene_editor_metadata_outline_label.get(), - value = state.metadata.outline, - onValueChange = component::updateOutline, - placeholder = Res.string.scene_editor_metadata_outline_placeholder.get(), - singleLine = false, - minLines = 3, - ) - - SpacerXL() - - HdHairlineField( - label = Res.string.scene_editor_metadata_notes_label.get(), - value = state.metadata.notes, - onValueChange = component::updateNotes, - placeholder = Res.string.scene_editor_metadata_notes_placeholder.get(), - singleLine = false, - minLines = 3, - ) - - SpacerXL() - - var isDraftNameValid by remember(state.metadata.currentDraftName) { - mutableStateOf(component.validateDraftName(state.metadata.currentDraftName)) - } - HdHairlineField( - label = Res.string.scene_editor_metadata_draft_name_label.get(), - value = state.metadata.currentDraftName, - onValueChange = { newName -> - isDraftNameValid = component.validateDraftName(newName) - component.updateDraftName(newName) - }, - singleLine = true, - ) - if (!isDraftNameValid) { - SpacerM() - Text( - Res.string.scene_draft_invalid_name.get(), - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.error, - ) - } - - SpacerXL() - - CollapsableSection( - startExpanded = true, - header = { - HdMonoLabel( - text = Res.string.scene_editor_metadata_references_header.get(), - modifier = Modifier.padding(end = Ui.Padding.M), - ) - }, - trailingAction = { - HdHairlineButton( - label = Res.string.scene_editor_metadata_references_add_button.get(), - onClick = { showAddDialog = true }, - ) - }, - body = { ReferencesBody(state, component) } - ) - - if (state.dismissedRefs.isNotEmpty()) { - SpacerXL() - CollapsableSection( - startExpanded = false, - header = { - Row(verticalAlignment = Alignment.CenterVertically) { - HdMonoLabel( - text = Res.string.scene_editor_metadata_references_dismissed_label.get(), - ) - Text( - text = " · ${state.dismissedRefs.size}", - style = MaterialTheme.typography.labelSmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier.padding(start = 4.dp, end = Ui.Padding.M), - ) - } - }, - body = { DismissedBody(state, component) } - ) - } - - SpacerXL() - - CollapsableSection( - startExpanded = true, - header = { - HdMonoLabel( - text = Res.string.scene_editor_metadata_tags_header.get(), - modifier = Modifier.padding(end = Ui.Padding.M), - ) - }, - trailingAction = { - HdHairlineButton( - label = Res.string.scene_editor_metadata_tags_add_button.get(), - onClick = { showAddTagDialog = true }, - ) - }, - body = { TagsBody(state, component) } - ) - - SpacerXL() - - CollapsableSection( - header = { - HdMonoLabel( - text = Res.string.scene_editor_metadata_advanced_header.get(), - modifier = Modifier.padding(end = Ui.Padding.M), - ) - }, - body = { AdvancedBody(state) } - ) - } } - - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, + TimestampStrip( + created = state.metadata.created, + edited = state.metadata.lastEdited, ) + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + + Column(modifier = Modifier.padding(Ui.Padding.XL)) { + + HdHairlineField( + label = Res.string.scene_editor_metadata_outline_label.get(), + value = state.metadata.outline, + onValueChange = component::updateOutline, + placeholder = Res.string.scene_editor_metadata_outline_placeholder.get(), + singleLine = false, + minLines = 3, + ) + + SpacerXL() + + HdHairlineField( + label = Res.string.scene_editor_metadata_notes_label.get(), + value = state.metadata.notes, + onValueChange = component::updateNotes, + placeholder = Res.string.scene_editor_metadata_notes_placeholder.get(), + singleLine = false, + minLines = 3, + ) + + SpacerXL() + + var isDraftNameValid by remember(state.metadata.currentDraftName) { + mutableStateOf(component.validateDraftName(state.metadata.currentDraftName)) + } + HdHairlineField( + label = Res.string.scene_editor_metadata_draft_name_label.get(), + value = state.metadata.currentDraftName, + onValueChange = { newName -> + isDraftNameValid = component.validateDraftName(newName) + component.updateDraftName(newName) + }, + singleLine = true, + ) + if (!isDraftNameValid) { + SpacerM() + Text( + Res.string.scene_draft_invalid_name.get(), + style = MaterialTheme.typography.bodySmall, + color = MaterialTheme.colorScheme.error, + ) + } + + SpacerXL() + + CollapsableSection( + startExpanded = true, + header = { + HdMonoLabel( + text = Res.string.scene_editor_metadata_references_header.get(), + modifier = Modifier.padding(end = Ui.Padding.M), + ) + }, + trailingAction = { + HdHairlineButton( + label = Res.string.scene_editor_metadata_references_add_button.get(), + onClick = { showAddDialog = true }, + ) + }, + body = { ReferencesBody(state, component) } + ) + + if (state.dismissedRefs.isNotEmpty()) { + SpacerXL() + CollapsableSection( + startExpanded = false, + header = { + Row(verticalAlignment = Alignment.CenterVertically) { + HdMonoLabel( + text = Res.string.scene_editor_metadata_references_dismissed_label.get(), + ) + Text( + text = " · ${state.dismissedRefs.size}", + style = MaterialTheme.typography.labelSmall, + color = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier.padding(start = 4.dp, end = Ui.Padding.M), + ) + } + }, + body = { DismissedBody(state, component) } + ) + } + + SpacerXL() + + CollapsableSection( + startExpanded = true, + header = { + HdMonoLabel( + text = Res.string.scene_editor_metadata_tags_header.get(), + modifier = Modifier.padding(end = Ui.Padding.M), + ) + }, + trailingAction = { + HdHairlineButton( + label = Res.string.scene_editor_metadata_tags_add_button.get(), + onClick = { showAddTagDialog = true }, + ) + }, + body = { TagsBody(state, component) } + ) + + SpacerXL() + + CollapsableSection( + header = { + HdMonoLabel( + text = Res.string.scene_editor_metadata_advanced_header.get(), + modifier = Modifier.padding(end = Ui.Padding.M), + ) + }, + body = { AdvancedBody(state) } + ) + } } } @@ -459,7 +446,8 @@ private fun AddReferenceDialog( var tab by rememberSaveable { mutableStateOf(RefBucket.Characters) } val suggestions = remember(query, tab) { - component.searchEntriesForAdd(query, types = tab.types()) + component.searchEntriesForAdd(query) + .filter { it.entryDef.type.bucket() == tab } } AnimatedDialog( @@ -629,7 +617,11 @@ private fun AddTagDialog( var draft by rememberSaveable { mutableStateOf("") } LaunchedEffect(visible) { if (!visible) draft = "" } - val suggestions = rememberTagSuggestions(draft, existingTags, component::suggestTags) + val suggestions = remember(draft, existingTags) { + val prefix = draft.substringAfterLast(' ').trim().removePrefix("#") + if (prefix.isEmpty()) emptyList() + else component.suggestTags(prefix).filter { it !in existingTags } + } AnimatedDialog( visible = visible, @@ -651,8 +643,6 @@ private fun AddTagDialog( onValueChange = { draft = it }, placeholder = Res.string.scene_editor_metadata_tags_add_dialog_placeholder.get(), singleLine = true, - capitalization = KeyboardCapitalization.None, - autoCorrectEnabled = false, ) SpacerM() @@ -660,7 +650,7 @@ private fun AddTagDialog( HdTagSuggestionStrip( suggestions = suggestions, onSelect = { tag -> - component.addTags(replaceTagPrefix(draft, tag)) + component.addTags(tag) draft = "" }, ) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/MoveSceneDialog.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/MoveSceneDialog.kt index af9ddf762..402c543c3 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/MoveSceneDialog.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/MoveSceneDialog.kt @@ -41,8 +41,6 @@ import com.darkrockstudios.apps.hammer.common.compose.FormDialog import com.darkrockstudios.apps.hammer.common.compose.FormField import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPickerList -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPickerRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchField import com.darkrockstudios.apps.hammer.common.compose.leftBorder import com.darkrockstudios.apps.hammer.common.compose.resources.get @@ -223,17 +221,39 @@ private fun DestinationList( selectedDestId: Int?, onSelect: (Int) -> Unit, ) { - HdPickerList( - maxVisibleRows = MAX_VISIBLE_DESTINATIONS, - emptyText = if (destinations.isEmpty()) Res.string.scene_move_dialog_no_results.get() else null, + Column( + modifier = Modifier + .fillMaxWidth() + .border( + width = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + shape = RectangleShape + ), ) { - items(items = destinations, key = { it.value.id }) { node -> - DestinationRow( - node = node, - topLevelLabel = topLevelLabel, - isSelected = node.value.id == selectedDestId, - onSelect = onSelect, + if (destinations.isEmpty()) { + Text( + text = Res.string.scene_move_dialog_no_results.get(), + style = MaterialTheme.typography.bodyMedium, + color = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier.padding(Ui.Padding.XL), ) + } else { + // Cap derived from the text-driven row height so the visible row count + // holds steady across font scales. + val lineHeight = MaterialTheme.typography.bodyMedium.lineHeight + val rowHeight = with(LocalDensity.current) { + (if (lineHeight.isSpecified) lineHeight.toDp() else 20.dp) + (Ui.Padding.M * 2) + } + LazyColumn(modifier = Modifier.heightIn(max = rowHeight * MAX_VISIBLE_DESTINATIONS)) { + items(items = destinations, key = { it.value.id }) { node -> + DestinationRow( + node = node, + topLevelLabel = topLevelLabel, + isSelected = node.value.id == selectedDestId, + onSelect = onSelect, + ) + } + } } } } @@ -249,15 +269,36 @@ private fun DestinationRow( val bg = if (isSelected) MaterialTheme.colorScheme.surfaceContainer else Color.Transparent val accent = if (isSelected) MaterialTheme.colorScheme.primary else Color.Transparent - HdPickerRow( - label = if (isTopLevel) topLevelLabel else node.value.name, - depth = node.depth, - icon = if (isTopLevel) Icons.Outlined.Home else Icons.Filled.Folder, + Row( modifier = Modifier + .fillMaxWidth() .background(bg) .leftBorder(2.dp, accent) .clickable { onSelect(node.value.id) } - .testTag(moveDestinationTag(node.value.id)), - trailing = { HdMonoLabel(text = node.children.size.toString()) }, - ) + .testTag(moveDestinationTag(node.value.id)) + .padding( + start = Ui.Padding.L + (Ui.Padding.XL * node.depth), + end = Ui.Padding.L, + top = Ui.Padding.M, + bottom = Ui.Padding.M, + ), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), + ) { + Icon( + imageVector = if (isTopLevel) Icons.Outlined.Home else Icons.Filled.Folder, + contentDescription = null, + tint = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier.size(16.dp), + ) + Text( + text = if (isTopLevel) topLevelLabel else node.value.name, + style = MaterialTheme.typography.bodyMedium, + color = MaterialTheme.colorScheme.onSurface, + maxLines = 1, + overflow = TextOverflow.Ellipsis, + modifier = Modifier.weight(1f), + ) + HdMonoLabel(text = node.children.size.toString()) + } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneGroupItem.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneGroupItem.kt index fd14498f5..a2cc33da8 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneGroupItem.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneGroupItem.kt @@ -9,6 +9,8 @@ import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.size import androidx.compose.material.icons.Icons import androidx.compose.material.icons.automirrored.filled.KeyboardArrowRight +import androidx.compose.material.icons.filled.Folder +import androidx.compose.material.icons.filled.FolderOpen import androidx.compose.material.icons.filled.KeyboardArrowDown import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.Icon @@ -23,16 +25,11 @@ import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdIndentStep -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.hdIndentFor -import com.darkrockstudios.apps.hammer.common.compose.designsystem.hdIndentRails import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.tree.TreeValue import com.darkrockstudios.apps.hammer.scene_group_item_collapsed import com.darkrockstudios.apps.hammer.scene_group_item_expanded -import com.darkrockstudios.apps.hammer.scene_group_scene_count_format fun sceneGroupTag(id: Int) = "scene-group-$id" @@ -51,18 +48,13 @@ internal fun SceneGroupItem( onCreateGroupClick: (scene: SceneItem) -> Unit, ) { val (scene: SceneItem, _, _, children: List>) = sceneNode - val isTopLevel = sceneNode.depth <= 1 - val indent = hdIndentFor(sceneNode.depth) - val railColor = MaterialTheme.colorScheme.outlineVariant + val isTopLevel = sceneNode.depth == 1 val groupModifier = draggable .fillMaxWidth() .testTag(sceneGroupTag(scene.id)) - .hdIndentRails(levels = sceneNode.depth - 1, color = railColor) .clickable { toggleExpand(scene.id) } - val sceneCount = sceneNode.count { it.value.type == SceneItem.Type.Scene } - SceneGroupActionContainer( scene = scene, shouldNux = shouldNux, @@ -74,55 +66,63 @@ internal fun SceneGroupItem( ) { Box(modifier = groupModifier) { Column(modifier = Modifier.fillMaxWidth()) { - // A chapter break cuts the full panel; a nested rule hangs at the group's own indent. - HorizontalDivider( - modifier = Modifier.padding(start = if (isTopLevel) 0.dp else indent), - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - ) + if (isTopLevel) { + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + ) + } Row( modifier = Modifier .fillMaxWidth() .padding( - start = indent, + start = if (isTopLevel) { + Ui.Padding.XL + } else { + Ui.Padding.XL + (Ui.Padding.XL * (sceneNode.depth - 2).coerceAtLeast(0)) + }, end = Ui.Padding.XL, top = Ui.Padding.L, bottom = Ui.Padding.L, ), verticalAlignment = Alignment.CenterVertically, ) { - Icon( - imageVector = if (collapsed) { - Icons.AutoMirrored.Filled.KeyboardArrowRight - } else { - Icons.Filled.KeyboardArrowDown - }, - contentDescription = if (collapsed) { - Res.string.scene_group_item_collapsed.get() - } else { - Res.string.scene_group_item_expanded.get() - }, - tint = MaterialTheme.colorScheme.onSurfaceVariant, - modifier = Modifier.size(HdIndentStep), - ) - - Text( - text = scene.name, - style = if (isTopLevel) { - MaterialTheme.typography.titleSmall - } else { - MaterialTheme.typography.bodyMedium - }, - fontWeight = FontWeight.Medium, - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier.weight(1f), - ) - - if (sceneCount > 0) { - HdMonoLabel( - text = Res.string.scene_group_scene_count_format.get(sceneCount), - modifier = Modifier.padding(start = Ui.Padding.M), + if (isTopLevel) { + Icon( + imageVector = if (collapsed) Icons.AutoMirrored.Filled.KeyboardArrowRight else Icons.Filled.KeyboardArrowDown, + contentDescription = if (collapsed) { + Res.string.scene_group_item_collapsed.get() + } else { + Res.string.scene_group_item_expanded.get() + }, + tint = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier.size(16.dp).padding(end = Ui.Padding.S), + ) + Text( + text = scene.name, + style = MaterialTheme.typography.titleSmall, + fontWeight = FontWeight.Medium, + color = MaterialTheme.colorScheme.onSurface, + modifier = Modifier.weight(1f), + ) + } else { + Icon( + imageVector = if (collapsed) Icons.Filled.Folder else Icons.Filled.FolderOpen, + contentDescription = if (collapsed) { + Res.string.scene_group_item_collapsed.get() + } else { + Res.string.scene_group_item_expanded.get() + }, + tint = MaterialTheme.colorScheme.onSurfaceVariant, + modifier = Modifier.size(20.dp).padding(end = Ui.Padding.M), + ) + Text( + text = scene.name, + style = MaterialTheme.typography.bodyMedium, + fontWeight = FontWeight.Medium, + color = MaterialTheme.colorScheme.onSurface, + modifier = Modifier.weight(1f), ) } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneItem.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneItem.kt index 36bbf83bd..1fd976119 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneItem.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneItem.kt @@ -15,11 +15,9 @@ import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.testTag import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.Dp import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdIndentStep -import com.darkrockstudios.apps.hammer.common.compose.designsystem.hdIndentFor -import com.darkrockstudios.apps.hammer.common.compose.designsystem.hdIndentRails import com.darkrockstudios.apps.hammer.common.compose.leftBorder import com.darkrockstudios.apps.hammer.common.data.SceneItem @@ -42,7 +40,6 @@ internal fun SceneItem( ) { val bg = if (isSelected) MaterialTheme.colorScheme.surfaceContainer else Color.Transparent val accent = if (isSelected) MaterialTheme.colorScheme.primary else Color.Transparent - val railColor = MaterialTheme.colorScheme.outlineVariant SceneItemActionContainer( scene, @@ -57,7 +54,6 @@ internal fun SceneItem( .fillMaxWidth() .testTag(sceneItemTag(scene.id)) .background(bg) - .hdIndentRails(levels = depth - 1, color = railColor) .leftBorder(2.dp, accent) .combinedClickable(onClick = { onSceneSelected(scene) }) ) { @@ -65,8 +61,7 @@ internal fun SceneItem( modifier = Modifier .fillMaxWidth() .padding( - // Clears the disclosure column, so scene names line up with group names. - start = hdIndentFor(depth) + HdIndentStep, + start = sceneRowStartPadding(depth), end = Ui.Padding.XL, top = Ui.Padding.M, bottom = Ui.Padding.M, @@ -90,3 +85,6 @@ internal fun SceneItem( } } } + +private fun sceneRowStartPadding(depth: Int): Dp = + Ui.Padding.XXL + (Ui.Padding.XL * (depth - 1).coerceAtLeast(0)) diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneListUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneListUi.kt index 89c12c854..adf112a48 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneListUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/SceneListUi.kt @@ -1,5 +1,10 @@ package com.darkrockstudios.apps.hammer.common.storyeditor.scenelist +import androidx.compose.animation.AnimatedVisibility +import androidx.compose.animation.fadeIn +import androidx.compose.animation.fadeOut +import androidx.compose.animation.slideInVertically +import androidx.compose.animation.slideOutVertically import androidx.compose.foundation.ExperimentalFoundationApi import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Box @@ -41,11 +46,14 @@ import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.clipToBounds +import androidx.compose.ui.geometry.Offset import androidx.compose.ui.graphics.Color +import androidx.compose.ui.input.nestedscroll.NestedScrollConnection +import androidx.compose.ui.input.nestedscroll.NestedScrollSource import androidx.compose.ui.input.nestedscroll.nestedScroll import androidx.compose.ui.platform.testTag import androidx.compose.ui.unit.Dp +import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.archived_scenes_restored_snackbar @@ -55,8 +63,6 @@ import com.darkrockstudios.apps.hammer.common.compose.RootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdScrollAwayFooter -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdScrollAwayFooterState import com.darkrockstudios.apps.hammer.common.compose.rememberMainDispatcher import com.darkrockstudios.apps.hammer.common.compose.rememberStrRes import com.darkrockstudios.apps.hammer.common.compose.resources.get @@ -82,8 +88,7 @@ import com.darkrockstudios.apps.hammer.scene_list_create_menu_scene import com.darkrockstudios.apps.hammer.scene_list_create_scene_dialog_message import com.darkrockstudios.apps.hammer.scene_list_create_scene_dialog_title import com.darkrockstudios.apps.hammer.scene_list_header -import com.darkrockstudios.apps.hammer.scene_list_outline_button -import com.darkrockstudios.apps.hammer.scene_list_reader_button +import com.darkrockstudios.apps.hammer.scene_list_outline_overview_button import com.darkrockstudios.apps.hammer.view_archived_scenes_button import io.github.aakira.napier.Napier import kotlinx.coroutines.CoroutineScope @@ -96,8 +101,6 @@ const val SCENE_LIST_ADD_BUTTON_TAG = "scene-list-add" const val SCENE_LIST_ADD_SCENE_TAG = "scene-list-add-scene" const val SCENE_LIST_ADD_GROUP_TAG = "scene-list-add-group" const val CREATE_ITEM_NAME_FIELD_TAG = "create-item-name-field" -const val SCENE_LIST_TREE_TAG = "scene-list-tree" -const val SCENE_LIST_READER_BUTTON_TAG = "scene-list-reader" @OptIn( ExperimentalMaterialApi::class, @@ -148,19 +151,26 @@ fun SceneListUi( // TODO implement a real NUX system val shouldNux = remember { Random.nextInt(0, 9) == 0 } - val footerState = rememberHdScrollAwayFooterState() - // Always reachable when the list can't scroll down to it (e.g. all groups collapsed). - val footerVisible = !treeState.listState.canScrollForward || !footerState.isHiddenByScroll - - val surfaceColor = if (inSplitPane) { - MaterialTheme.colorScheme.surfaceContainerLow - } else { - MaterialTheme.colorScheme.surface + var hiddenByScroll by remember { mutableStateOf(false) } + val scrollConnection = remember { + object : NestedScrollConnection { + override fun onPreScroll(available: Offset, source: NestedScrollSource): Offset { + if (available.y < -1f) hiddenByScroll = true + else if (available.y > 1f) hiddenByScroll = false + return Offset.Zero + } + } } + // Always reachable when the list can't scroll down to it (e.g. all groups collapsed). + val footerVisible = !treeState.listState.canScrollForward || !hiddenByScroll Surface( modifier = modifier, - color = surfaceColor, + color = if (inSplitPane) { + MaterialTheme.colorScheme.surfaceContainerLow + } else { + MaterialTheme.colorScheme.surface + }, ) { Column(modifier = Modifier.fillMaxSize()) { val (sceneCount, groupCount) = remember(state.sceneSummary) { @@ -190,10 +200,9 @@ fun SceneListUi( color = MaterialTheme.colorScheme.outlineVariant, ) - Box(modifier = Modifier.weight(1f).clipToBounds()) { + Box(modifier = Modifier.weight(1f)) { SceneTree( - modifier = Modifier.fillMaxSize().testTag(SCENE_LIST_TREE_TAG) - .nestedScroll(footerState.nestedScrollConnection), + modifier = Modifier.fillMaxSize().nestedScroll(scrollConnection), state = treeState, itemUi = { node: TreeValue, toggleExpanded: (nodeId: Int) -> Unit, @@ -225,67 +234,76 @@ fun SceneListUi( createGroup = { parent -> showCreateGroupDialog = parent }, ) }, - contentPadding = PaddingValues(bottom = footerState.height) + contentPadding = PaddingValues(bottom = 80.dp) ) + } - HdScrollAwayFooter( - state = footerState, - visible = footerVisible, - containerColor = surfaceColor, - ) { - HdHairlineButton( - label = Res.string.scene_list_outline_button.get(), - onClick = component::showOutlineOverview, - modifier = Modifier.weight(1f), + AnimatedVisibility( + visible = footerVisible, + enter = slideInVertically(initialOffsetY = { it }) + fadeIn(), + exit = slideOutVertically(targetOffsetY = { it }) + fadeOut(), + ) { + Column { + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, ) - HdHairlineButton( - label = Res.string.scene_list_reader_button.get(), - onClick = component::showReaderMode, - modifier = Modifier.weight(1f).testTag(SCENE_LIST_READER_BUTTON_TAG), - ) - Box { - IconButton( - onClick = { addMenuOpen = true }, - modifier = Modifier.testTag(SCENE_LIST_ADD_BUTTON_TAG), - ) { - Icon( - imageVector = Icons.Filled.Add, - contentDescription = Res.string.scene_list_add_button.get(), - tint = MaterialTheme.colorScheme.onSurfaceVariant, - ) - } - DropdownMenu( - expanded = addMenuOpen, - onDismissRequest = { addMenuOpen = false }, - ) { - DropdownMenuItem( - modifier = Modifier.testTag(SCENE_LIST_ADD_SCENE_TAG), - text = { Text(Res.string.scene_list_create_menu_scene.get()) }, - leadingIcon = { - Icon( - imageVector = Icons.Filled.PostAdd, - contentDescription = null, - ) - }, - onClick = { - addMenuOpen = false - showCreateSceneDialog = treeState.summary.sceneTree.root.value - }, - ) - DropdownMenuItem( - modifier = Modifier.testTag(SCENE_LIST_ADD_GROUP_TAG), - text = { Text(Res.string.scene_list_create_menu_group.get()) }, - leadingIcon = { - Icon( - imageVector = Icons.Filled.CreateNewFolder, - contentDescription = null, - ) - }, - onClick = { - addMenuOpen = false - showCreateGroupDialog = treeState.summary.sceneTree.root.value - }, - ) + Row( + modifier = Modifier + .fillMaxWidth() + .padding(horizontal = Ui.Padding.M, vertical = Ui.Padding.M), + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.spacedBy(Ui.Padding.M), + ) { + HdHairlineButton( + label = Res.string.scene_list_outline_overview_button.get(), + onClick = component::showOutlineOverview, + modifier = Modifier.weight(1f), + ) + Box { + IconButton( + onClick = { addMenuOpen = true }, + modifier = Modifier.testTag(SCENE_LIST_ADD_BUTTON_TAG), + ) { + Icon( + imageVector = Icons.Filled.Add, + contentDescription = Res.string.scene_list_add_button.get(), + tint = MaterialTheme.colorScheme.onSurfaceVariant, + ) + } + DropdownMenu( + expanded = addMenuOpen, + onDismissRequest = { addMenuOpen = false }, + ) { + DropdownMenuItem( + modifier = Modifier.testTag(SCENE_LIST_ADD_SCENE_TAG), + text = { Text(Res.string.scene_list_create_menu_scene.get()) }, + leadingIcon = { + Icon( + imageVector = Icons.Filled.PostAdd, + contentDescription = null, + ) + }, + onClick = { + addMenuOpen = false + showCreateSceneDialog = treeState.summary.sceneTree.root.value + }, + ) + DropdownMenuItem( + modifier = Modifier.testTag(SCENE_LIST_ADD_GROUP_TAG), + text = { Text(Res.string.scene_list_create_menu_group.get()) }, + leadingIcon = { + Icon( + imageVector = Icons.Filled.CreateNewFolder, + contentDescription = null, + ) + }, + onClick = { + addMenuOpen = false + showCreateGroupDialog = treeState.summary.sceneTree.root.value + }, + ) + } } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTree.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTree.kt index 0db724680..9cd27646f 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTree.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTree.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.scenetree import androidx.compose.foundation.Canvas import androidx.compose.foundation.ExperimentalFoundationApi -import androidx.compose.foundation.gestures.awaitEachGesture -import androidx.compose.foundation.gestures.awaitFirstDown import androidx.compose.foundation.gestures.detectDragGesturesAfterLongPress import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.PaddingValues @@ -18,22 +16,18 @@ import androidx.compose.foundation.lazy.items import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text import androidx.compose.runtime.Composable -import androidx.compose.runtime.DisposableEffect import androidx.compose.ui.Modifier import androidx.compose.ui.draw.clipToBounds import androidx.compose.ui.geometry.Offset import androidx.compose.ui.graphics.Color import androidx.compose.ui.graphics.StrokeCap import androidx.compose.ui.hapticfeedback.HapticFeedbackType -import androidx.compose.ui.input.pointer.PointerInputChange import androidx.compose.ui.input.pointer.pointerInput -import androidx.compose.ui.layout.onGloballyPositioned import androidx.compose.ui.platform.LocalHapticFeedback import androidx.compose.ui.text.style.TextAlign import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList import com.darkrockstudios.apps.hammer.common.compose.Ui -import com.darkrockstudios.apps.hammer.common.compose.designsystem.hdIndentFor /** * The root composable take takes a scene tree and handles rendering, reorder, collapsing @@ -61,7 +55,6 @@ fun SceneTree( LazyColumn( state = state.listState, modifier = modifier.reorderableModifier(state) - .onGloballyPositioned { state.setListCoordinates(it) } .weight(1f), contentPadding = contentPadding ) { @@ -72,9 +65,6 @@ fun SceneTree( ) { node -> val nodeCollapsesChildren = state.collapsedNodes[node.value.id] ?: false - val id = node.value.id - - DisposableEffect(id) { onDispose { state.removeRowCoordinates(id) } } SceneTreeNode( node = node, @@ -83,9 +73,7 @@ fun SceneTree( toggleExpanded = state::toggleExpanded, modifier = Modifier.wrapContentHeight() .fillMaxWidth() - .animateItem() - .onGloballyPositioned { state.setRowCoordinates(id, it) } - .pressCandidate(state, id), + .animateItem(), itemUi = itemUi ) } @@ -97,31 +85,6 @@ fun SceneTree( } } -/** - * Claims this row as the drag target for as long as it is pressed. - * - * The row is settled at touch-down, not when the long press expires, so a list still settling - * under a stationary finger hands back the row the user aimed at rather than whichever row has - * since slid beneath them. - */ -private fun Modifier.pressCandidate(state: SceneTreeState, id: Int): Modifier = - pointerInput(id) { - awaitEachGesture { - val down = awaitFirstDown(requireUnconsumed = false) - if (!state.claimPress(down.id, id)) return@awaitEachGesture - - // The release must survive this row being disposed mid-press, which cancels us. - try { - var change: PointerInputChange? - do { - change = awaitPointerEvent().changes.firstOrNull { it.id == down.id } - } while (change?.pressed == true) - } finally { - state.releasePress(down.id) - } - } - } - @Composable private fun Modifier.reorderableModifier(state: SceneTreeState): Modifier { val hapticFeedback = LocalHapticFeedback.current @@ -129,12 +92,13 @@ private fun Modifier.reorderableModifier(state: SceneTreeState): Modifier { return pointerInput(Unit) { detectDragGesturesAfterLongPress( onDragStart = { offset -> - val id = pressedRowId - if (id != SceneTreeState.NO_SELECTION) { - hapticFeedback.performHapticFeedback(HapticFeedbackType.LongPress) - startDragging(id) - updateDragPosition(offset) - autoScrollForDrag() + for (itemInfo in listState.layoutInfo.visibleItemsInfo) { + if (offset.y >= itemInfo.offset && offset.y <= (itemInfo.offset + itemInfo.size)) { + hapticFeedback.performHapticFeedback(HapticFeedbackType.LongPress) + val id = itemInfo.key as Int + startDragging(id) + break + } } }, onDragCancel = { @@ -145,14 +109,37 @@ private fun Modifier.reorderableModifier(state: SceneTreeState): Modifier { } ) { change, _ -> change.consume() - updateDragPosition(change.position) - autoScrollForDrag() + + val layoutInfo: LazyListLayoutInfo = listState.layoutInfo + val insertPosition = findInsertPosition( + dragOffset = change.position, + layouts = layoutInfo.visibleItemsInfo, + collapsedGroups = collapsedNodes, + tree = summary.sceneTree, + visibleNodes = visibleNodes, + selectedNode = selectedNode, + ) + + if (insertAt != insertPosition) { + insertAt = insertPosition + } + + // Auto scroll + val height = layoutInfo.viewportSize.height - layoutInfo.viewportStartOffset + val bottomTenPercent: Float = height * .9f + val topTenPercent: Float = height * .1f + + if (change.position.y >= bottomTenPercent) { + autoScroll(false) + } else if (change.position.y <= topTenPercent) { + autoScroll(true) + } } } } } -private val EDGE_INSET = 16f.dp +private val NESTING_INSET = 16f.dp @Composable private fun drawInsertLine( @@ -182,13 +169,17 @@ private fun drawInsertLine( return@Canvas } - val visibleItems = state.rowLayouts - val anchorLayout = visibleItems.find { it.id == node.value.id } + val visibleItems = state.listState.layoutInfo.visibleItemsInfo + val anchorLayout = visibleItems.find { it.key == node.value.id } - val lineY: Float + val lineY: Int val nestingDept: Int if (anchorLayout != null) { - lineY = if (insertPos.before) anchorLayout.top else anchorLayout.bottom + lineY = if (insertPos.before) { + anchorLayout.offset + } else { + anchorLayout.offset + anchorLayout.size + } val isGroup = node.value.type.isCollection val isCollapsed = (state.collapsedNodes[node.value.id] == true) @@ -206,17 +197,17 @@ private fun drawInsertLine( .any { state.collapsedNodes[it.value.id] == true } if (!hiddenByCollapse) return@Canvas val parentNode = tree[node.parent] - val parentLayout = visibleItems.find { it.id == parentNode.value.id } ?: return@Canvas - lineY = parentLayout.bottom + val parentLayout = visibleItems.find { it.key == parentNode.value.id } ?: return@Canvas + lineY = parentLayout.offset + parentLayout.size nestingDept = parentNode.depth + 1 } - val insetSize = hdIndentFor(nestingDept).toPx() - val endX = size.width - EDGE_INSET.toPx() + val insetSize = (nestingDept * NESTING_INSET.toPx()) + val endX = size.width - NESTING_INSET.toPx() drawLine( - start = Offset(x = insetSize, y = lineY), - end = Offset(x = endX, y = lineY), + start = Offset(x = insetSize, y = lineY.toFloat()), + end = Offset(x = endX, y = lineY.toFloat()), color = color, strokeWidth = 5f.dp.toPx(), cap = StrokeCap.Round diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeState.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeState.kt index a43e4d60b..500c1765b 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeState.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeState.kt @@ -14,9 +14,6 @@ import androidx.compose.runtime.saveable.Saver import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.setValue import androidx.compose.runtime.snapshots.SnapshotStateMap -import androidx.compose.ui.geometry.Offset -import androidx.compose.ui.input.pointer.PointerId -import androidx.compose.ui.layout.LayoutCoordinates import com.darkrockstudios.apps.hammer.common.data.InsertPosition import com.darkrockstudios.apps.hammer.common.data.MoveRequest import com.darkrockstudios.apps.hammer.common.data.SceneItem @@ -71,113 +68,13 @@ class SceneTreeState( internal var summary by mutableStateOf(sceneSummary) var selectedId by mutableStateOf(NO_SELECTION) var selectedNode by mutableStateOf?>(null) + var insertAt by mutableStateOf(null) /** The rows the tree renders, in display order — also the drag handler's id → node lookup. */ val visibleNodes: List> by derivedStateOf { visibleSceneNodes(summary.sceneTree, collapsedNodes) } - var dragPosition by mutableStateOf(null) - private set - - /** - * Derived rather than assigned from the drag handler, because the pointer is only half of it: - * autoscroll slides the rows out from under a finger that never moves and so never delivers - * another event. Recomputing whenever either side changes keeps the drop target under the - * finger, and [rowLayouts] re-reads on every placement pass to make that happen. - */ - val insertAt: InsertPosition? by derivedStateOf { - val position = dragPosition ?: return@derivedStateOf null - - findInsertPosition( - dragOffset = position, - layouts = rowLayouts, - collapsedGroups = collapsedNodes, - tree = summary.sceneTree, - visibleNodes = visibleNodes, - selectedNode = selectedNode, - ) - } - - /** - * Row this press started on, claimed by the row itself so it is the row the user aimed at. - * Deliberately not snapshot state: it changes on every press and must not recompose the tree. - */ - internal var pressedRowId: Int = NO_SELECTION - private set - - private var pressedPointer: PointerId? = null - - /** - * Records [rowId] as the press target, but only for the first pointer down. The drag detector - * follows that same pointer, so later fingers must not be able to retarget the drag. - */ - internal fun claimPress(pointer: PointerId, rowId: Int): Boolean { - if (pressedPointer != null) return false - - pressedPointer = pointer - pressedRowId = rowId - return true - } - - internal fun releasePress(pointer: PointerId) { - if (pressedPointer != pointer) return - - pressedPointer = null - pressedRowId = NO_SELECTION - } - - private data class RowEntry(val coordinates: LayoutCoordinates, val placement: Int) - - private val rows = mutableStateMapOf() - private var placementCount = 0 - private var listCoordinates: LayoutCoordinates? = null - - /** - * Where the rows are actually drawn, in display order, which is what every drag decision has - * to be made against. - * - * Thar be dragons: [LazyListLayoutInfo] looks like the obvious source and is not. Its offsets - * are where items are headed, so while a placement animation runs it reports a row at a slot - * it has not reached, and drags land on the neighbour instead (issue #837). - */ - internal val rowLayouts: List - get() { - val list = listCoordinates?.takeIf { it.isAttached } ?: return emptyList() - - return rows.entries.mapNotNull { (id, entry) -> - if (!entry.coordinates.isAttached) return@mapNotNull null - - RowLayout( - id = id, - top = list.localPositionOf(entry.coordinates, Offset.Zero).y, - height = entry.coordinates.size.height.toFloat(), - ) - }.sortedBy { it.top } - } - - internal fun setListCoordinates(coordinates: LayoutCoordinates) { - listCoordinates = coordinates - } - - /** - * Coordinates are held live rather than sampled: item placement animations move a row by - * translating its layer every frame, without a new layout pass, so a position read during - * [androidx.compose.ui.layout.onGloballyPositioned] is the row's destination rather than - * where it is drawn. Resolving them against the list at drag time sees through that. - * - * [RowEntry.placement] makes every call a distinct map value. Re-putting equal coordinates - * is a no-op the snapshot system does not report, which would leave the insert line with - * nothing to invalidate it as rows scroll. - */ - internal fun setRowCoordinates(id: Int, coordinates: LayoutCoordinates) { - rows[id] = RowEntry(coordinates, placementCount++) - } - - internal fun removeRowCoordinates(id: Int) { - rows.remove(id) - } - private var scrollJob by mutableStateOf(null) private var treeHash by mutableStateOf(sceneSummary.sceneTree.hashCode()) @@ -215,42 +112,19 @@ class SceneTreeState( collapsedNodes.clear() } - /** True to scroll up, false to scroll down, null when the drag is clear of both edges. */ - private fun dragScrollDirection(): Boolean? { - val position = dragPosition ?: return null - val layoutInfo = listState.layoutInfo - val height = layoutInfo.viewportSize.height - layoutInfo.viewportStartOffset - if (height <= 0) return null - - return when { - position.y >= height * AUTO_SCROLL_ZONE_END -> false - position.y <= height * AUTO_SCROLL_ZONE_START -> true - else -> null - } - } - - /** - * Scrolls a row at a time while the drag is held near either edge. - * - * The job keeps stepping on its own until the pointer leaves the edge or the list runs out, - * because a drag parked in the hot zone delivers no further pointer events to step it along. - */ - internal fun autoScrollForDrag() { + fun autoScroll(up: Boolean) { if (scrollJob?.isActive == true) return - if (dragScrollDirection() == null) return scrollJob = coroutineScope.launch { - while (true) { - val up = dragScrollDirection() ?: break - if (up && !listState.canScrollBackward) break - if (!up && !listState.canScrollForward) break - - val target = if (up) { - (listState.firstVisibleItemIndex - 1).coerceAtLeast(0) - } else { - listState.firstVisibleItemIndex + 1 + if (up) { + val targetIndex = (listState.firstVisibleItemIndex - 1).coerceAtLeast(0) + listState.animateScrollToItem(targetIndex) + } else { + val visibleItems = listState.layoutInfo.visibleItemsInfo + if (visibleItems.isNotEmpty()) { + val nextIndex = listState.firstVisibleItemIndex + 1 + listState.animateScrollToItem(nextIndex) } - listState.animateScrollToItem(target) } } } @@ -262,10 +136,6 @@ class SceneTreeState( } } - internal fun updateDragPosition(position: Offset) { - dragPosition = position - } - fun stopDragging() { val insertPosition = insertAt if (selectedId != ROOT_ID && insertPosition != null) { @@ -278,8 +148,7 @@ class SceneTreeState( selectedId = NO_SELECTION selectedNode = null - dragPosition = null - scrollJob?.cancel() + insertAt = null } fun toggleExpanded(nodeId: Int) { @@ -289,8 +158,5 @@ class SceneTreeState( companion object { const val NO_SELECTION = -1 - - private const val AUTO_SCROLL_ZONE_START = .1f - private const val AUTO_SCROLL_ZONE_END = .9f } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeUtils.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeUtils.kt index 9b53c7e89..af4400c40 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeUtils.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/scenelist/scenetree/SceneTreeUtils.kt @@ -1,5 +1,6 @@ package com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.scenetree +import androidx.compose.foundation.lazy.LazyListItemInfo import androidx.compose.runtime.snapshots.SnapshotStateMap import androidx.compose.ui.geometry.Offset import com.darkrockstudios.apps.hammer.common.data.InsertPosition @@ -30,14 +31,9 @@ internal fun visibleSceneNodes( return visible } -/** A row as it is drawn, in coordinates shared with the drag gesture. */ -internal data class RowLayout(val id: Int, val top: Float, val height: Float) { - val bottom: Float get() = top + height -} - internal fun findInsertPosition( dragOffset: Offset, - layouts: Collection, + layouts: List, collapsedGroups: SnapshotStateMap, tree: ImmutableTree, visibleNodes: List>, @@ -49,9 +45,9 @@ internal fun findInsertPosition( val selectedId = selectedNode.value.id var foundItemId: InsertPosition? = null for (layout in layouts) { - val id = layout.id - val size = layout.height - val itemPos = layout.top + val id = layout.key as Int + val size = layout.size + val itemPos = layout.offset if (id != selectedId && dragY >= itemPos diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/CreateTimeLineEventUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/CreateTimeLineEventUi.kt index 7c4aa1243..ee118cfc5 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/CreateTimeLineEventUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/CreateTimeLineEventUi.kt @@ -7,7 +7,6 @@ import androidx.compose.material3.CardDefaults import androidx.compose.material3.HorizontalDivider import androidx.compose.material3.MaterialTheme import androidx.compose.runtime.* -import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.RectangleShape @@ -20,7 +19,6 @@ import com.darkrockstudios.apps.hammer.common.components.timeline.CreateTimeLine import com.darkrockstudios.apps.hammer.common.compose.* import com.darkrockstudios.apps.hammer.common.compose.designsystem.* import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownEditField -import com.darkrockstudios.apps.hammer.common.compose.rememberSaveableStringList import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineEventError import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineRepository @@ -42,10 +40,10 @@ fun CreateTimeLineEventUi( val strRes = rememberStrRes() val state by component.state.subscribeAsState() val contentText by component.contentText.subscribeAsState() - var dateText by rememberSaveable { mutableStateOf("") } + var dateText by remember { mutableStateOf("") } var dateFocused by remember { mutableStateOf(false) } var resetVersion by remember { mutableStateOf(0) } - val tags = rememberSaveableStringList() + val tags = remember { mutableStateListOf() } val wordCount = remember(contentText) { contentText.split(Regex("\\s+")).count { it.isNotBlank() } @@ -139,7 +137,6 @@ fun CreateTimeLineEventUi( MarkdownEditField( initialMarkdown = contentText, onMarkdownChanged = { component.onContentChanged(it) }, - enableSpellChecking = state.spellCheckAllowed, contentPadding = PaddingValues(Ui.Padding.XL), testTag = TIME_LINE_CREATE_CONTENT_TAG, modifier = Modifier diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/TimeLineOverviewUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/TimeLineOverviewUi.kt index b39d41e75..860f87794 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/TimeLineOverviewUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/TimeLineOverviewUi.kt @@ -30,7 +30,6 @@ import androidx.compose.foundation.layout.wrapContentHeight import androidx.compose.foundation.lazy.LazyColumn import androidx.compose.foundation.lazy.LazyRow import androidx.compose.foundation.lazy.items -import androidx.compose.foundation.lazy.rememberLazyListState import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Search import androidx.compose.material3.ExperimentalMaterial3Api @@ -42,7 +41,7 @@ import androidx.compose.material3.Text import androidx.compose.material3.TopAppBarDefaults import androidx.compose.material3.TopAppBarScrollBehavior import androidx.compose.material3.rememberTopAppBarState -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.derivedStateOf import androidx.compose.runtime.getValue @@ -68,7 +67,6 @@ import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.timeline.TimeLineOverview import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.MpScrollBarList import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdDragHandle import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdFolioDivider @@ -80,9 +78,7 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagChip import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownView import com.darkrockstudios.apps.hammer.common.compose.reorderable.DragDropList import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.scrollBarOverlay import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors -import com.darkrockstudios.apps.hammer.common.data.search.markdownContains import com.darkrockstudios.apps.hammer.common.data.tagindex.TagCount import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineEvent import com.darkrockstudios.apps.hammer.timeline_filter_all @@ -100,14 +96,8 @@ import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.launch import kotlin.math.roundToInt -/** An event matches on its body read as prose, or on its plain-text date. */ -internal fun eventMatchesQuery(event: TimeLineEvent, query: String): Boolean = - markdownContains(event.content, query) || - event.date?.contains(query, ignoreCase = true) == true - const val TIME_LINE_CREATE_TAG = "Timeline Overview Create" const val TIME_LINE_LIST_TAG = "Timeline Overview List" -const val TIME_LINE_SEARCH_TAG = "Timeline Overview Search" const val EVENT_CARD_TAG = "Timeline Event Card" const val EVENT_CARD_DATE_TAG = "Timeline Event Card Date" const val EVENT_CARD_CONTENT_TAG = "Timeline Event Card Content" @@ -143,8 +133,10 @@ fun TimeLineOverviewUi( val byText = if (searchQuery.isBlank()) { events } else { - val query = searchQuery.trim() - events.filter { eventMatchesQuery(it, query) } + events.filter { event -> + event.content.contains(searchQuery.trim(), ignoreCase = true) || + event.date?.contains(searchQuery.trim(), ignoreCase = true) == true + } } val byTags = if (activeTags.isEmpty()) { byText @@ -194,7 +186,6 @@ fun TimeLineOverviewUi( }, collapseContentDescription = Res.string.timeline_search_close.get(), modifier = Modifier.fillMaxSize(), - testTag = TIME_LINE_SEARCH_TAG, ) } else { Row( @@ -349,27 +340,18 @@ fun TimeLineOverviewUi( } else -> { - val listState = rememberLazyListState() - Box { - LazyColumn( - state = listState, - modifier = Modifier - .fillMaxSize() - .testTag(TIME_LINE_LIST_TAG), - contentPadding = listContentPadding, - ) { - items( - items = visibleEvents, - key = { event -> event.id }, - ) { event -> - eventRow(event, false) - } + LazyColumn( + modifier = Modifier + .fillMaxSize() + .testTag(TIME_LINE_LIST_TAG), + contentPadding = listContentPadding, + ) { + items( + items = visibleEvents, + key = { event -> event.id }, + ) { event -> + eventRow(event, false) } - - MpScrollBarList( - modifier = scrollBarOverlay(), - state = listState, - ) } } } diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/ViewTimeLineEventUi.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/ViewTimeLineEventUi.kt index b8eebc694..9e0918e78 100644 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/ViewTimeLineEventUi.kt +++ b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/timeline/ViewTimeLineEventUi.kt @@ -135,7 +135,6 @@ fun ViewTimeLineEventUi( eventText = eventText, onEventTextChanged = { component.onEventTextChanged(it) }, suggestTags = component::suggestTags, - enableSpellChecking = state.spellCheckAllowed, modifier = Modifier.weight(1f), ) @@ -322,59 +321,52 @@ private fun ViewBody( modifier: Modifier = Modifier, ) { val scrollState = rememberScrollState() - Box(modifier = modifier) { - Column( - modifier = Modifier - .fillMaxWidth() - .verticalScroll(scrollState) - .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), - ) { - val eventTags = event?.tags - if (!eventTags.isNullOrEmpty()) { - FlowRow( - modifier = Modifier - .fillMaxWidth() - .padding(bottom = Ui.Padding.L), - horizontalArrangement = Arrangement.spacedBy(6.dp), - verticalArrangement = Arrangement.spacedBy(6.dp), - ) { - eventTags.sorted().forEach { tag -> - HdTagChip( - label = tag, - active = true, - onClick = { onTagClick(tag) }, - onRemove = { onTagRemove(tag) }, - ) - } + Column( + modifier = modifier + .fillMaxWidth() + .verticalScroll(scrollState) + .padding(horizontal = Ui.Padding.XL, vertical = Ui.Padding.XL), + ) { + val eventTags = event?.tags + if (!eventTags.isNullOrEmpty()) { + FlowRow( + modifier = Modifier + .fillMaxWidth() + .padding(bottom = Ui.Padding.L), + horizontalArrangement = Arrangement.spacedBy(6.dp), + verticalArrangement = Arrangement.spacedBy(6.dp), + ) { + eventTags.sorted().forEach { tag -> + HdTagChip( + label = tag, + active = true, + onClick = { onTagClick(tag) }, + onRemove = { onTagRemove(tag) }, + ) } - - HorizontalDivider( - thickness = Dp.Hairline, - color = MaterialTheme.colorScheme.outlineVariant, - modifier = Modifier.padding(bottom = Ui.Padding.L), - ) } - with(sharedTransitionScope) { - MarkdownView( - markdown = eventText, - modifier = Modifier - .fillMaxWidth() - .sharedElement( - sharedContentState = rememberSharedContentState( - key = "timeline-content-${event?.id}", - ), - animatedVisibilityScope = animatedVisibilityScope, - ) - .clickable(onClick = onEnterEdit), - ) - } + HorizontalDivider( + thickness = Dp.Hairline, + color = MaterialTheme.colorScheme.outlineVariant, + modifier = Modifier.padding(bottom = Ui.Padding.L), + ) } - MpScrollBarColumn( - modifier = scrollBarOverlay(), - state = scrollState, - ) + with(sharedTransitionScope) { + MarkdownView( + markdown = eventText, + modifier = Modifier + .fillMaxWidth() + .sharedElement( + sharedContentState = rememberSharedContentState( + key = "timeline-content-${event?.id}", + ), + animatedVisibilityScope = animatedVisibilityScope, + ) + .clickable(onClick = onEnterEdit), + ) + } } } @@ -387,7 +379,6 @@ private fun EditBody( eventText: String, onEventTextChanged: (String) -> Unit, suggestTags: (prefix: String) -> List, - enableSpellChecking: Boolean, modifier: Modifier = Modifier, ) { // Date hides while the body editor has focus, like the tags; kept visible while it holds focus @@ -433,7 +424,6 @@ private fun EditBody( MarkdownEditField( initialMarkdown = eventText, onMarkdownChanged = onEventTextChanged, - enableSpellChecking = enableSpellChecking, contentPadding = PaddingValues(Ui.Padding.XL), modifier = Modifier .fillMaxWidth() diff --git a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/utils/AddToDictionaryMenu.kt b/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/utils/AddToDictionaryMenu.kt deleted file mode 100644 index 8bb976325..000000000 --- a/composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/utils/AddToDictionaryMenu.kt +++ /dev/null @@ -1,18 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.utils - -import com.darkrockstudios.apps.hammer.common.spellcheck.normalizeDictionaryWord -import com.darkrockstudios.texteditor.contextmenu.ContextMenuItem -import com.darkrockstudios.texteditor.spellcheck.SpellCheckItem - -/** - * Context-menu items for a flagged span: "Add to dictionary" on a misspelled word the - * dictionary can store, nothing on sentence issues or unstorable tokens. - */ -fun addToDictionaryMenuItems( - label: String, - addWord: (String) -> Unit, -): (SpellCheckItem) -> List = { item -> - val word = (item as? SpellCheckItem.MisspelledWord) - ?.let { normalizeDictionaryWord(it.segment.text) } - if (word != null) listOf(ContextMenuItem(label = label) { addWord(word) }) else emptyList() -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.desktop.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.desktop.kt deleted file mode 100644 index b07d118ed..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.desktop.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Composable -import java.awt.Toolkit -import java.awt.datatransfer.StringSelection - -@Composable -actual fun rememberClipboardCopier(): (String) -> Unit = { text -> - Toolkit.getDefaultToolkit().systemClipboard.setContents(StringSelection(text), null) -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt index d90fb168c..c396b5728 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt @@ -1,180 +1,18 @@ package com.darkrockstudios.apps.hammer.common.compose -import androidx.compose.foundation.ScrollState -import androidx.compose.foundation.ScrollbarStyle import androidx.compose.foundation.VerticalScrollbar -import androidx.compose.foundation.gestures.scrollBy -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxHeight -import androidx.compose.foundation.layout.width import androidx.compose.foundation.lazy.LazyListState -import androidx.compose.foundation.lazy.grid.LazyGridState -import androidx.compose.foundation.lazy.staggeredgrid.LazyStaggeredGridState import androidx.compose.foundation.rememberScrollbarAdapter -import androidx.compose.foundation.v2.ScrollbarAdapter -import androidx.compose.material3.MaterialTheme import androidx.compose.runtime.Composable -import androidx.compose.runtime.remember -import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.drawWithCache -import androidx.compose.ui.graphics.Path -import androidx.compose.ui.graphics.RectangleShape -import androidx.compose.ui.graphics.drawscope.Stroke -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -private val RailWidth = 10.dp - -/** Strip reserved for the edge rule; the thumb covers the rest of the rail exactly. */ -private val RuleInset = 1.dp -private val ThumbThickness = RailWidth - RuleInset -private val HatchSpacing = 5.dp - -actual val MpScrollBarGutter: Dp = RailWidth @Composable actual fun MpScrollBarList( modifier: Modifier, state: LazyListState ) { - ScrollbarRail(modifier, state.isScrollable, rememberScrollbarAdapter(state)) -} - -@Composable -actual fun MpScrollBarColumn( - modifier: Modifier, - state: ScrollState -) { - // A ScrollState that was never attached to a scrolling container reports maxValue as - // Int.MAX_VALUE, which would otherwise read as "scrollable" and draw a rail over nothing. - val scrollable = state.maxValue != Int.MAX_VALUE && state.isScrollable - ScrollbarRail(modifier, scrollable, rememberScrollbarAdapter(state)) -} - -@Composable -actual fun MpScrollBarGrid( - modifier: Modifier, - state: LazyGridState -) { - ScrollbarRail(modifier, state.isScrollable, rememberScrollbarAdapter(state)) -} - -@Composable -actual fun MpScrollBarStaggeredGrid( - modifier: Modifier, - state: LazyStaggeredGridState -) { - ScrollbarRail( + VerticalScrollbar( modifier = modifier, - scrollable = state.isScrollable, - adapter = remember(state) { StaggeredGridScrollbarAdapter(state) }, + adapter = rememberScrollbarAdapter(state) ) } - -/** - * Gutter the scrollbar lives in: a vertical `outlineVariant` hairline marking the scrollable edge, - * with a hatched track inside it that the thumb masks as it travels. Both are drawn only while - * there is somewhere to scroll, so screens that fit get no chrome at all. - * - * ``` - * │╱╱╱│ - * │███│ <- thumb, masking the hatch - * │╱╱╱│ - * ^ edge rule - * ``` - */ -@Composable -private fun ScrollbarRail( - modifier: Modifier, - scrollable: Boolean, - adapter: ScrollbarAdapter, -) { - val colorScheme = MaterialTheme.colorScheme - val ruleColor = colorScheme.outlineVariant - val hatchColor = ruleColor.copy(alpha = 0.55f) - val style = remember(colorScheme) { - ScrollbarStyle( - minimalHeight = 24.dp, - thickness = ThumbThickness, - shape = RectangleShape, - hoverDurationMillis = 220, - unhoverColor = colorScheme.outlineVariant, - hoverColor = colorScheme.outline, - ) - } - Box( - modifier = modifier - .width(RailWidth) - .drawWithCache { - val stroke = Stroke(width = Dp.Hairline.toPx().coerceAtLeast(1f)) - val rule = Path().apply { - val x = stroke.width / 2f - moveTo(x, 0f) - lineTo(x, size.height) - } - val hatch = hatchPath( - inset = RuleInset.toPx(), - spacing = HatchSpacing.toPx(), - width = size.width, - height = size.height, - ) - onDrawBehind { - if (!scrollable) return@onDrawBehind - drawPath(rule, ruleColor, style = stroke) - drawPath(hatch, hatchColor, style = stroke) - } - }, - contentAlignment = Alignment.CenterEnd, - ) { - VerticalScrollbar( - adapter = adapter, - modifier = Modifier.fillMaxHeight(), - style = style, - ) - } -} - -/** - * 45 degree hatching for the track, built once per size rather than a line per draw pass. Segments - * are clamped to the track rather than clipped, so no off-screen geometry is submitted. - */ -private fun hatchPath(inset: Float, spacing: Float, width: Float, height: Float): Path { - val path = Path() - if (spacing <= 0f || width <= inset || height <= 0f) return path - // Each line runs bottom-left to top-right: y = height - (x - origin). - var origin = inset - height - while (origin < width) { - val x1 = maxOf(inset, origin) - val x2 = minOf(width, origin + height) - if (x2 > x1) { - path.moveTo(x1, height - (x1 - origin)) - path.lineTo(x2, height - (x2 - origin)) - } - origin += spacing - } - return path -} - -/** - * Compose ships no scrollbar adapter for staggered grids, but the state exposes the same metrics - * the built-in adapters are built from. Dragging scrolls by pixel delta rather than snapping. - */ -private class StaggeredGridScrollbarAdapter( - private val state: LazyStaggeredGridState, -) : ScrollbarAdapter { - - override val viewportSize: Double - get() = state.scrollIndicatorState?.viewportSize?.toDouble() ?: 0.0 - - // Matching the viewport means "nothing to scroll", which is the right reading before measurement. - override val contentSize: Double - get() = state.scrollIndicatorState?.contentSize?.toDouble() ?: viewportSize - - override val scrollOffset: Double - get() = state.scrollIndicatorState?.scrollOffset?.toDouble() ?: 0.0 - - override suspend fun scrollTo(scrollOffset: Double) { - state.scrollBy((scrollOffset - this.scrollOffset).toFloat()) - } -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt new file mode 100644 index 000000000..2dc0fa588 --- /dev/null +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt @@ -0,0 +1,8 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import androidx.compose.runtime.Composable +import androidx.compose.ui.graphics.painter.Painter + +@Composable +actual fun painterResource(res: String, drawableKlass: Any?): Painter = + androidx.compose.ui.res.painterResource(res) \ No newline at end of file diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt deleted file mode 100644 index 56a079b6c..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt +++ /dev/null @@ -1,7 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.ui.input.pointer.PointerIcon -import java.awt.Cursor - -actual fun horizontalResizePointerIcon(): PointerIcon = - PointerIcon(Cursor(Cursor.E_RESIZE_CURSOR)) diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt index 2cb1a5853..b03716899 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt @@ -22,20 +22,19 @@ import com.darkrockstudios.apps.hammer.common.compose.Ui internal actual fun EditorAction( icon: ImageVector, active: Boolean, - enabled: Boolean, onClick: () -> Unit ) { val painter = rememberVectorPainter(icon) Box( modifier = Modifier - .onClick(enabled = enabled) { onClick() } + .onClick { onClick() } .padding(Ui.Padding.L) ) { Icon( modifier = Modifier.size(24.dp), painter = painter, - tint = editorActionColor(active, enabled), + tint = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, contentDescription = null ) } @@ -46,12 +45,11 @@ internal actual fun EditorAction( internal actual fun EditorTextAction( label: String, active: Boolean, - enabled: Boolean, onClick: () -> Unit, ) { Box( modifier = Modifier - .onClick(enabled = enabled) { onClick() } + .onClick { onClick() } .padding(Ui.Padding.L) .defaultMinSize(minWidth = 24.dp, minHeight = 24.dp), contentAlignment = Alignment.Center, @@ -59,7 +57,7 @@ internal actual fun EditorTextAction( Text( text = label, style = MaterialTheme.typography.labelLarge, - color = editorActionColor(active, enabled), + color = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, ) } } diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.desktop.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.desktop.kt deleted file mode 100644 index 819a4aca5..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.desktop.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.theme - -actual val oledBlackThemeAvailable: Boolean = false diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AccountSettingsUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AccountSettingsUi.Preview.kt index 9fab243d6..8b609f314 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AccountSettingsUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AccountSettingsUi.Preview.kt @@ -4,7 +4,6 @@ import androidx.compose.runtime.Composable import androidx.compose.ui.tooling.preview.Preview import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.globalsettings.UiTheme import com.darkrockstudios.apps.hammer.common.projectselection.accountSettingsComponent import com.darkrockstudios.apps.hammer.common.projectselection.defaultAccountSettingsComponentState import com.darkrockstudios.apps.hammer.common.projectselection.settings.AccountSettingsUi @@ -24,21 +23,6 @@ internal fun ScreenAccountSettingsUiPreview() { } } -@Preview -@Composable -internal fun ScreenAccountSettingsUiOledBlackPreview() { - val component = accountSettingsComponent( - defaultAccountSettingsComponentState.copy(serverSetup = false, uiTheme = UiTheme.OledBlack) - ) - val rootSnackbar = rememberRootSnackbarHostState() - - KoinApplicationPreview { - AppTheme(globalSettingsPreview.copy(uiTheme = UiTheme.OledBlack), useDarkTheme = true) { - AccountSettingsUi(component, rootSnackbar) - } - } -} - @Preview(widthDp = TABLET_WIDTH_DP, heightDp = TABLET_HEIGHT_DP) @Composable internal fun ScreenAccountSettingsUiTabletPreview() { diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AppUpdateBanner.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AppUpdateBanner.Preview.kt deleted file mode 100644 index 6b6c7eb10..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/AppUpdateBanner.Preview.kt +++ /dev/null @@ -1,72 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.preview - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Spacer -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.width -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNoticeStrip -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.projectselection.AppUpdateBanner - -private val bannerStates = listOf( - AppUpdateState.Available(version = "9.9.9", installable = true), - AppUpdateState.Available(version = "9.9.9", installable = false), - AppUpdateState.Downloading(version = "9.9.9", fraction = 0.42f), - AppUpdateState.Installing(version = "9.9.9"), - AppUpdateState.Failed(version = "9.9.9", reason = "HTTP 503"), -) - -@Preview -@Composable -fun AppUpdateBannerStatesPreview() { - AppTheme(globalSettingsPreview, false) { - Column(modifier = Modifier.width(720.dp).background(MaterialTheme.colorScheme.background)) { - for (state in bannerStates) { - AppUpdateBanner(state = state, onUpdate = {}, onOpenRelease = {}, onDismiss = {}) - Spacer(Modifier.height(16.dp)) - } - } - } -} - -@Preview -@Composable -fun AppUpdateBannerStatesDarkPreview() { - AppTheme(globalSettingsPreview, true) { - Column(modifier = Modifier.width(720.dp).background(MaterialTheme.colorScheme.background)) { - for (state in bannerStates) { - AppUpdateBanner(state = state, onUpdate = {}, onOpenRelease = {}, onDismiss = {}) - Spacer(Modifier.height(16.dp)) - } - } - } -} - -@Preview -@Composable -fun HdNoticeStripPreview() { - AppTheme(globalSettingsPreview, false) { - Column(modifier = Modifier.width(720.dp).background(MaterialTheme.colorScheme.background)) { - HdNoticeStrip( - title = "A title with two actions", - detail = "And a detail line underneath it.", - primaryLabel = "Primary", - secondaryLabel = "Secondary", - ) - Spacer(Modifier.height(16.dp)) - HdNoticeStrip( - title = "Progress, no actions", - progress = 0.6f, - ) - Spacer(Modifier.height(16.dp)) - HdNoticeStrip(title = "Title only") - } - } -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/EncyclopediaUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/EncyclopediaUi.Preview.kt index c6db45601..fd8515779 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/EncyclopediaUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/EncyclopediaUi.Preview.kt @@ -174,8 +174,7 @@ private val fakeCreateEntryComponent: CreateEntry = object : CreateEntry { type: EntryType, text: String, tags: Set, - imagePath: String?, - excludeFromDictionary: Boolean, + imagePath: String? ): EntryResult = EntryResult(EntryContainer(fakeEntryContent()), EntryError.NONE) override fun confirmClose() {} @@ -317,7 +316,6 @@ val fakeViewEntryComponent: ViewEntry = object : ViewEntry { override fun startTextEdit() {} override fun finishNameEdit() {} override fun finishTextEdit() {} - override fun discardEdit() {} override fun confirmClose() {} override fun dismissConfirmClose() {} override fun removeTag(tag: String) {} @@ -330,8 +328,6 @@ val fakeViewEntryComponent: ViewEntry = object : ViewEntry { override suspend fun addAlias(alias: String) = EntryResult(EntryContainer(fakeEntryContent()), EntryError.NONE) override fun removeAlias(alias: String) {} - override suspend fun setExcludeFromDictionary(exclude: Boolean) = - EntryResult(EntryContainer(fakeEntryContent()), EntryError.NONE) override fun navigateToAppearance(appearance: ViewEntry.Appearance) {} override fun suggestTags(prefix: String, limit: Int): List = emptyList() } diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/MergeProjectsDialog.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/MergeProjectsDialog.Preview.kt deleted file mode 100644 index 3744d5a98..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/MergeProjectsDialog.Preview.kt +++ /dev/null @@ -1,42 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.preview - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.projectselection.settings.MergeMode -import com.darkrockstudios.apps.hammer.common.projectselection.settings.MergeProjectsDialogContent - -@Preview(widthDp = 560, heightDp = 440) -@Composable -fun MergeProjectsDialogMergePreview() = MergeProjectsDialogPreview(MergeMode.Merge) - -@Preview(widthDp = 560, heightDp = 440) -@Composable -fun MergeProjectsDialogReplacePreview() = MergeProjectsDialogPreview(MergeMode.Replace) - -@Composable -private fun MergeProjectsDialogPreview(mode: MergeMode) { - KoinApplicationPreview { - AppTheme(globalSettingsPreview, true) { - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - contentAlignment = Alignment.Center, - ) { - MergeProjectsDialogContent( - mode = mode, - onModeChange = {}, - onCancel = {}, - onContinue = {}, - ) - } - } - } -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/ProjectSynchronization.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/ProjectSynchronization.Preview.kt index fa9aefe03..9d36a2007 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/ProjectSynchronization.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/ProjectSynchronization.Preview.kt @@ -2,9 +2,11 @@ package com.darkrockstudios.apps.hammer.common.preview import androidx.compose.foundation.background import androidx.compose.foundation.layout.Box -import com.darkrockstudios.apps.hammer.common.compose.WindowSizeClass +import androidx.compose.material3.windowsizeclass.ExperimentalMaterial3WindowSizeClassApi +import androidx.compose.material3.windowsizeclass.WindowSizeClass import androidx.compose.runtime.Composable import androidx.compose.ui.Modifier +import androidx.compose.ui.geometry.Size import androidx.compose.ui.graphics.Color import androidx.compose.ui.tooling.preview.Preview import androidx.compose.ui.unit.Density @@ -31,11 +33,17 @@ import kotlin.time.Clock import kotlin.time.Duration.Companion.days import kotlin.time.Duration.Companion.seconds -private fun expandedSize(): WindowSizeClass = - WindowSizeClass.calculateFromSize(widthPx = 1920, heightPx = 1280, density = Density(1f)) +@OptIn(ExperimentalMaterial3WindowSizeClassApi::class) +private fun expandedSize(): WindowSizeClass = WindowSizeClass.calculateFromSize( + size = Size.Zero.copy(1920f, 1280f), + density = Density(1f) +) -private fun compactSize(): WindowSizeClass = - WindowSizeClass.calculateFromSize(widthPx = 420, heightPx = 900, density = Density(1f)) +@OptIn(ExperimentalMaterial3WindowSizeClassApi::class) +private fun compactSize(): WindowSizeClass = WindowSizeClass.calculateFromSize( + size = Size.Zero.copy(420f, 900f), + density = Density(1f) +) @Preview @Composable diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/SceneListUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/SceneListUi.Preview.kt index b2e2b5833..6fc1d8acf 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/SceneListUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/SceneListUi.Preview.kt @@ -12,7 +12,6 @@ import com.darkrockstudios.apps.hammer.common.Padded import com.darkrockstudios.apps.hammer.common.components.storyeditor.scenelist.SceneList import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.data.MoveRequest import com.darkrockstudios.apps.hammer.common.data.SceneBuffer import com.darkrockstudios.apps.hammer.common.data.SceneItem @@ -58,99 +57,6 @@ fun ScreenSceneListUiTabletPreview() { } } -@Preview(widthDp = 320, heightDp = 780) -@Composable -fun ScreenSceneListUiNestedPreview() = NestedSceneList(useDarkTheme = true) - -@Preview(widthDp = 320, heightDp = 780) -@Composable -fun ScreenSceneListUiNestedLightPreview() = NestedSceneList(useDarkTheme = false) - -@Composable -private fun NestedSceneList(useDarkTheme: Boolean) { - val snackbarHostState = rememberRootSnackbarHostState() - - KoinApplicationPreview { - AppTheme(globalSettingsPreview, useDarkTheme) { - val summary = nestedSceneSummary() - val component = fakeComponent( - SceneList.State( - projectDef = fakeProjectDef(), - sceneSummary = summary, - selectedSceneItem = summary.sceneTree.find { it.value.name == SELECTED_SCENE }?.value, - ) - ) - SceneListUi(component, snackbarHostState) - } - } -} - -private const val SELECTED_SCENE = "Down the hole" -private const val DIRTY_SCENE = "White Rabbit Arrives" - -private fun nestedSceneSummary(): SceneSummary { - var nextId = 1 - fun scene(name: String) = TreeNode(namedScene(nextId++, name, SceneItem.Type.Scene)) - fun group(name: String) = TreeNode(namedScene(nextId++, name, SceneItem.Type.Group)) - - val tree = Tree() - val root = TreeNode(namedScene(0, "Root", SceneItem.Type.Root)) - - root.addChild(scene("Title")) - root.addChild( - group("Chapter I").apply { - addChild(scene("At Home")) - } - ) - root.addChild(scene("A Caucus Race and a Long Tale")) - root.addChild( - group("Chapter IV").apply { - addChild(scene("Mushroom Consumed")) - addChild( - group("Chapter III").apply { - addChild(scene("Down the hole")) - addChild( - group("Chapter II").apply { - addChild(scene("The Pool of Tears")) - addChild(scene("White Rabbit Arrives")) - } - ) - } - ) - addChild(scene("The Rabbit Sends in a Little Bill")) - addChild(scene("Bottom of Chimney")) - } - ) - root.addChild( - group("Chapter VI").apply { - addChild( - group("Chapter V").apply { - addChild(scene("Pig and Pepper")) - } - ) - } - ) - root.addChild(group("Chapter VII")) - - tree.setRoot(root) - - val immutable = tree.toImmutableTree() - val dirtyId = immutable.first { it.value.name == DIRTY_SCENE }.value.id - - return SceneSummary( - immutable, - persistentSetOf(dirtyId), - ) -} - -private fun namedScene(id: Int, name: String, type: SceneItem.Type) = SceneItem( - projectDef = fakeProjectDef(), - type = type, - id = id, - name = name, - order = id, -) - private fun fakeSceneSummary(): SceneSummary { val tree = Tree() val root = TreeNode(fakeScene(0, 0, SceneItem.Type.Root)) @@ -239,7 +145,6 @@ private fun fakeComponent(state: SceneList.State) = object : SceneList { override fun onSceneListUpdate(scenes: SceneSummary) {} override fun onSceneBufferUpdate(sceneBuffer: SceneBuffer) {} override fun showOutlineOverview() {} - override fun showReaderMode() {} override suspend fun archiveScene(scene: SceneItem) {} override suspend fun unarchiveScene(scene: SceneItem) {} override fun showArchivedScenes() {} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/TabletPreview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/TabletPreview.kt index e988a32cf..49b99ce3a 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/TabletPreview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/TabletPreview.kt @@ -4,8 +4,8 @@ import androidx.compose.foundation.background import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.material3.MaterialTheme -import com.darkrockstudios.apps.hammer.common.compose.WindowHeightSizeClass -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowHeightSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.CompositionLocalProvider import androidx.compose.ui.Modifier diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/DesignSystem.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/DesignSystem.Preview.kt index 3420e3265..e812eea44 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/DesignSystem.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/DesignSystem.Preview.kt @@ -4,27 +4,21 @@ import androidx.compose.foundation.background import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.PaddingValues import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.fillMaxHeight -import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.foundation.layout.height import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.width -import androidx.compose.foundation.lazy.LazyColumn import androidx.compose.material.icons.Icons import androidx.compose.material.icons.filled.Add import androidx.compose.material.icons.filled.MoreVert import androidx.compose.material.icons.filled.Refresh import androidx.compose.material.icons.filled.Warning import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.clipToBounds -import androidx.compose.ui.input.nestedscroll.nestedScroll import androidx.compose.ui.tooling.preview.Preview import androidx.compose.ui.unit.dp import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdAttributionItem @@ -34,15 +28,9 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdBottomBar import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdBottomBarDestination import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCategoryChip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCategorySwatch -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterDropdown -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterHeader -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterRailItem -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdChapterRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdCollapseGlyph import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdDailyGoalProgress import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdDeltaBadge -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEmailField -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEndMark import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEngravingPlaceholder import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEntryCard import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdEntryFilterBar @@ -62,14 +50,10 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMiniBarChar import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRail import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRailDestination -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPasswordField import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdPlainSection import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdReferenceChip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdReferenceChipVariant -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdResizeHandle import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdResponsiveStrip -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSceneBreak -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdScrollAwayFooter import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchField import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSectionHeader import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdStatBlock @@ -77,7 +61,6 @@ import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTagChip import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTypeStamp import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdTypographicHero import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdUnsavedBadge -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdScrollAwayFooterState import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.compose.theme.LocalHammerColors import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType @@ -597,45 +580,6 @@ fun BottomBarPreview() { } } -@Preview(widthDp = 360, heightDp = 280) -@Composable -fun ScrollAwayFooterPreview() { - AppTheme(globalSettingsPreview, useDarkTheme = true) { - val footerState = rememberHdScrollAwayFooterState() - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.surface) - .clipToBounds(), - ) { - LazyColumn( - modifier = Modifier - .fillMaxSize() - .nestedScroll(footerState.nestedScrollConnection), - contentPadding = PaddingValues(bottom = footerState.height), - ) { - items(12) { index -> - Text( - text = "Scene ${index + 1}", - style = MaterialTheme.typography.bodyLarge, - color = MaterialTheme.colorScheme.onSurface, - modifier = Modifier.fillMaxWidth().padding(16.dp), - ) - } - } - - HdScrollAwayFooter(state = footerState) { - HdHairlineButton( - label = "Outline Overview", - onClick = {}, - modifier = Modifier.weight(1f), - ) - HdHairlineButton(label = "+", onClick = {}) - } - } - } -} - @Preview @Composable fun FabPreview() { @@ -699,38 +643,6 @@ fun HairlineFieldPreview() { } } -@Preview -@Composable -fun CredentialFieldsPreview() { - AppTheme(globalSettingsPreview, useDarkTheme = true) { - PreviewSurface { - HdEmailField( - label = "EMAIL", - value = "alice@example.com", - onValueChange = {}, - placeholder = "E-Mail: user@example.com", - modifier = Modifier.fillMaxWidth(), - ) - HdPasswordField( - label = "PASSWORD", - value = "correcthorsebattery", - onValueChange = {}, - visible = false, - onVisibleChange = {}, - hint = "8-64 characters", - ) - HdPasswordField( - label = "PASSWORD", - value = "hunter2", - onValueChange = {}, - visible = true, - onVisibleChange = {}, - error = "Password is too short", - ) - } - } -} - @Preview @Composable fun HairlineImageDropPreview() { @@ -1176,28 +1088,6 @@ fun DesignSystemGalleryPreview() { } } -@Preview -@Composable -fun ResizeHandlePreview() { - AppTheme(globalSettingsPreview, useDarkTheme = true) { - PreviewSurface { - Row(modifier = Modifier.height(120.dp)) { - HdResizeHandle( - onOutwardDrag = {}, - onDragEnd = {}, - onReset = {}, - ) - Box( - modifier = Modifier - .width(240.dp) - .fillMaxHeight() - .background(MaterialTheme.colorScheme.surfaceVariant), - ) - } - } - } -} - @Composable private fun GallerySection(title: String, content: @Composable () -> Unit) { Column( @@ -1213,25 +1103,6 @@ private fun GallerySection(title: String, content: @Composable () -> Unit) { } } -@Preview -@Composable -fun ChapterPiecesPreview() { - val rows = listOf( - HdChapterRow(title = "Arrival", sceneCount = 2), - HdChapterRow(title = "The Dark Night", sceneCount = 5), - ) - AppTheme(globalSettingsPreview, useDarkTheme = true) { - PreviewSurface { - HdChapterDropdown(rows = rows, selectedIndex = 1, onSelect = {}) - HdChapterRailItem(index = 0, row = rows[0], selected = true, onClick = {}) - HdChapterRailItem(index = 1, row = rows[1], selected = false, onClick = {}) - HdChapterHeader(index = 1, title = "The Dark Night", sceneCount = 5, wide = false) - HdSceneBreak() - HdEndMark(label = "End of story") - } - } -} - @Composable private fun PreviewSurface(content: @Composable () -> Unit) { Column( diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/HdSearchableListDialog.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/HdSearchableListDialog.Preview.kt deleted file mode 100644 index 4690510ca..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/designsystem/HdSearchableListDialog.Preview.kt +++ /dev/null @@ -1,72 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.preview.designsystem - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.padding -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdSearchableListDialogContent -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview - -private val languages = listOf( - "de-DE" to "German (Germany)", - "en-GB" to "English (United Kingdom)", - "en-US" to "English (United States)", - "fr-FR" to "French (France)", - "pt-BR" to "Portuguese (Brazil)", - "uk-UA" to "Ukrainian (Ukraine)", -) - -@Composable -private fun DialogPreviewSurface(query: String) { - AppTheme(globalSettingsPreview) { - Box( - modifier = Modifier - .background(MaterialTheme.colorScheme.background) - .fillMaxSize() - .padding(24.dp), - contentAlignment = Alignment.Center, - ) { - HdSearchableListDialogContent( - title = "Choose a language", - query = query, - onQueryChange = {}, - items = languages, - itemLabel = { it.second }, - itemTrailing = { it.first.uppercase() }, - itemKey = { it.first }, - onSelect = {}, - onDismissRequest = {}, - closeContentDescription = "Close", - searchPlaceholder = "Search languages", - clearLabel = "Clear (not set)", - onClear = {}, - emptyLabel = "No languages match", - ) - } - } -} - -@Preview(heightDp = 620) -@Composable -fun HdSearchableListDialogPreview() { - DialogPreviewSurface(query = "") -} - -@Preview(heightDp = 420) -@Composable -fun HdSearchableListDialogFilteredPreview() { - DialogPreviewSurface(query = "english") -} - -@Preview(heightDp = 360) -@Composable -fun HdSearchableListDialogEmptyPreview() { - DialogPreviewSurface(query = "klingon") -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ExportOptionsDialog.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ExportOptionsDialog.Preview.kt deleted file mode 100644 index 172348130..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ExportOptionsDialog.Preview.kt +++ /dev/null @@ -1,76 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.preview.projecthome - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportFormat -import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.projecthome.ExportOptionsDialogContent - -private val previewScenes = listOf( - ExportableScene(id = 1, name = "Prologue", isGroup = false, depth = 0), - ExportableScene(id = 2, name = "Chapter 1: The Door", isGroup = true, depth = 0), - ExportableScene(id = 3, name = "The Door Opens", isGroup = false, depth = 1), - ExportableScene(id = 4, name = "The Discovery", isGroup = false, depth = 1), - ExportableScene(id = 5, name = "Interludes", isGroup = true, depth = 1), - ExportableScene(id = 6, name = "A Quiet Moment", isGroup = false, depth = 2), - ExportableScene(id = 7, name = "Epilogue", isGroup = false, depth = 0), -) - -@Composable -private fun ExportOptionsPreviewFrame(options: ExportOptions) { - KoinApplicationPreview { - AppTheme(globalSettingsPreview, true) { - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - contentAlignment = Alignment.Center, - ) { - ExportOptionsDialogContent( - options = options, - exportableScenes = previewScenes, - onOptionsChanged = {}, - onCancel = {}, - onConfirm = {}, - onShowHelp = {}, - ) - } - } - } -} - -@Preview(widthDp = 600, heightDp = 640) -@Composable -fun ExportOptionsDialogPreview() { - ExportOptionsPreviewFrame(ExportOptions()) -} - -@Preview(widthDp = 600, heightDp = 640) -@Composable -fun ExportOptionsDialogWordPreview() { - ExportOptionsPreviewFrame( - ExportOptions( - format = ExportFormat.Docx, - numberChapters = true, - font = ExportFont.TimesNewRoman, - keepBlankLines = false, - ) - ) -} - -@Preview(widthDp = 600, heightDp = 760) -@Composable -fun ExportOptionsDialogLimitScenesPreview() { - ExportOptionsPreviewFrame(ExportOptions(sceneIds = setOf(3, 4, 6))) -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectSettingsUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectSettingsUi.Preview.kt index 367877593..bd1d339ef 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectSettingsUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectSettingsUi.Preview.kt @@ -62,61 +62,30 @@ private val fakeSpellCheckSettings = object : SpellCheckSettings { SpellCheckSettings.State( spellCheckingEnabled = true, spellCheckingInFocusEnabled = false, - spellCheckingLanguage = Locale.forLanguage("en", "US"), - spellCheckLanguages = listOf(Locale.forLanguage("en", "US")), + spellCheckingLanguage = Locale.root, + spellCheckLanguages = listOf(Locale.root), ) ) override suspend fun setSpellcheckEnable(enable: Boolean) {} override suspend fun setSpellCheckingInFocusEnabled(enable: Boolean) {} - override suspend fun setSpellCheckEncyclopediaEnabled(enable: Boolean) {} override suspend fun setSpellCheckLanguage(language: Locale) {} } -private fun fakeComponent(language: String?) = object : ProjectSettings { +private val component = object : ProjectSettings { override val projectName: String = "The Lighthouse" override val spellCheckSettings: SpellCheckSettings = fakeSpellCheckSettings override val projectInfoState: Value = MutableValue( ProjectSettings.ProjectInfoState( - data = ProjectData( - authorName = "A. Writer", - tags = setOf("fantasy", "draft"), - language = language, - ), + data = ProjectData(authorName = "A. Writer", tags = setOf("fantasy", "draft")), isLoaded = true, ) ) - override val availableLanguages: List = listOf( - ProjectSettings.LanguageOption("en-US", "English (United States)"), - ProjectSettings.LanguageOption("fr-FR", "French (France)"), - ProjectSettings.LanguageOption("pt-BR", "Portuguese (Brazil)"), - ) override fun setAuthorName(name: String?) {} override fun setTheme(theme: ProjectTheme?) {} override fun setWordCountGoal(goal: WordCountGoal?) {} override fun setTags(tags: Set) {} - override fun setProjectLanguage(tag: String?) {} - override fun setEncyclopediaDictionaryEnabled(enabled: Boolean) {} - override fun addDictionaryWord(word: String) {} - override fun removeDictionaryWord(word: String) {} override fun suggestProjectTags(prefix: String): List = listOf("fantasy", "sci-fi", "nanowrimo").filter { it.startsWith(prefix, ignoreCase = true) } } - -private val component = fakeComponent(language = "en-US") - -/** Project language (fr-FR) mismatched against the en-US dictionary: the caption shows. Tall enough to reach the spell-check section. */ -@Preview(widthDp = TABLET_WIDTH_DP, heightDp = 2600) -@Composable -fun ScreenProjectSettingsUiLanguageMismatchPreview() { - KoinApplicationPreview { - TabletPreviewSurface { - ProjectSettingsUi( - modifier = Modifier, - component = fakeComponent(language = "fr-FR"), - onClose = {}, - ) - } - } -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectStatsUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectStatsUi.Preview.kt index f5462ebe9..de1a793b5 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectStatsUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projecthome/ProjectStatsUi.Preview.kt @@ -113,10 +113,8 @@ private val component = object : ProjectHome { override suspend fun exportProjectToFile(filePath: String, options: ExportOptions): HPath = fakeProjectDef().path override fun beginProjectExport() {} override fun cancelExportDialog() {} - override fun updateExportOptions(options: ExportOptions) {} override fun confirmExportDialog(options: ExportOptions) {} override fun endProjectExport() {} - override fun exportDialogDismissed() {} override fun startProjectSync() {} override fun showGlobalSearch() {} override fun showGlobalSearchForTag(tag: String) {} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ImportStoryDialog.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ImportStoryDialog.Preview.kt index ab735d3e7..f558f5b7f 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ImportStoryDialog.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ImportStoryDialog.Preview.kt @@ -5,13 +5,11 @@ import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.material3.MaterialTheme import androidx.compose.runtime.Composable -import androidx.compose.runtime.remember import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.tooling.preview.Preview import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.data.ImportOptions -import com.darkrockstudios.apps.hammer.common.data.MarkdownSplitStrategy import com.darkrockstudios.apps.hammer.common.data.importer.ImportPreview import com.darkrockstudios.apps.hammer.common.data.importer.PreviewItem import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview @@ -40,102 +38,6 @@ fun ImportStoryDialogPreview() { projectName = "Alice In Wonderland 2", options = ImportOptions(), preview = preview, - isParsing = false, - onProjectNameChange = {}, - onCancel = {}, - onOptionsChange = {}, - onConfirm = {}, - ) - } - } - } -} - -/** - * Markdown import at phone width with the regex escape hatch selected: the chapter pattern field is - * showing and the four-cell detection picker is at its tightest. - */ -@Preview(widthDp = 400, heightDp = 800) -@Composable -fun ImportStoryDialogMarkdownPatternPreview() { - val preview = ImportPreview( - items = List(6) { i -> PreviewItem.Scene(name = "Chapter ${i + 1}", markdown = "") }, - ) - KoinApplicationPreview { - AppTheme(globalSettingsPreview, true) { - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - contentAlignment = Alignment.Center, - ) { - ImportStoryContent( - projectName = "Alice In Wonderland 2", - options = ImportOptions(markdownSplitStrategy = MarkdownSplitStrategy.Pattern), - preview = preview, - isParsing = false, - onProjectNameChange = {}, - onCancel = {}, - onOptionsChange = {}, - onConfirm = {}, - ) - } - } - } -} - -/** Chapter detection found nothing, so the whole manuscript landed in one scene. */ -@Preview(widthDp = 640, heightDp = 760) -@Composable -fun ImportStoryDialogLargeScenePreview() { - val preview = remember { - ImportPreview( - items = listOf( - PreviewItem.Scene(name = "Chapter One", markdown = "A normal opening chapter."), - PreviewItem.Scene(name = "The Long Walk Home", markdown = "word ".repeat(54_300)), - ), - ) - } - KoinApplicationPreview { - AppTheme(globalSettingsPreview, true) { - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - contentAlignment = Alignment.Center, - ) { - ImportStoryContent( - projectName = "The Long Walk Home", - options = ImportOptions(), - preview = preview, - isParsing = false, - onProjectNameChange = {}, - onCancel = {}, - onOptionsChange = {}, - onConfirm = {}, - ) - } - } - } -} - -/** The window between the file picker closing and the parse landing. */ -@Preview(widthDp = 640, heightDp = 560) -@Composable -fun ImportStoryDialogParsingPreview() { - KoinApplicationPreview { - AppTheme(globalSettingsPreview, true) { - Box( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - contentAlignment = Alignment.Center, - ) { - ImportStoryContent( - projectName = "Alice In Wonderland 2", - options = ImportOptions(), - preview = ImportPreview(items = emptyList()), - isParsing = true, onProjectNameChange = {}, onCancel = {}, onOptionsChange = {}, diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ProjectListUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ProjectListUi.Preview.kt index 3673fb5d1..6f0b48477 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ProjectListUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/projectselection/ProjectListUi.Preview.kt @@ -29,15 +29,6 @@ import kotlinx.coroutines.flow.MutableSharedFlow import org.jetbrains.compose.resources.StringResource import com.darkrockstudios.apps.hammer.base.http.projectdata.ProjectData as StoredData -@Preview -@Composable -fun ScreenProjectListUiPreview() { - val rootSnackbar = rememberRootSnackbarHostState() - KoinApplicationPreview { - ProjectListUi(previewComponent, rootSnackbar) - } -} - @Preview(widthDp = TABLET_WIDTH_DP, heightDp = TABLET_HEIGHT_DP) @Composable fun ScreenProjectListUiTabletPreview() { @@ -49,31 +40,22 @@ fun ScreenProjectListUiTabletPreview() { } } -fun previewProject(name: String, tags: Set = setOf("fantasy", "draft")) = ProjectData( +private fun previewProject(name: String) = ProjectData( definition = ProjectDef(name = name, path = HPath(name = name, path = "/$name", isAbsolute = true)), metadata = fakeProjectMetadata(), - storedData = StoredData(authorName = "A. Writer", tags = tags), + storedData = StoredData(authorName = "A. Writer", tags = setOf("fantasy", "draft")), ) -private val previewComponent = fakeProjectsList( - listOf( - previewProject("The Lighthouse"), - previewProject("Wonderland"), - previewProject("Salt & Ash"), - ), - isServerSynced = true, -) - -/** Shared by the previews above and the composeUi footer tests. */ -fun fakeProjectsList( - projects: List, - isServerSynced: Boolean = false, -) = object : ProjectsList { +private val previewComponent = object : ProjectsList { override val state: Value = MutableValue( ProjectsList.State( - projects = projects, + projects = listOf( + previewProject("The Lighthouse"), + previewProject("Wonderland"), + previewProject("Salt & Ash"), + ), projectsPath = fakeProjectDef().path, - isServerSynced = isServerSynced, + isServerSynced = true, ) ) override val modalRouterState: Value> = diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/FocusModeUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/FocusModeUi.Preview.kt index d308a1619..902e10fe9 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/FocusModeUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/FocusModeUi.Preview.kt @@ -8,37 +8,28 @@ import com.darkrockstudios.apps.hammer.common.data.PlatformRichText import com.darkrockstudios.apps.hammer.common.data.SceneBuffer import com.darkrockstudios.apps.hammer.common.data.SceneContent import com.darkrockstudios.apps.hammer.common.data.UpdateSource -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview import com.darkrockstudios.apps.hammer.common.preview.TABLET_HEIGHT_DP import com.darkrockstudios.apps.hammer.common.preview.TABLET_WIDTH_DP import com.darkrockstudios.apps.hammer.common.preview.TabletPreviewSurface import com.darkrockstudios.apps.hammer.common.preview.fakeProjectDef import com.darkrockstudios.apps.hammer.common.preview.fakeSceneItem import com.darkrockstudios.apps.hammer.common.storyeditor.focusmode.FocusModeUi -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker @Preview @Composable fun ScreenFocusModeUiPreview() { - KoinApplicationPreview { - FocusModeUi(fakeFocusMode()) - } + FocusModeUi(focusMode) } @Preview(widthDp = TABLET_WIDTH_DP, heightDp = TABLET_HEIGHT_DP) @Composable fun ScreenFocusModeUiTabletPreview() { - KoinApplicationPreview { - TabletPreviewSurface { - FocusModeUi(fakeFocusMode()) - } + TabletPreviewSurface { + FocusModeUi(focusMode) } } -internal fun fakeFocusMode( - markdown: String = "This is some demo text for the focus mode preview.", - spellChecker: PlatformSpellChecker? = null, -) = object : FocusMode { +private val focusMode = object : FocusMode { override val state = MutableValue( FocusMode.State( projectDef = fakeProjectDef(), @@ -46,24 +37,21 @@ internal fun fakeFocusMode( sceneBuffer = SceneBuffer( content = SceneContent( scene = fakeSceneItem(), - markdown = markdown + markdown = "This is some demo text for the focus mode preview." ), source = UpdateSource.Editor ), isLoading = false, textSize = 24f, - spellChecker = spellChecker, - spellCheckingEnabled = spellChecker != null + spellChecker = null, + spellCheckingEnabled = false ) ) override var lastForceUpdate = MutableValue(1L) override fun dismiss() {} - override fun addWordToDictionary(word: String) {} override fun onContentChanged(content: PlatformRichText) {} override fun decreaseTextSize() {} override fun increaseTextSize() {} override fun resetTextSize() {} - override fun setEditorMaxWidth(width: Float) {} - override fun resetEditorMaxWidth() {} } \ No newline at end of file diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneEditorUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneEditorUi.Preview.kt index 5036ed62d..7fb69ae2b 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneEditorUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneEditorUi.Preview.kt @@ -8,7 +8,6 @@ import com.darkrockstudios.apps.hammer.common.components.ToastMessage import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.SceneEditor import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.scenemetadata.SceneMetadataPanel import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.data.SceneItem import com.darkrockstudios.apps.hammer.common.data.Msg import com.darkrockstudios.apps.hammer.common.data.PlatformRichText import com.darkrockstudios.apps.hammer.common.data.ProjectDef @@ -16,7 +15,6 @@ import com.darkrockstudios.apps.hammer.common.data.SceneBuffer import com.darkrockstudios.apps.hammer.common.data.SceneContent import com.darkrockstudios.apps.hammer.common.data.UpdateSource import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.fileio.HPath import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview import com.darkrockstudios.apps.hammer.common.preview.TABLET_HEIGHT_DP @@ -24,7 +22,6 @@ import com.darkrockstudios.apps.hammer.common.preview.TABLET_WIDTH_DP import com.darkrockstudios.apps.hammer.common.preview.TabletPreviewSurface import com.darkrockstudios.apps.hammer.common.preview.fakeSceneItem import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.SceneEditorUi -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.flow.MutableSharedFlow import org.jetbrains.compose.resources.StringResource @@ -33,7 +30,7 @@ import org.jetbrains.compose.resources.StringResource @Composable fun ScreenSceneEditorUiPreview() { KoinApplicationPreview { - val component = fakeSceneEditor() + val component = fakeComponent() val rootSnackbar = rememberRootSnackbarHostState() SceneEditorUi(component, rootSnackbar) } @@ -43,7 +40,7 @@ fun ScreenSceneEditorUiPreview() { @Composable fun ScreenSceneEditorUiTabletPreview() { KoinApplicationPreview { - val component = fakeSceneEditor() + val component = fakeComponent() val rootSnackbar = rememberRootSnackbarHostState() TabletPreviewSurface { SceneEditorUi(component, rootSnackbar) @@ -60,10 +57,7 @@ private fun fakeProjectDef(): ProjectDef = ProjectDef( ) ) -internal fun fakeSceneEditor( - markdown: String = "The keeper steps off the ferry into a town that already knows his name.", - spellChecker: PlatformSpellChecker? = null, -) = object : SceneEditor { +private fun fakeComponent() = object : SceneEditor { override val state: Value get() = MutableValue( SceneEditor.State( @@ -71,20 +65,18 @@ internal fun fakeSceneEditor( sceneBuffer = SceneBuffer( content = SceneContent( scene = fakeSceneItem(), - markdown = markdown + markdown = "The keeper steps off the ferry into a town that already knows his name." ), source = UpdateSource.Editor ), isLoading = false, isSavingDraft = false, - isEditingName = false, - spellChecker = spellChecker, + isEditingName = false ) ) override var lastForceUpdate = MutableValue(0L) override val sceneMetadataComponent = object : SceneMetadataPanel { override val state = MutableValue(SceneMetadataPanel.State(fakeSceneItem())) - override fun onSceneItemChanged(sceneItem: SceneItem) {} override fun updateOutline(text: String) {} override fun updateNotes(text: String) {} override fun updateDraftName(text: String) {} @@ -92,8 +84,7 @@ internal fun fakeSceneEditor( override fun dismissReference(entryId: Int) {} override fun restoreDismissedReference(entryId: Int) {} override fun addConfirmedReference(entryId: Int) {} - override fun searchEntriesForAdd(query: String, types: Set, maxResults: Int) = - emptyList() + override fun searchEntriesForAdd(query: String, maxResults: Int) = emptyList() override fun navigateToEntry(entryDef: EntryDef) {} override fun addTags(input: String) {} override fun removeTag(tag: String) {} @@ -104,7 +95,6 @@ internal fun fakeSceneEditor( override fun addEditorMenu() {} override fun removeEditorMenu() {} override fun loadSceneContent() {} - override fun addWordToDictionary(word: String) {} override suspend fun storeSceneContent() = true override fun onContentChanged(content: PlatformRichText) {} override fun beginSceneNameEdit() {} @@ -137,8 +127,5 @@ internal fun fakeSceneEditor( override fun decreaseTextSize() {} override fun increaseTextSize() {} override fun resetTextSize() {} - override fun setEditorMaxWidth(width: Float) {} - override fun resetEditorMaxWidth() {} override fun enterFocusMode() {} - override fun readScene() {} } \ No newline at end of file diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneMetadataPanelUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneMetadataPanelUi.Preview.kt index ea6e42aae..5671160cb 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneMetadataPanelUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/sceneeditor/SceneMetadataPanelUi.Preview.kt @@ -4,98 +4,41 @@ import androidx.compose.runtime.Composable import androidx.compose.ui.tooling.preview.Preview import com.arkivanov.decompose.value.MutableValue import com.darkrockstudios.apps.hammer.common.components.storyeditor.sceneeditor.scenemetadata.SceneMetadataPanel -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef -import com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryType import com.darkrockstudios.apps.hammer.common.data.sceneeditorrepository.scenemetadata.SceneMetadata -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.preview.fakeProjectDef import com.darkrockstudios.apps.hammer.common.preview.fakeSceneItem -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.SceneMetadataPanelUi -private fun previewEntryDef(id: Int, name: String, type: EntryType) = EntryDef( - projectDef = fakeProjectDef(), - id = id, - name = name, - type = type, -) - -private val previewConfirmedRefs = listOf( - previewEntryDef(1, "Alandra Vey", EntryType.PERSON), - previewEntryDef(2, "Bastion Roke", EntryType.PERSON), - previewEntryDef(3, "The Sunken Quarter", EntryType.PLACE), - previewEntryDef(4, "Cinderhall", EntryType.PLACE), - previewEntryDef(5, "The Ashen Key", EntryType.THING), - previewEntryDef(6, "The Long Silence", EntryType.EVENT), - previewEntryDef(7, "Debt As Inheritance", EntryType.IDEA), -).sortedBy { it.name.lowercase() } - -private val previewDismissedRefs = listOf( - previewEntryDef(8, "Marek", EntryType.PERSON), - previewEntryDef(9, "Tidewatch Lantern", EntryType.THING), -) - -private fun previewComponent( - confirmedRefs: List, - dismissedRefs: List, -) = object : SceneMetadataPanel { - override val state = MutableValue( - SceneMetadataPanel.State( - sceneItem = fakeSceneItem(), - wordCount = 1337, - metadata = SceneMetadata( - outline = "Alandra bargains for passage through the Sunken Quarter.", - notes = "", - tags = setOf("act-one", "pov/alandra"), - ), - confirmedRefs = confirmedRefs, - dismissedRefs = dismissedRefs, - ) - ) - - override fun onSceneItemChanged(sceneItem: SceneItem) {} - - override fun updateOutline(text: String) {} - override fun updateNotes(text: String) {} - override fun updateDraftName(text: String) {} - override fun validateDraftName(text: String) = true - override fun dismissReference(entryId: Int) {} - override fun restoreDismissedReference(entryId: Int) {} - override fun addConfirmedReference(entryId: Int) {} - override fun searchEntriesForAdd(query: String, types: Set, maxResults: Int) = - emptyList() - - override fun navigateToEntry(entryDef: EntryDef) {} - override fun addTags(input: String) {} - override fun removeTag(tag: String) {} - override fun showGlobalSearchForTag(tag: String) {} - override fun suggestTags(prefix: String, limit: Int) = emptyList() -} - @Preview @Composable fun SceneMetadataPanelUiPreview() { - KoinApplicationPreview { - AppTheme(globalSettingsPreview) { - SceneMetadataPanelUi( - component = previewComponent(previewConfirmedRefs, previewDismissedRefs), - closeMetadata = {}, + SceneMetadataPanelUi( + component = object : SceneMetadataPanel { + override val state = MutableValue( + SceneMetadataPanel.State( + sceneItem = fakeSceneItem(), + wordCount = 1337, + metadata = SceneMetadata( + outline = "", + notes = "" + ) + ) ) - } - } -} -@Preview -@Composable -fun SceneMetadataPanelUiEmptyPreview() { - KoinApplicationPreview { - AppTheme(globalSettingsPreview) { - SceneMetadataPanelUi( - component = previewComponent(emptyList(), emptyList()), - closeMetadata = {}, - ) - } - } -} + override fun updateOutline(text: String) {} + override fun updateNotes(text: String) {} + override fun updateDraftName(text: String) {} + override fun validateDraftName(text: String) = true + override fun dismissReference(entryId: Int) {} + override fun restoreDismissedReference(entryId: Int) {} + override fun addConfirmedReference(entryId: Int) {} + override fun searchEntriesForAdd(query: String, maxResults: Int) = + emptyList() + override fun navigateToEntry(entryDef: com.darkrockstudios.apps.hammer.common.data.encyclopediarepository.entry.EntryDef) {} + override fun addTags(input: String) {} + override fun removeTag(tag: String) {} + override fun showGlobalSearchForTag(tag: String) {} + override fun suggestTags(prefix: String, limit: Int) = emptyList() + }, + closeMetadata = {} + ) +} \ No newline at end of file diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyeditor/ReaderModeUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyeditor/ReaderModeUi.Preview.kt deleted file mode 100644 index c805dfe7f..000000000 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyeditor/ReaderModeUi.Preview.kt +++ /dev/null @@ -1,115 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.preview.storyeditor - -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.material3.MaterialTheme -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.tooling.preview.Preview -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.preview.TABLET_HEIGHT_DP -import com.darkrockstudios.apps.hammer.common.preview.TABLET_WIDTH_DP -import com.darkrockstudios.apps.hammer.common.preview.TabletPreviewSurface -import com.darkrockstudios.apps.hammer.common.preview.fakeProjectDef -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.ReaderModeUi - -@Preview -@Composable -fun ScreenReaderModeUiPreview() { - KoinApplicationPreview { - AppTheme(globalSettingsPreview) { - Box(modifier = Modifier.fillMaxSize().background(MaterialTheme.colorScheme.background)) { - ReaderModeUi(fakeReader(readerState())) - } - } - } -} - -@Preview(widthDp = TABLET_WIDTH_DP, heightDp = TABLET_HEIGHT_DP) -@Composable -fun ScreenReaderModeUiTabletPreview() { - KoinApplicationPreview { - TabletPreviewSurface { - ReaderModeUi(fakeReader(readerState().copy(showSceneHeadings = true, fontSize = 20f))) - } - } -} - -@Preview -@Composable -fun ScreenReaderModeUiEmptyChapterPreview() { - KoinApplicationPreview { - AppTheme(globalSettingsPreview) { - Box(modifier = Modifier.fillMaxSize().background(MaterialTheme.colorScheme.background)) { - ReaderModeUi( - fakeReader(readerState().copy(activeChapterId = darkNight.id, scenes = emptyList())) - ) - } - } - } -} - -private fun item(id: Int, name: String, type: SceneItem.Type) = SceneItem( - projectDef = fakeProjectDef(), - type = type, - id = id, - name = name, - order = id, -) - -private val arrival = item(1, "Arrival", SceneItem.Type.Group) -private val harbour = item(2, "The Harbour", SceneItem.Type.Scene) -private val lampRoom = item(3, "The Lamp Room", SceneItem.Type.Scene) -private val darkNight = item(4, "The Dark Night", SceneItem.Type.Group) - -private val harbourText = """ -The keeper stepped off the ferry into a town that already knew his name. The gulls knew it too, or seemed to, wheeling over the quay and crying it back at him in pieces. - -"You'll be wanting the light," said the woman at the chandlery, not looking up. She had the **key** on the counter before he had finished his breath. - -He took it. It was heavier than a key had any right to be, and *cold*, as if it had been kept somewhere out of the sun for a long time. -""".trimIndent() - -private val lampRoomText = """ -One hundred and nine steps. He counted them the first night and never again, because the number did not change and the counting made the stair feel longer. - -The lamp room smelled of oil and old brass. Somebody had left a chair facing the sea, and a cup beside it, and in the cup a dry brown ring where the tea had been. -""".trimIndent() - -private fun readerState() = ReaderMode.State( - chapters = listOf( - ReaderMode.ReaderChapter(arrival, sceneCount = 2), - ReaderMode.ReaderChapter(darkNight, sceneCount = 0), - ), - activeChapterId = arrival.id, - scenes = listOf( - ReaderMode.ReaderScene(harbour, harbourText), - ReaderMode.ReaderScene(lampRoom, lampRoomText), - ), - isLoading = false, -) - -private fun fakeReader(state: ReaderMode.State) = object : ReaderMode { - override val state: Value = MutableValue(state) - override fun showChapter(chapterId: Int) {} - override fun nextChapter() {} - override fun previousChapter() {} - override fun showScene(sceneItem: SceneItem) {} - override fun scrollHandled() {} - override fun sceneInView(sceneItem: SceneItem?) {} - override fun editScene(sceneItem: SceneItem?) {} - override fun toggleSceneHeadings() {} - override fun increaseFontSize() {} - override fun decreaseFontSize() {} - override fun resetFontSize() {} - override fun setEditorMaxWidth(width: Float) {} - override fun resetEditorMaxWidth() {} - override fun close() {} -} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyideas/StoryIdeasUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyideas/StoryIdeasUi.Preview.kt index 81064e06d..b9d8a02c9 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyideas/StoryIdeasUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/preview/storyideas/StoryIdeasUi.Preview.kt @@ -9,6 +9,7 @@ import com.darkrockstudios.apps.hammer.common.components.projectselection.storyi import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState import com.darkrockstudios.apps.hammer.common.data.CResult import com.darkrockstudios.apps.hammer.common.data.ProjectDef +import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeaError import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview import com.darkrockstudios.apps.hammer.common.preview.TABLET_HEIGHT_DP @@ -94,20 +95,6 @@ private val previewIdeas = listOf( ), ) -private fun previewDraft(editor: StoryIdeas.Editor?): StoryIdeas.Draft? = when (editor) { - null -> null - StoryIdeas.Editor.Create -> StoryIdeas.Draft(isEditing = true) - is StoryIdeas.Editor.Edit -> StoryIdeas.Draft( - isEditing = false, - title = editor.idea.title.orEmpty(), - content = editor.idea.content, - tags = editor.idea.tags.toList(), - savedTitle = editor.idea.title, - savedContent = editor.idea.content, - savedTags = editor.idea.tags, - ) -} - private fun fakeComponent( editor: StoryIdeas.Editor? = null, ): StoryIdeas = object : StoryIdeas { @@ -115,7 +102,6 @@ private fun fakeComponent( StoryIdeas.State( ideas = previewIdeas, editor = editor, - draft = previewDraft(editor), ) ) @@ -123,13 +109,8 @@ private fun fakeComponent( override fun editIdea(id: IdeaId) {} override fun closeEditor() {} override fun suggestTags(prefix: String): List = emptyList() - override fun beginEdit() {} - override fun discardEdit() {} - override fun updateTitle(title: String) {} - override fun updateContent(content: String) {} - override fun updateTags(tags: List) {} - override fun updateTagDraft(tagDraft: String) {} - override suspend fun saveDraft(): StoryIdeas.SaveResult = StoryIdeas.SaveResult.Saved + override suspend fun createIdea(title: String?, content: String, tags: Set) = IdeaError.NONE + override suspend fun saveIdea(id: IdeaId, title: String?, content: String, tags: Set) = IdeaError.NONE override suspend fun deleteIdea(id: IdeaId) {} override suspend fun archiveIdea(id: IdeaId) {} override suspend fun unarchiveIdea(id: IdeaId) {} diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt index b25c6c1a2..c966b2488 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt @@ -2,17 +2,17 @@ package com.darkrockstudios.apps.hammer.common.projecthome import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect +import androidx.compose.runtime.getValue +import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.projecthome.ProjectHome import com.darkrockstudios.apps.hammer.common.components.projecthome.fileExtension import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher -import com.darkrockstudios.apps.hammer.project_home_action_export_toast_failure +import com.darkrockstudios.apps.hammer.common.compose.retryingFileDialog import com.darkrockstudios.apps.hammer.project_home_action_export_toast_success -import io.github.aakira.napier.Napier import io.github.vinceglb.filekit.FileKit import io.github.vinceglb.filekit.absolutePath import io.github.vinceglb.filekit.dialogs.openFileSaver -import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.launch @@ -23,29 +23,22 @@ actual fun ExportDirectoryPicker( scope: CoroutineScope, ) { val defaultDispatcher = rememberDefaultDispatcher() + val state by component.state.subscribeAsState() + val format = state.exportOptions.format LaunchedEffect(show) { if (show) { - // Snapshot before the save dialog: it does not block this window, so the - // options must not be re-read after the suspend. - val options = component.state.value.exportOptions - val format = options.format val suggested = component.getExportStoryFileName(format) val extension = format.fileExtension val baseName = suggested.removeSuffix(".$extension") - val file = FileKit.openFileSaver(suggestedName = baseName, defaultExtension = extension) + val file = retryingFileDialog { + FileKit.openFileSaver(suggestedName = baseName, extension = extension) + } if (file != null) { + val options = state.exportOptions scope.launch(defaultDispatcher) { - // A renderer failure must surface as a toast; an uncaught throw here takes down the app. - try { - component.exportProjectToFile(file.absolutePath(), options) - component.showToast(Res.string.project_home_action_export_toast_success) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - Napier.e("Story export failed", e) - component.showToast(Res.string.project_home_action_export_toast_failure) - } + component.exportProjectToFile(file.absolutePath(), options) + component.showToast(Res.string.project_home_action_export_toast_success) } } else { component.endProjectExport() diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AccountSettingsUtils.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AccountSettingsUtils.kt index 180783347..3d05d3553 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AccountSettingsUtils.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/AccountSettingsUtils.kt @@ -47,7 +47,6 @@ internal fun accountSettingsComponent(state: AccountSettings.State = defaultAcco ) override fun setProjectsDir(path: String) {} - override fun setAutomaticUpdateChecks(value: Boolean) {} } override val backupManagerSlot: Value> = MutableValue(ChildSlot(child = null)) @@ -62,19 +61,15 @@ internal fun accountSettingsComponent(state: AccountSettings.State = defaultAcco email: String, password: String, create: Boolean, - replaceLocalContent: Boolean + removeLocalContent: Boolean ) { } - override fun chooseMerge() {} - override fun chooseReplace() {} - override fun cancelMergePrompt() {} - override fun acceptTos() {} override fun declineTos() {} override suspend fun authTest() = true - override suspend fun removeServer() {} + override fun removeServer() {} override suspend fun setAutomaticBackups(value: Boolean) {} override suspend fun setAutoCloseDialogs(value: Boolean) {} override suspend fun setAutoSyncing(value: Boolean) {} @@ -88,13 +83,12 @@ internal fun accountSettingsComponent(state: AccountSettings.State = defaultAcco override val state: Value get() = MutableValue( SpellCheckSettings.State( - true, true, true, Locale.root, emptyList() + true, true, Locale.root, emptyList() ) ) override suspend fun setSpellcheckEnable(enable: Boolean) {} override suspend fun setSpellCheckingInFocusEnabled(enable: Boolean) {} - override suspend fun setSpellCheckEncyclopediaEnabled(enable: Boolean) {} override suspend fun setSpellCheckLanguage(language: Locale) {} } diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportFilePicker.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportFilePicker.kt index b293bb599..b024fcf76 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportFilePicker.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/ImportFilePicker.kt @@ -3,6 +3,7 @@ package com.darkrockstudios.apps.hammer.common.projectselection import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher +import com.darkrockstudios.apps.hammer.common.compose.retryingFileDialog import io.github.aakira.napier.Napier import io.github.vinceglb.filekit.FileKit import io.github.vinceglb.filekit.dialogs.FileKitType @@ -24,8 +25,9 @@ actual fun ImportFilePicker( LaunchedEffect(show) { if (show) { - val file = + val file = retryingFileDialog { FileKit.openFilePicker(type = FileKitType.File(extensions = listOf("md", "markdown", "rtf"))) + } if (file != null) { scope.launch { val content = withContext(defaultDispatcher) { diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.Preview.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.Preview.kt index 88492199c..3ad87e7c9 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.Preview.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/AboutAppUi.Preview.kt @@ -1,17 +1,10 @@ package com.darkrockstudios.apps.hammer.common.projectselection.about -import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.padding -import androidx.compose.material3.MaterialTheme import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier import androidx.compose.ui.tooling.preview.Preview -import androidx.compose.ui.unit.dp import com.arkivanov.decompose.value.MutableValue import com.darkrockstudios.apps.hammer.common.components.projectselection.aboutapp.AboutApp import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview import com.darkrockstudios.apps.hammer.common.preview.TABLET_HEIGHT_DP import com.darkrockstudios.apps.hammer.common.preview.TABLET_WIDTH_DP @@ -22,7 +15,7 @@ import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview @Composable fun ScreenAboutAppUiPreview() { AppTheme(globalSettingsPreview) { - AboutAppUi(previewComponent(), onShowStudio = {}) + AboutAppUi(previewComponent) } } @@ -31,63 +24,22 @@ fun ScreenAboutAppUiPreview() { fun ScreenAboutAppUiTabletPreview() { KoinApplicationPreview { TabletPreviewSurface { - AboutAppUi(previewComponent(), onShowStudio = {}) + AboutAppUi(previewComponent) } } } -@Preview -@Composable -fun ScreenAboutAppUiUpdateAvailablePreview() { - AppTheme(globalSettingsPreview) { - AboutAppUi( - previewComponent(AppUpdateState.Available(version = "9.9.9", installable = true)), - onShowStudio = {}, - ) - } -} - -@Preview -@Composable -fun AppUpdateStatusStatesPreview() { - val states = listOf( - AppUpdateState.Idle, - AppUpdateState.Checking, - AppUpdateState.UpToDate, - AppUpdateState.Available(version = "9.9.9", installable = true), - AppUpdateState.Available(version = "9.9.9", installable = false), - AppUpdateState.Downloading(version = "9.9.9", fraction = 0.42f), - AppUpdateState.Installing(version = "9.9.9"), - AppUpdateState.Failed(version = "9.9.9", reason = "HTTP 503"), - ) - AppTheme(globalSettingsPreview) { - Column( - modifier = Modifier - .background(MaterialTheme.colorScheme.surface) - .padding(24.dp), - ) { - for (state in states) { - AppUpdateStatus( - state = state, - onCheckForUpdate = {}, - onUpdateApp = {}, - modifier = Modifier.padding(bottom = 24.dp), - ) - } - } - } -} - -private fun previewComponent(appUpdate: AppUpdateState = AppUpdateState.Unsupported) = object : AboutApp { +private val previewComponent = object : AboutApp { override val state = MutableValue( - AboutApp.State(currentVersion = "v1.0.0", appUpdate = appUpdate) + AboutApp.State( + latestVersion = "v9.9.9", + currentVersion = "v1.0.0", + newVersionAvailable = true + ) ) override fun openDiscord() {} override fun openReddit() {} override fun openGithub() {} - override fun viewChangelog() {} - override fun openLatestRelease() {} - override fun checkForUpdate() {} - override fun updateApp() {} -} + override fun viewReleaseDetails() {} +} \ No newline at end of file diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.desktop.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.desktop.kt index 543f1965b..7f51c00e9 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.desktop.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.desktop.kt @@ -2,62 +2,25 @@ package com.darkrockstudios.apps.hammer.common.projectselection.about import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.rememberCoroutineScope -import androidx.compose.runtime.setValue import androidx.compose.ui.unit.dp -import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.about_logs_directory_label -import com.darkrockstudios.apps.hammer.about_logs_export_button -import com.darkrockstudios.apps.hammer.about_logs_export_failed -import com.darkrockstudios.apps.hammer.about_logs_export_success import com.darkrockstudios.apps.hammer.about_logs_header -import com.darkrockstudios.apps.hammer.about_logs_no_logs import com.darkrockstudios.apps.hammer.about_logs_open_tooltip import com.darkrockstudios.apps.hammer.common.components.projectselection.aboutapp.AboutApp import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineSection import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMetadataItem import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.getPlatformFilesystem -import com.darkrockstudios.apps.hammer.common.platformIoDispatcher -import com.darkrockstudios.apps.hammer.common.shellPath -import com.darkrockstudios.apps.hammer.common.util.zip.zipDirectory +import com.darkrockstudios.apps.hammer.common.getLogDirectory import io.github.aakira.napier.Napier -import io.github.vinceglb.filekit.FileKit -import io.github.vinceglb.filekit.absolutePath -import io.github.vinceglb.filekit.dialogs.openFileSaver -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext -import okio.Path.Companion.toPath import java.awt.Desktop import java.io.File -private const val LOGS_ZIP_BASE_NAME = "hammer-logs" - -@OptIn(ExperimentalLayoutApi::class) @Composable actual fun PlatformAboutSection(component: AboutApp, section: Int) { - val scope = rememberCoroutineScope() - val state by component.state.subscribeAsState() - val logDir = state.logDirectoryPath - // What the user would paste into a file manager, which under a container is not what the app writes to. - val displayedLogDir = shellPath(logDir) - var exporting by remember { mutableStateOf(false) } - var status by remember { mutableStateOf(null) } - - val noLogsMessage = Res.string.about_logs_no_logs.get() - val failedMessage = Res.string.about_logs_export_failed.get() - val successMessage = Res.string.about_logs_export_success.get() + val logDir = getLogDirectory() ?: return HdHairlineSection( section = section, @@ -66,95 +29,25 @@ actual fun PlatformAboutSection(component: AboutApp, section: Int) { Column(verticalArrangement = Arrangement.spacedBy(14.dp)) { HdMetadataItem( label = Res.string.about_logs_directory_label.get(), - value = displayedLogDir, + value = logDir, selectable = true, ) - FlowRow( - horizontalArrangement = Arrangement.spacedBy(12.dp), - verticalArrangement = Arrangement.spacedBy(12.dp), - ) { - HdHairlineButton( - label = Res.string.about_logs_open_tooltip.get(), - onClick = { openLogDirectory(displayedLogDir) }, - ) - HdHairlineButton( - label = Res.string.about_logs_export_button.get(), - enabled = !exporting, - onClick = { - exporting = true - status = null - scope.launch { - status = when (exportLogs(logDir)) { - ExportResult.EXPORTED -> successMessage - ExportResult.NO_LOGS -> noLogsMessage - ExportResult.FAILED -> failedMessage - ExportResult.CANCELLED -> null - } - exporting = false - } - }, - ) - CopyDiagnosticsButton( - logDirectoryPath = logDir, - onStatus = { status = it }, - ) - } - status?.let { - Text(text = it, style = MaterialTheme.typography.bodySmall) - } + HdHairlineButton( + label = Res.string.about_logs_open_tooltip.get(), + onClick = { openLogDirectory(logDir) }, + ) } } } actual val platformAboutSectionCount: Int = 1 -private enum class ExportResult { EXPORTED, NO_LOGS, FAILED, CANCELLED } - -private suspend fun exportLogs(logDirPath: String): ExportResult { - val fileSystem = getPlatformFilesystem() - val logsDir = logDirPath.toPath() - - val hasLogs = withContext(platformIoDispatcher) { - try { - fileSystem.exists(logsDir) && fileSystem.list(logsDir).any { it.name.endsWith(".txt") } - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to list log files", e) - false - } - } - if (!hasLogs) return ExportResult.NO_LOGS - - val destination = FileKit.openFileSaver( - suggestedName = LOGS_ZIP_BASE_NAME, - defaultExtension = "zip", - ) ?: return ExportResult.CANCELLED - - return withContext(platformIoDispatcher) { - val zipPath = destination.absolutePath().toPath() - try { - if (fileSystem.exists(zipPath)) fileSystem.delete(zipPath) - zipDirectory(fileSystem, logsDir, zipPath) - ExportResult.EXPORTED - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - Napier.e("Failed to export logs", e) - ExportResult.FAILED - } - } -} - -/** - * Hands the shell the nearest existing ancestor rather than a dead path. [shellPath] already - * un-redirects the known container layouts; this covers the rest, including a log directory that - * has not been written to yet. - */ private fun openLogDirectory(logDir: String) { try { - if (!Desktop.isDesktopSupported()) return - val target = generateSequence(File(logDir)) { it.parentFile } - .firstOrNull { it.isDirectory } ?: return - Desktop.getDesktop().open(target) + val dir = File(logDir) + if (dir.exists() && Desktop.isDesktopSupported()) { + Desktop.getDesktop().open(dir) + } } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { // Desktop.open can throw varied IO/security errors Napier.e("Failed to open log directory", e) } diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/PlatformSettingsUi.desktop.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/PlatformSettingsUi.desktop.kt index a2a3d8647..c2ea72e5e 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/PlatformSettingsUi.desktop.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/settings/PlatformSettingsUi.desktop.kt @@ -6,12 +6,7 @@ import androidx.compose.foundation.layout.ColumnScope import androidx.compose.foundation.layout.fillMaxWidth import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.rememberCoroutineScope -import androidx.compose.runtime.setValue +import androidx.compose.runtime.* import androidx.compose.ui.Modifier import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState @@ -19,11 +14,9 @@ import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.DesktopPlatformSettings import com.darkrockstudios.apps.hammer.common.components.projectselection.accountsettings.PlatformSettings import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineButton -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineToggleRow import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.settings_automatic_update_checks -import com.darkrockstudios.apps.hammer.settings_automatic_update_checks_hint +import com.darkrockstudios.apps.hammer.common.compose.retryingFileDialog import com.darkrockstudios.apps.hammer.settings_projects_directory import com.darkrockstudios.apps.hammer.settings_projects_directory_button import com.darkrockstudios.apps.hammer.settings_projects_directory_description @@ -62,7 +55,7 @@ actual fun ColumnScope.PlatformSettingsUi(component: PlatformSettings) { label = Res.string.settings_projects_directory_button.get(), onClick = { scope.launch { - val directory = FileKit.openDirectoryPicker() + val directory = retryingFileDialog { FileKit.openDirectoryPicker() } if (directory != null) { projectsPathText = directory.absolutePath() component.setProjectsDir(projectsPathText) @@ -70,13 +63,5 @@ actual fun ColumnScope.PlatformSettingsUi(component: PlatformSettings) { } }, ) - if (state.updateChecksSupported) { - HdHairlineToggleRow( - checked = state.automaticUpdateChecks, - onCheckedChange = component::setAutomaticUpdateChecks, - label = Res.string.settings_automatic_update_checks.get(), - hint = Res.string.settings_automatic_update_checks_hint.get(), - ) - } } } diff --git a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt index 750bb2025..61ec48cbb 100644 --- a/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt +++ b/composeUi/src/desktopMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt @@ -4,7 +4,6 @@ import androidx.compose.foundation.layout.* import androidx.compose.foundation.layout.Arrangement.Start import androidx.compose.foundation.text.ClickableText import androidx.compose.material.icons.Icons -import androidx.compose.material.icons.automirrored.filled.MenuBook import androidx.compose.material.icons.filled.* import androidx.compose.material3.* import androidx.compose.runtime.* @@ -116,14 +115,6 @@ actual fun EditorTopBar( ) } - IconButton(onClick = component::readScene) { - Icon( - imageVector = Icons.AutoMirrored.Filled.MenuBook, - contentDescription = Res.string.scene_editor_menu_item_read.get(), - tint = MaterialTheme.colorScheme.onBackground - ) - } - IconButton(onClick = component::enterFocusMode) { Icon( imageVector = Icons.Default.Fullscreen, diff --git a/composeUi/src/desktopTest/kotlin/AddToDictionaryMenuTest.kt b/composeUi/src/desktopTest/kotlin/AddToDictionaryMenuTest.kt deleted file mode 100644 index 29d3fb81c..000000000 --- a/composeUi/src/desktopTest/kotlin/AddToDictionaryMenuTest.kt +++ /dev/null @@ -1,39 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.utils.addToDictionaryMenuItems -import com.darkrockstudios.texteditor.CharLineOffset -import com.darkrockstudios.texteditor.TextEditorRange -import com.darkrockstudios.texteditor.spellcheck.SpellCheckItem -import com.darkrockstudios.texteditor.spellcheck.api.Correction -import com.darkrockstudios.texteditor.state.WordSegment -import org.junit.Assert.assertEquals -import org.junit.Test - -class AddToDictionaryMenuTest { - - private val range = TextEditorRange(CharLineOffset(0, 0), CharLineOffset(0, 5)) - private fun word(text: String) = SpellCheckItem.MisspelledWord(WordSegment(text, range)) - - @Test - fun `a misspelled word gets one item that adds the normalized word`() { - var added: String? = null - val items = addToDictionaryMenuItems("Add") { added = it }(word(" Kvothe ")) - - assertEquals(listOf("Add"), items.map { it.label }) - items.single().onClick() - assertEquals("Kvothe", added) - } - - @Test - fun `a word the dictionary cannot store gets no item`() { - val items = addToDictionaryMenuItems("Add") {}(word("a".repeat(65))) - - assertEquals(emptyList(), items.map { it.label }) - } - - @Test - fun `a sentence issue gets no item`() { - val issue = SpellCheckItem.SentenceIssue(Correction(range, "in the", emptyList())) - val items = addToDictionaryMenuItems("Add") {}(issue) - - assertEquals(emptyList(), items.map { it.label }) - } -} diff --git a/composeUi/src/desktopTest/kotlin/AppUpdateBannerTest.kt b/composeUi/src/desktopTest/kotlin/AppUpdateBannerTest.kt deleted file mode 100644 index a494a8e81..000000000 --- a/composeUi/src/desktopTest/kotlin/AppUpdateBannerTest.kt +++ /dev/null @@ -1,83 +0,0 @@ -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.projectselection.AppUpdateBanner -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -class AppUpdateBannerTest { - @get:Rule - val compose = createComposeRule() - - private var updates = 0 - private var releasePages = 0 - private var dismissals = 0 - - private fun show(state: AppUpdateState) { - compose.setContent { - AppTheme(globalSettingsPreview) { - AppUpdateBanner( - state = state, - onUpdate = { updates++ }, - onOpenRelease = { releasePages++ }, - onDismiss = { dismissals++ }, - ) - } - } - } - - @Test - fun `nothing is drawn until a release is available`() { - show(AppUpdateState.Idle) - compose.onNodeWithText("Later").assertDoesNotExist() - - show(AppUpdateState.UpToDate) - compose.onNodeWithText("Later").assertDoesNotExist() - } - - @Test - fun `an installable release offers update and later`() { - show(AppUpdateState.Available(version = "9.9.9", installable = true)) - - compose.onNodeWithText("Hammer 9.9.9 is available.").assertIsDisplayed() - compose.onNodeWithText("Update to 9.9.9").performClick() - compose.onNodeWithText("Later").performClick() - - assertEquals(1, updates) - assertEquals(1, dismissals) - } - - @Test - fun `a release this install cannot apply links to the release page`() { - show(AppUpdateState.Available(version = "9.9.9", installable = false)) - - compose.onNodeWithText("Update to 9.9.9").assertDoesNotExist() - compose.onNodeWithText("Open Release").performClick() - - assertEquals(1, releasePages) - assertEquals(0, updates) - } - - @Test - fun `a dismissed release hides the banner`() { - show(AppUpdateState.Available(version = "9.9.9", installable = true, dismissed = true)) - - compose.onNodeWithText("Hammer 9.9.9 is available.").assertDoesNotExist() - } - - @Test - fun `progress and failure are shown`() { - show(AppUpdateState.Downloading(version = "9.9.9", fraction = 0.42f)) - compose.onNodeWithText("Downloading Hammer 9.9.9 (42%)").assertIsDisplayed() - - show(AppUpdateState.Failed(version = "9.9.9", reason = "HTTP 503")) - compose.onNodeWithText("Could not update to 9.9.9: HTTP 503").assertIsDisplayed() - compose.onNodeWithText("Retry").performClick() - assertEquals(1, updates) - } -} diff --git a/composeUi/src/desktopTest/kotlin/AppUpdateStatusTest.kt b/composeUi/src/desktopTest/kotlin/AppUpdateStatusTest.kt deleted file mode 100644 index 0f53fc822..000000000 --- a/composeUi/src/desktopTest/kotlin/AppUpdateStatusTest.kt +++ /dev/null @@ -1,81 +0,0 @@ -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.assertIsNotEnabled -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.projectselection.about.AppUpdateStatus -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -class AppUpdateStatusTest { - @get:Rule - val compose = createComposeRule() - - private var checks = 0 - private var updates = 0 - - private fun show(state: AppUpdateState) { - compose.setContent { - AppTheme(globalSettingsPreview) { - AppUpdateStatus( - state = state, - onCheckForUpdate = { checks++ }, - onUpdateApp = { updates++ }, - ) - } - } - } - - @Test - fun `a build that cannot update shows nothing`() { - show(AppUpdateState.Unsupported) - compose.onNodeWithText("Check for Updates").assertDoesNotExist() - } - - @Test - fun `check for updates is offered before and after a check`() { - show(AppUpdateState.Idle) - compose.onNodeWithText("Check for Updates").performClick() - assertEquals(1, checks) - - show(AppUpdateState.UpToDate) - compose.onNodeWithText("Hammer is up to date.").assertIsDisplayed() - compose.onNodeWithText("Check for Updates").assertIsDisplayed() - } - - @Test - fun `the button is disabled while checking`() { - show(AppUpdateState.Checking) - compose.onNodeWithText("Check for Updates").assertIsNotEnabled() - } - - @Test - fun `an installable release offers the update`() { - show(AppUpdateState.Available(version = "9.9.9", installable = true)) - - compose.onNodeWithText("Hammer 9.9.9 is available.").assertIsDisplayed() - compose.onNodeWithText("Update to 9.9.9").performClick() - assertEquals(1, updates) - } - - @Test - fun `a release this install cannot apply is only announced`() { - show(AppUpdateState.Available(version = "9.9.9", installable = false)) - - compose.onNodeWithText("Hammer 9.9.9 is available.").assertIsDisplayed() - compose.onNodeWithText("Update to 9.9.9").assertDoesNotExist() - } - - @Test - fun `a failure offers a retry`() { - show(AppUpdateState.Failed(version = "9.9.9", reason = "HTTP 503")) - - compose.onNodeWithText("Could not update to 9.9.9: HTTP 503").assertIsDisplayed() - compose.onNodeWithText("Retry").performClick() - assertEquals(1, updates) - } -} diff --git a/composeUi/src/desktopTest/kotlin/ChangelogDialogTest.kt b/composeUi/src/desktopTest/kotlin/ChangelogDialogTest.kt deleted file mode 100644 index d5f62097f..000000000 --- a/composeUi/src/desktopTest/kotlin/ChangelogDialogTest.kt +++ /dev/null @@ -1,103 +0,0 @@ -import androidx.compose.runtime.Composable -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import com.arkivanov.decompose.router.stack.ChildStack -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.essenty.backhandler.BackHandler -import com.darkrockstudios.apps.hammer.common.components.projectselection.ProjectSelection -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.projectselection.ChangelogDialog -import io.mockk.mockk -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -class ChangelogDialogTest { - @get:Rule - val compose = createComposeRule() - - private class FakeProjectSelection( - state: ProjectSelection.ChangelogState, - ) : ProjectSelection { - var dismissCount = 0 - var openReleaseCount = 0 - - override val changelog: Value = MutableValue(state) - override val appUpdate: Value = MutableValue(AppUpdateState.Unsupported) - - override fun dismissChangelog() { - dismissCount++ - } - - override fun updateApp() = Unit - override fun dismissUpdate() = Unit - - override fun openLatestRelease() { - openReleaseCount++ - } - - override fun showChangelog() = Unit - - override val stack: Value> = - mockk() - override val navRailState: Value = - MutableValue(ProjectSelection.NavRailState(expanded = false)) - override val backHandler: BackHandler = mockk(relaxed = true) - override fun isAtRoot() = false - override fun onBack() = Unit - override fun showLocation(location: ProjectSelection.Locations) = Unit - override fun toggleNavRailExpanded() = Unit - } - - private fun content(component: ProjectSelection): @Composable () -> Unit = { - AppTheme(globalSettingsPreview) { - ChangelogDialog(component) - } - } - - @Test - fun `Dialog shows the baked version date and notes`() { - val component = FakeProjectSelection( - ProjectSelection.ChangelogState( - visible = true, - version = "3.7.2", - date = "2026-7-27", - notes = "[Improve]\n- Web: Redesign home page", - ) - ) - compose.setContent(content(component)) - - compose.onNodeWithText("3.7.2").assertIsDisplayed() - compose.onNodeWithText("2026-7-27").assertIsDisplayed() - compose.onNodeWithText("[Improve]\n- Web: Redesign home page").assertIsDisplayed() - } - - @Test - fun `Closing the dialog dismisses it`() { - val component = FakeProjectSelection( - ProjectSelection.ChangelogState(visible = true, version = "3.7.2", notes = "- A thing") - ) - compose.setContent(content(component)) - - compose.onNodeWithText("× CLOSE").performClick() - - assertEquals(1, component.dismissCount) - } - - @Test - fun `Release button opens the releases page`() { - val component = FakeProjectSelection( - ProjectSelection.ChangelogState(visible = true, version = "3.7.2", notes = "- A thing") - ) - compose.setContent(content(component)) - - compose.onNodeWithText("Open Release").performClick() - - assertEquals(1, component.openReleaseCount) - } -} diff --git a/composeUi/src/desktopTest/kotlin/CycleHeaderTest.kt b/composeUi/src/desktopTest/kotlin/CycleHeaderTest.kt deleted file mode 100644 index 5b4d09ab6..000000000 --- a/composeUi/src/desktopTest/kotlin/CycleHeaderTest.kt +++ /dev/null @@ -1,53 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.cycleHeader -import com.darkrockstudios.texteditor.CharLineOffset -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.state.TextEditorState -import com.darkrockstudios.texteditor.state.headerLevel -import io.mockk.mockk -import kotlinx.coroutines.test.TestScope -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class CycleHeaderTest { - - private fun TestScope.newEditor(): MarkdownExtension = - TextEditorState(scope = this, measurer = mockk(relaxed = true)).withMarkdown(HammerMarkdownConfiguration) - - @Test - fun `cycling exports as a markdown heading`() = runTest { - val editor = newEditor() - editor.importMarkdown("Title\n\nBody") - - cycleHeader(editor.editorState, currentLevel = 0) - - assertEquals(1, editor.editorState.headerLevel(0)) - assertEquals("# Title", editor.exportAsMarkdown().lineSequence().first()) - } - - @Test - fun `cycling past the last level removes the heading`() = runTest { - val editor = newEditor() - editor.importMarkdown("### Title") - - cycleHeader(editor.editorState, currentLevel = 3) - - assertNull(editor.editorState.headerLevel(0)) - assertEquals("Title", editor.exportAsMarkdown().lineSequence().first()) - } - - @Test - fun `cycling past the last level clears a mixed selection`() = runTest { - val editor = newEditor() - editor.importMarkdown("### Title\nBody") - editor.editorState.selector.updateSelection(CharLineOffset(0, 0), CharLineOffset(1, 4)) - - cycleHeader(editor.editorState, currentLevel = 3) - - assertNull(editor.editorState.headerLevel(0)) - assertNull(editor.editorState.headerLevel(1)) - } -} diff --git a/composeUi/src/desktopTest/kotlin/EditorTextSizeTest.kt b/composeUi/src/desktopTest/kotlin/EditorTextSizeTest.kt deleted file mode 100644 index 19f341f7d..000000000 --- a/composeUi/src/desktopTest/kotlin/EditorTextSizeTest.kt +++ /dev/null @@ -1,86 +0,0 @@ -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.setValue -import androidx.compose.ui.test.ExperimentalTestApi -import androidx.compose.ui.test.runComposeUiTest -import androidx.compose.ui.text.TextStyle -import androidx.compose.ui.unit.sp -import com.darkrockstudios.apps.hammer.common.compose.HammerRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.withParagraphIndent -import com.darkrockstudios.texteditor.TextEditor -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.rememberTextEditorStyle -import com.darkrockstudios.texteditor.state.TextEditorState -import com.darkrockstudios.texteditor.state.rememberTextEditorState -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -private const val DOC = - "# Title\n\n**bold** and *it* and [l](http://x.y) and `code`\n\n## Two\n\n> quote\n\n- a\n- b\n\n#### Four\n\nplain" - -@OptIn(ExperimentalTestApi::class) -class EditorTextSizeTest { - - @Test - fun `markdown round trips through the relative styles`() = runTest { - val state = TextEditorState(scope = this, measurer = mockk(relaxed = true)) - state.richTextStyles = HammerRichTextStyles - val markdown = state.withMarkdown(HammerMarkdownConfiguration) - - markdown.importMarkdown(DOC) - - assertEquals(DOC, markdown.exportAsMarkdown()) - } - - @Test - fun `the body size scales every line without touching the document`() { - var bodySize by mutableStateOf(16f) - var state: TextEditorState? = null - runComposeUiTest { - setContent { - val editorState = rememberTextEditorState() - state = editorState - TextEditor( - state = editorState, - style = rememberTextEditorStyle( - textStyle = TextStyle(fontSize = bodySize.sp).withParagraphIndent(), - ), - ) - } - waitForIdle() - val editorState = state!! - editorState.richTextStyles = HammerRichTextStyles - editorState.withMarkdown(HammerMarkdownConfiguration).importMarkdown(DOC) - waitForIdle() - - fun lineHeights() = editorState.lineOffsets - .filter { it.virtualLineIndex == 0 } - .associate { it.line to it.textLayoutResult.size.height } - fun indentOf(line: Int) = editorState.lineOffsets - .first { it.line == line && it.virtualLineIndex == 0 } - .textLayoutResult.getHorizontalPosition(0, usePrimaryDirection = true) - - val small = lineHeights() - val smallIndent = indentOf(small.keys.max()) - val linesBefore = editorState.textLines.toList() - bodySize = 32f - waitForIdle() - val large = lineHeights() - val largeIndent = indentOf(small.keys.max()) - - assertEquals(linesBefore, editorState.textLines.toList()) - assertEquals(24f, smallIndent) - assertEquals(48f, largeIndent) - val lastLine = small.keys.max() - assertTrue(small.getValue(0) > small.getValue(lastLine) * 1.6f) - small.keys.forEach { line -> - val ratio = large.getValue(line).toFloat() / small.getValue(line) - assertTrue(ratio in 1.8f..2.2f) - } - } - } -} diff --git a/composeUi/src/desktopTest/kotlin/ExportOptionsDialogRotationTest.kt b/composeUi/src/desktopTest/kotlin/ExportOptionsDialogRotationTest.kt deleted file mode 100644 index c527bed08..000000000 --- a/composeUi/src/desktopTest/kotlin/ExportOptionsDialogRotationTest.kt +++ /dev/null @@ -1,70 +0,0 @@ -import androidx.compose.runtime.getValue -import androidx.compose.runtime.key -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.test.assertIsOn -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performClick -import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.projecthome.ExportOptionsDialog -import com.darkrockstudios.apps.hammer.common.projecthome.exportSceneRowTag -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -/** - * Rotation cover in the spirit of #885: the dialog holds no option state of its own, so a - * configuration change (modeled by bumping the `key` while the option holder lives outside it, - * like a retained Decompose component) must not lose the in-dialog scene selection. - * `StateRestorationTester` would be the closer fit but is an unimplemented stub on desktop. - */ -class ExportOptionsDialogRotationTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - private val entries = listOf( - ExportableScene(id = 1, name = "Scene 1", isGroup = false, depth = 0), - ExportableScene(id = 2, name = "Group 2", isGroup = true, depth = 0), - ExportableScene(id = 3, name = "Scene 3", isGroup = false, depth = 1), - ) - - @Test - fun `An in-dialog scene selection survives the composition being recreated`() { - // Stands in for ProjectHome.State.exportOptions in the retained component. - var options by mutableStateOf(ExportOptions(sceneIds = emptySet())) - val epoch = mutableStateOf(0) - var buildCount = 0 - - compose.setContent { - // Koin stays outside the key: its teardown would otherwise race the rebuilt subtree. - KoinApplicationPreview { - key(epoch.value) { - remember { buildCount++ } - ExportOptionsDialog( - visible = true, - options = options, - exportableScenes = entries, - onOptionsChanged = { options = it }, - onCancel = {}, - onConfirm = {}, - ) - } - } - } - - compose.onNodeWithTag(exportSceneRowTag(3)).performClick() - compose.waitForIdle() - assertEquals(setOf(3), options.sceneIds) - - epoch.value++ - compose.waitForIdle() - - assertEquals(2, buildCount, "The subtree should have been thrown away and built again") - compose.onNodeWithTag(exportSceneRowTag(3)).assertIsOn() - } -} diff --git a/composeUi/src/desktopTest/kotlin/ExportOptionsDialogTest.kt b/composeUi/src/desktopTest/kotlin/ExportOptionsDialogTest.kt deleted file mode 100644 index ca6d3a42c..000000000 --- a/composeUi/src/desktopTest/kotlin/ExportOptionsDialogTest.kt +++ /dev/null @@ -1,167 +0,0 @@ -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.setValue -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import com.darkrockstudios.apps.hammer.common.data.ExportFont -import com.darkrockstudios.apps.hammer.common.data.ExportFormat -import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.common.data.ExportableScene -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.projecthome.ExportOptionsDialogContent -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -class ExportOptionsDialogTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - private val entries = listOf( - ExportableScene(id = 1, name = "Scene 1", isGroup = false, depth = 0), - ExportableScene(id = 2, name = "Scene 2", isGroup = false, depth = 0), - ) - - @Test - fun `Confirming with every scene selected exports without a limit`() { - var options by mutableStateOf(ExportOptions(sceneIds = setOf(1, 2))) - var confirmed: ExportOptions? = null - - compose.setContent { - KoinApplicationPreview { - ExportOptionsDialogContent( - options = options, - exportableScenes = entries, - onOptionsChanged = { options = it }, - onCancel = {}, - onConfirm = { confirmed = it }, - onShowHelp = {}, - ) - } - } - - compose.onNodeWithText("Export").performClick() - compose.waitForIdle() - - assertNull( - confirmed?.sceneIds, - "A full selection must export the entire story, keeping empty chapter groups", - ) - } - - @Test - fun `Confirming a partial selection keeps the scene limit`() { - var options by mutableStateOf(ExportOptions(sceneIds = setOf(2))) - var confirmed: ExportOptions? = null - - compose.setContent { - KoinApplicationPreview { - ExportOptionsDialogContent( - options = options, - exportableScenes = entries, - onOptionsChanged = { options = it }, - onCancel = {}, - onConfirm = { confirmed = it }, - onShowHelp = {}, - ) - } - } - - compose.onNodeWithText("Export").performClick() - compose.waitForIdle() - - assertEquals(setOf(2), confirmed?.sceneIds) - } - - @Test - fun `A project without leaf scenes offers no scene limit`() { - compose.setContent { - KoinApplicationPreview { - ExportOptionsDialogContent( - options = ExportOptions(), - exportableScenes = listOf( - ExportableScene(id = 9, name = "Empty Group", isGroup = true, depth = 0), - ), - onOptionsChanged = {}, - onCancel = {}, - onConfirm = {}, - onShowHelp = {}, - ) - } - } - - compose.onNodeWithText("Limit to specific scenes").assertDoesNotExist() - } - - private fun setContent(initial: ExportOptions, onChanged: (ExportOptions) -> Unit = {}) { - var options by mutableStateOf(initial) - compose.setContent { - KoinApplicationPreview { - ExportOptionsDialogContent( - options = options, - exportableScenes = entries, - onOptionsChanged = { - options = it - onChanged(it) - }, - onCancel = {}, - onConfirm = {}, - onShowHelp = {}, - ) - } - } - } - - @Test - fun `Formatting toggles update the options`() { - var latest = ExportOptions(format = ExportFormat.Docx) - setContent(latest) { latest = it } - - compose.onNodeWithText("Number chapter titles").performClick() - compose.onNodeWithText("Keep blank lines between paragraphs").performClick() - compose.waitForIdle() - - assertEquals(true, latest.numberChapters) - assertEquals(false, latest.keepBlankLines) - } - - @Test - fun `Word export offers a font choice`() { - var latest = ExportOptions(format = ExportFormat.Docx) - setContent(latest) { latest = it } - - compose.onNodeWithText("Georgia").performClick() - compose.onNodeWithText("Times New Roman").performClick() - compose.waitForIdle() - - assertEquals(ExportFont.TimesNewRoman, latest.font) - } - - @Test - fun `PDF export offers no font choice`() { - setContent(ExportOptions(format = ExportFormat.Pdf)) - - compose.onNodeWithText("Georgia").assertDoesNotExist() - compose.onNodeWithText("Number chapter titles").assertExists() - } - - @Test - fun `EPUB export offers chapter numbering and a font`() { - setContent(ExportOptions(format = ExportFormat.Epub)) - - compose.onNodeWithText("Number chapter titles").assertExists() - compose.onNodeWithText("Georgia").assertExists() - } - - @Test - fun `Markdown export offers only numbering`() { - setContent(ExportOptions(format = ExportFormat.Markdown)) - - compose.onNodeWithText("Number chapter titles").assertExists() - compose.onNodeWithText("Georgia").assertDoesNotExist() - compose.onNodeWithText("Keep blank lines between paragraphs").assertDoesNotExist() - } -} diff --git a/composeUi/src/desktopTest/kotlin/ExportSceneSelectionTest.kt b/composeUi/src/desktopTest/kotlin/ExportSceneSelectionTest.kt deleted file mode 100644 index 02f1093e6..000000000 --- a/composeUi/src/desktopTest/kotlin/ExportSceneSelectionTest.kt +++ /dev/null @@ -1,91 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.data.ExportableScene -import com.darkrockstudios.apps.hammer.common.projecthome.allSceneIds -import com.darkrockstudios.apps.hammer.common.projecthome.descendantSceneIds -import com.darkrockstudios.apps.hammer.common.projecthome.isFullSelection -import com.darkrockstudios.apps.hammer.common.projecthome.isGroupFullySelected -import com.darkrockstudios.apps.hammer.common.projecthome.toggleGroup -import com.darkrockstudios.apps.hammer.common.projecthome.toggleScene -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class ExportSceneSelectionTest { - - // Scene 1, Group 2 [Scene 3, Scene 4, Group 5 [Scene 6]], Scene 7, Group 8 (empty) - private val entries = listOf( - ExportableScene(id = 1, name = "Scene 1", isGroup = false, depth = 0), - ExportableScene(id = 2, name = "Group 2", isGroup = true, depth = 0), - ExportableScene(id = 3, name = "Scene 3", isGroup = false, depth = 1), - ExportableScene(id = 4, name = "Scene 4", isGroup = false, depth = 1), - ExportableScene(id = 5, name = "Group 5", isGroup = true, depth = 1), - ExportableScene(id = 6, name = "Scene 6", isGroup = false, depth = 2), - ExportableScene(id = 7, name = "Scene 7", isGroup = false, depth = 0), - ExportableScene(id = 8, name = "Group 8", isGroup = true, depth = 0), - ) - - private val topGroup = entries[1] - private val nestedGroup = entries[4] - private val emptyGroup = entries[7] - - @Test - fun `allSceneIds contains only leaf scenes`() { - assertEquals(setOf(1, 3, 4, 6, 7), allSceneIds(entries)) - } - - @Test - fun `descendantSceneIds spans the whole subtree including nested groups`() { - assertEquals(listOf(3, 4, 6), descendantSceneIds(entries, topGroup)) - assertEquals(listOf(6), descendantSceneIds(entries, nestedGroup)) - assertEquals(emptyList(), descendantSceneIds(entries, emptyGroup)) - } - - @Test - fun `descendantSceneIds stops at the next sibling of the same depth`() { - assertFalse(7 in descendantSceneIds(entries, topGroup)) - } - - @Test - fun `isFullSelection requires every leaf scene and a non-empty tree`() { - assertTrue(isFullSelection(entries, setOf(1, 3, 4, 6, 7))) - assertTrue(isFullSelection(entries, setOf(1, 3, 4, 6, 7, 999))) - assertFalse(isFullSelection(entries, setOf(1, 3, 4, 6))) - assertFalse(isFullSelection(emptyList(), emptySet())) - } - - @Test - fun `toggleScene adds and removes a single id`() { - val selected = toggleScene(emptySet(), 3) - assertEquals(setOf(3), selected) - assertEquals(emptySet(), toggleScene(selected, 3)) - } - - @Test - fun `toggleGroup selects every descendant scene`() { - assertEquals(setOf(3, 4, 6), toggleGroup(entries, emptySet(), topGroup)) - } - - @Test - fun `toggleGroup on a fully selected group clears its descendants only`() { - val selected = setOf(1, 3, 4, 6, 7) - assertEquals(setOf(1, 7), toggleGroup(entries, selected, topGroup)) - } - - @Test - fun `toggleGroup on a partially selected group completes the selection`() { - assertEquals(setOf(3, 4, 6), toggleGroup(entries, setOf(3), topGroup)) - } - - @Test - fun `toggleGroup on an empty group changes nothing`() { - val selected = setOf(1) - assertEquals(selected, toggleGroup(entries, selected, emptyGroup)) - } - - @Test - fun `isGroupFullySelected requires every descendant and is never true for empty groups`() { - assertTrue(isGroupFullySelected(entries, setOf(3, 4, 6), topGroup)) - assertFalse(isGroupFullySelected(entries, setOf(3, 4), topGroup)) - assertFalse(isGroupFullySelected(entries, setOf(1, 3, 4, 6, 7), emptyGroup)) - } -} diff --git a/composeUi/src/desktopTest/kotlin/FormatBarQuoteTest.kt b/composeUi/src/desktopTest/kotlin/FormatBarQuoteTest.kt deleted file mode 100644 index 067769166..000000000 --- a/composeUi/src/desktopTest/kotlin/FormatBarQuoteTest.kt +++ /dev/null @@ -1,29 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.toggleBlockquote -import com.darkrockstudios.texteditor.CharLineOffset -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.state.TextEditorState -import com.darkrockstudios.texteditor.state.isBlockquote -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class FormatBarQuoteTest { - - @Test - fun `a line quoted from the format bar stays quoted after saving`() = runTest { - val editor = TextEditorState(scope = this, measurer = mockk(relaxed = true)).withMarkdown(HammerMarkdownConfiguration) - editor.importMarkdown("A line to quote.") - editor.editorState.cursor.updatePosition(CharLineOffset(0, 2)) - toggleBlockquote(editor.editorState) - - val saved = editor.exportAsMarkdown() - assertEquals("> A line to quote.", saved) - - val reopened = TextEditorState(scope = this, measurer = mockk(relaxed = true)).withMarkdown(HammerMarkdownConfiguration) - reopened.importMarkdown(saved) - assertTrue(reopened.editorState.isBlockquote(0)) - } -} diff --git a/composeUi/src/desktopTest/kotlin/HdHairlineTagFieldTest.kt b/composeUi/src/desktopTest/kotlin/HdHairlineTagFieldTest.kt deleted file mode 100644 index e8b6708b3..000000000 --- a/composeUi/src/desktopTest/kotlin/HdHairlineTagFieldTest.kt +++ /dev/null @@ -1,77 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.test.assertIsFocused -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import androidx.compose.ui.test.performTextInput -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineTagField -import org.junit.Assert.assertEquals -import org.junit.Rule -import org.junit.Test - -private const val FIELD_TAG = "tag-field" - -class HdHairlineTagFieldTest { - - @get:Rule - val compose = createComposeRule() - - private lateinit var tags: List - - private fun showField(suggestions: List) { - compose.setContent { - var current by remember { mutableStateOf(emptyList()) } - tags = current - Box(modifier = Modifier.size(600.dp, 300.dp)) { - HdHairlineTagField( - label = "TAGS", - tags = current, - onTagsChange = { current = it }, - suggestTags = { prefix -> suggestions.filter { it.startsWith(prefix) } }, - testTag = FIELD_TAG, - ) - } - } - } - - @Test - fun `picking a suggestion adds the suggested tag, not the typed prefix`() { - showField(listOf("shorts", "shortstory")) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("short") - compose.onNodeWithText("shortstory").performClick() - compose.waitForIdle() - - assertEquals(listOf("shortstory"), tags) - } - - @Test - fun `picking a suggestion leaves focus in the field`() { - showField(listOf("shortstory")) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("short") - compose.onNodeWithText("shortstory").performClick() - compose.waitForIdle() - - compose.onNodeWithTag(FIELD_TAG).assertIsFocused() - } - - @Test - fun `picking a suggestion keeps tags typed before it`() { - showField(listOf("shortstory")) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("novel short") - compose.onNodeWithText("shortstory").performClick() - compose.waitForIdle() - - assertEquals(listOf("novel", "shortstory"), tags) - } -} diff --git a/composeUi/src/desktopTest/kotlin/HdHairlineWordListFieldTest.kt b/composeUi/src/desktopTest/kotlin/HdHairlineWordListFieldTest.kt deleted file mode 100644 index fa52580ac..000000000 --- a/composeUi/src/desktopTest/kotlin/HdHairlineWordListFieldTest.kt +++ /dev/null @@ -1,137 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.input.key.Key -import androidx.compose.ui.test.ExperimentalTestApi -import androidx.compose.ui.test.assertTextEquals -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performClick -import androidx.compose.ui.test.performKeyInput -import androidx.compose.ui.test.performTextInput -import androidx.compose.ui.test.pressKey -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdHairlineWordListField -import com.darkrockstudios.apps.hammer.common.spellcheck.normalizeDictionaryWord -import org.junit.Assert.assertEquals -import org.junit.Rule -import org.junit.Test - -private const val FIELD_TAG = "word-list-field" - -@OptIn(ExperimentalTestApi::class) -class HdHairlineWordListFieldTest { - - @get:Rule - val compose = createComposeRule() - - private lateinit var words: List - - private fun showField(initial: List = emptyList()) { - compose.setContent { - var current by remember { mutableStateOf(initial) } - words = current - Box(modifier = Modifier.size(600.dp, 300.dp)) { - HdHairlineWordListField( - label = "PROJECT DICTIONARY", - words = current, - onAdd = { current = current + it }, - onRemove = { current = current - it }, - parseInput = ::normalizeDictionaryWord, - testTag = FIELD_TAG, - ) - } - } - } - - @Test - fun `space commits the typed word`() { - showField() - - compose.onNodeWithTag(FIELD_TAG).performTextInput("Kvothe ") - compose.waitForIdle() - - assertEquals(listOf("Kvothe"), words) - } - - @Test - fun `enter commits the typed word`() { - showField() - - compose.onNodeWithTag(FIELD_TAG).performTextInput("Denna") - compose.onNodeWithTag(FIELD_TAG).performKeyInput { pressKey(Key.Enter) } - compose.waitForIdle() - - assertEquals(listOf("Denna"), words) - } - - @Test - fun `a word already in the list is not added twice`() { - showField(listOf("Kvothe")) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("Kvothe ") - compose.waitForIdle() - - assertEquals(listOf("Kvothe"), words) - } - - @Test - fun `input the parser rejects is not committed`() { - showField() - - compose.onNodeWithTag(FIELD_TAG).performTextInput("a".repeat(65) + " ") - compose.waitForIdle() - - assertEquals(emptyList(), words) - } - - @Test - fun `a pasted list commits the complete words and keeps the partial one as draft`() { - showField() - - compose.onNodeWithTag(FIELD_TAG).performTextInput("Kvothe Denna") - compose.waitForIdle() - assertEquals(listOf("Kvothe"), words) - - compose.onNodeWithTag(FIELD_TAG).performKeyInput { pressKey(Key.Enter) } - compose.waitForIdle() - assertEquals(listOf("Kvothe", "Denna"), words) - } - - @Test - fun `a word already present in another case is not added`() { - showField(listOf("Kvothe")) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("kvothe ") - compose.waitForIdle() - - assertEquals(listOf("Kvothe"), words) - } - - @Test - fun `a rejected word stays in the draft after a separator`() { - showField() - val tooLong = "a".repeat(65) - - compose.onNodeWithTag(FIELD_TAG).performTextInput("$tooLong ") - compose.waitForIdle() - - assertEquals(emptyList(), words) - compose.onNodeWithTag(FIELD_TAG).assertTextEquals(tooLong) - } - - @Test - fun `backspace on an empty draft removes the last word`() { - showField(listOf("Kvothe", "Denna")) - - compose.onNodeWithTag(FIELD_TAG).performClick() - compose.onNodeWithTag(FIELD_TAG).performKeyInput { pressKey(Key.Backspace) } - compose.waitForIdle() - - assertEquals(listOf("Kvothe"), words) - } -} diff --git a/composeUi/src/desktopTest/kotlin/HdScrollAwayFooterTest.kt b/composeUi/src/desktopTest/kotlin/HdScrollAwayFooterTest.kt deleted file mode 100644 index 6977b06a5..000000000 --- a/composeUi/src/desktopTest/kotlin/HdScrollAwayFooterTest.kt +++ /dev/null @@ -1,99 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.PaddingValues -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.size -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.rememberLazyListState -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.clipToBounds -import androidx.compose.ui.input.nestedscroll.nestedScroll -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performScrollToIndex -import androidx.compose.ui.test.performTouchInput -import androidx.compose.ui.test.swipeDown -import androidx.compose.ui.test.swipeUp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel -import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdScrollAwayFooter -import com.darkrockstudios.apps.hammer.common.compose.designsystem.rememberHdScrollAwayFooterState -import org.junit.Rule -import org.junit.Test - -private const val LIST_TAG = "list" -private const val ACTION_TAG = "footer-action" -private val PaneHeight = 300.dp -private val RowHeight = 30.dp -private val ActionHeight = 44.dp - -class HdScrollAwayFooterTest { - - @get:Rule - val compose = createComposeRule() - - private fun showFooter(rowCount: Int) { - compose.setContent { - val footerState = rememberHdScrollAwayFooterState() - val listState = rememberLazyListState() - Box(modifier = Modifier.size(400.dp, PaneHeight).clipToBounds()) { - LazyColumn( - modifier = Modifier - .fillMaxSize() - .testTag(LIST_TAG) - .nestedScroll(footerState.nestedScrollConnection), - state = listState, - contentPadding = PaddingValues(bottom = footerState.height), - ) { - items(rowCount) { index -> TestRow(index) } - } - - HdScrollAwayFooter( - state = footerState, - visible = !listState.canScrollForward || !footerState.isHiddenByScroll, - ) { - Box(modifier = Modifier.weight(1f).height(ActionHeight).testTag(ACTION_TAG)) - } - } - } - } - - @Test - fun `Footer hides on a downward scroll`() { - showFooter(rowCount = 40) - - compose.onNodeWithTag(LIST_TAG).performTouchInput { swipeUp() } - - compose.onNodeWithTag(ACTION_TAG).assertDoesNotExist() - } - - @Test - fun `Footer is pinned once the list bottoms out`() { - showFooter(rowCount = 40) - - compose.onNodeWithTag(LIST_TAG).performScrollToIndex(39) - - compose.onNodeWithTag(ACTION_TAG).assertIsDisplayed() - } - - @Test - fun `Footer returns on an upward scroll`() { - showFooter(rowCount = 40) - - compose.onNodeWithTag(LIST_TAG).performTouchInput { swipeUp() } - compose.onNodeWithTag(LIST_TAG).performTouchInput { swipeDown() } - - compose.onNodeWithTag(ACTION_TAG).assertIsDisplayed() - } -} - -@Composable -private fun TestRow(index: Int) { - Box(modifier = Modifier.fillMaxWidth().height(RowHeight)) { - HdMonoLabel(text = "ROW $index") - } -} diff --git a/composeUi/src/desktopTest/kotlin/LinkifyChangelogTest.kt b/composeUi/src/desktopTest/kotlin/LinkifyChangelogTest.kt deleted file mode 100644 index d8c5698a7..000000000 --- a/composeUi/src/desktopTest/kotlin/LinkifyChangelogTest.kt +++ /dev/null @@ -1,101 +0,0 @@ -import androidx.compose.ui.text.AnnotatedString -import androidx.compose.ui.text.LinkAnnotation -import androidx.compose.ui.text.SpanStyle -import com.darkrockstudios.apps.hammer.common.projectselection.linkifyChangelog -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class LinkifyChangelogTest { - - private fun linkify(text: String) = linkifyChangelog(text, SpanStyle()) - - private fun AnnotatedString.urls(): List = - getLinkAnnotations(0, length) - .mapNotNull { (it.item as? LinkAnnotation.Url)?.url } - - @Test - fun `markdown link renders its label and carries the url`() { - val result = linkify("- See [the docs](https://hammer.ink/docs) for more") - - assertEquals("- See the docs for more", result.text) - assertEquals(listOf("https://hammer.ink/docs"), result.urls()) - } - - @Test - fun `bare url links to itself`() { - val result = linkify("Visit https://hammer.ink today") - - assertEquals("Visit https://hammer.ink today", result.text) - assertEquals(listOf("https://hammer.ink"), result.urls()) - } - - @Test - fun `trailing sentence punctuation stays outside the href`() { - val result = linkify("Read https://hammer.ink/docs.") - - assertEquals("Read https://hammer.ink/docs.", result.text) - assertEquals(listOf("https://hammer.ink/docs"), result.urls()) - } - - @Test - fun `section tags are left untouched`() { - val notes = "[New]\n- Ideas: capture ideas for new stories\n\n[Fix]\n- Text editor crash" - val result = linkify(notes) - - assertEquals(notes, result.text) - assertTrue(result.urls().isEmpty()) - } - - @Test - fun `text with no links round-trips unchanged`() { - val notes = "- Translations updated for German, Spanish, French" - val result = linkify(notes) - - assertEquals(notes, result.text) - assertTrue(result.urls().isEmpty()) - } - - @Test - fun `markdown url containing parentheses is not truncated`() { - val url = "https://en.wikipedia.org/wiki/Rich_Text_Format_(RTF)" - val result = linkify("- See [the format]($url) for details") - - assertEquals("- See the format for details", result.text) - assertEquals(listOf(url), result.urls()) - } - - @Test - fun `bare url keeps its own balanced parentheses`() { - val url = "https://en.wikipedia.org/wiki/Rich_Text_Format_(RTF)" - val result = linkify("See $url today") - - assertEquals("See $url today", result.text) - assertEquals(listOf(url), result.urls()) - } - - @Test - fun `wrapping paren is not swallowed by a bare url`() { - val result = linkify("(see https://hammer.ink)") - - assertEquals("(see https://hammer.ink)", result.text) - assertEquals(listOf("https://hammer.ink"), result.urls()) - } - - @Test - fun `balanced parens survive trailing sentence punctuation`() { - val url = "https://example.com/a_(b)" - val result = linkify("Read $url.") - - assertEquals("Read $url.", result.text) - assertEquals(listOf(url), result.urls()) - } - - @Test - fun `multiple links in one line are all captured`() { - val result = linkify("[a](https://a.example) and https://b.example done") - - assertEquals("a and https://b.example done", result.text) - assertEquals(listOf("https://a.example", "https://b.example"), result.urls()) - } -} diff --git a/composeUi/src/desktopTest/kotlin/MarkdownEditFieldSpellCheckTest.kt b/composeUi/src/desktopTest/kotlin/MarkdownEditFieldSpellCheckTest.kt deleted file mode 100644 index 24b658321..000000000 --- a/composeUi/src/desktopTest/kotlin/MarkdownEditFieldSpellCheckTest.kt +++ /dev/null @@ -1,132 +0,0 @@ -import androidx.compose.animation.AnimatedVisibility -import androidx.compose.animation.ExperimentalSharedTransitionApi -import androidx.compose.animation.SharedTransitionLayout -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.toPixelMap -import androidx.compose.ui.test.SemanticsNodeInteraction -import androidx.compose.ui.test.onRoot -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.notes.ViewNote -import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.notes.ViewNoteUi -import androidx.compose.ui.test.captureToImage -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownEditField -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.time.Clock - -class MarkdownEditFieldSpellCheckTest { - - @get:Rule - val compose = createComposeRule() - - private fun mount(markdown: String) { - compose.setContent { - KoinApplicationPreview { - MarkdownEditField( - initialMarkdown = markdown, - onMarkdownChanged = {}, - testTag = EDITOR_TAG, - ) - } - } - } - - // The squiggle is the only pure red the editor draws. - private fun squigglePixels(node: SemanticsNodeInteraction = compose.onNodeWithTag(EDITOR_TAG)): Int { - val pixels = node.captureToImage().toPixelMap() - var count = 0 - for (x in 0 until pixels.width) { - for (y in 0 until pixels.height) { - val c = pixels[x, y] - if (c.red > 0.8f && c.green < 0.3f && c.blue < 0.3f) count++ - } - } - return count - } - - @Test - fun `a misspelling in the initial text is underlined`() { - mount("This sentense has a tyypo in it.") - - compose.waitUntil(timeoutMillis = 10_000) { squigglePixels() > 0 } - } - - @Test - fun `correctly spelled initial text is not underlined`() { - mount("This sentence has no typo in it.") - - compose.mainClock.advanceTimeBy(2_000) - compose.waitForIdle() - assertEquals(0, squigglePixels()) - } - - @OptIn(ExperimentalSharedTransitionApi::class) - @Test - fun `a misspelling in a note being edited is underlined`() { - val text = "This sentense has a tyypo in it." - val component = EditingViewNote(text) - compose.setContent { - KoinApplicationPreview { - SharedTransitionLayout { - AnimatedVisibility(visible = true) { - ViewNoteUi( - component = component, - modifier = Modifier, - rootSnackbar = rememberRootSnackbarHostState(), - sharedTransitionScope = this@SharedTransitionLayout, - animatedVisibilityScope = this@AnimatedVisibility, - ) - } - } - } - } - - compose.waitUntil(timeoutMillis = 10_000) { squigglePixels(compose.onRoot()) > 0 } - } - - private class EditingViewNote(text: String) : ViewNote { - private val projectDef = ProjectDef( - name = "Test", - path = HPath(name = "Test", path = "/", isAbsolute = true), - ) - override val state: Value = MutableValue( - ViewNote.State( - projectDef = projectDef, - note = NoteContent(id = 1, created = Clock.System.now(), content = text), - isEditing = true, - ) - ) - override val noteText: Value = MutableValue(text) - - override fun discardEdit() {} - override fun onContentChanged(newContent: String) {} - override fun onTagsChanged(newTags: Set) {} - override suspend fun removeTag(tag: String) {} - override fun showGlobalSearchForTag(tag: String) {} - override suspend fun deleteNote(id: Int) {} - override fun confirmDelete() {} - override fun dismissConfirmDelete() {} - override suspend fun storeNoteUpdate() {} - override fun closeNote() {} - override fun beginEdit() {} - override fun isEditingAndDirty(): Boolean = false - override fun confirmDiscard() {} - override fun cancelDiscard() {} - override fun confirmClose() {} - override fun cancelClose() {} - override fun suggestTags(prefix: String, limit: Int): List = emptyList() - } - - private companion object { - const val EDITOR_TAG = "markdown-edit-field" - } -} diff --git a/composeUi/src/desktopTest/kotlin/MarkdownRestyleBlockIndentTest.kt b/composeUi/src/desktopTest/kotlin/MarkdownRestyleBlockIndentTest.kt deleted file mode 100644 index 160830683..000000000 --- a/composeUi/src/desktopTest/kotlin/MarkdownRestyleBlockIndentTest.kt +++ /dev/null @@ -1,36 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.HammerRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.HammerRichTextStylesDark -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.state.TextEditorState -import io.mockk.mockk -import kotlinx.coroutines.test.TestScope -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals - -/** - * A theme change restyles every line in place, which must not cost block lines the - * ParagraphStyle their gutter markers are positioned against. - */ -class MarkdownRestyleBlockIndentTest { - - private fun TestScope.newEditor(): MarkdownExtension { - val state = TextEditorState(scope = this, measurer = mockk(relaxed = true)) - state.richTextStyles = HammerRichTextStyles - return state.withMarkdown(HammerMarkdownConfiguration) - } - - @Test - fun `list indents survive a theme change`() = runTest { - val editor = newEditor() - editor.importMarkdown("A paragraph.\n\n1. one\n2. two\n\n- bullet\n\n> quoted") - val before = editor.editorState.textLines.map { it.paragraphStyles } - - editor.editorState.updateRichTextStyles(HammerRichTextStylesDark) - - assertEquals(before, editor.editorState.textLines.map { it.paragraphStyles }) - } -} diff --git a/composeUi/src/desktopTest/kotlin/MarkdownTableTest.kt b/composeUi/src/desktopTest/kotlin/MarkdownTableTest.kt deleted file mode 100644 index bd5ebc203..000000000 --- a/composeUi/src/desktopTest/kotlin/MarkdownTableTest.kt +++ /dev/null @@ -1,50 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.insertHorizontalRule -import com.darkrockstudios.texteditor.CharLineOffset -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.state.TextEditorState -import com.darkrockstudios.texteditor.state.isTableCell -import io.mockk.mockk -import kotlinx.coroutines.test.TestScope -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -class MarkdownTableTest { - - private fun TestScope.newEditor(): MarkdownExtension { - val state = TextEditorState(scope = this, measurer = mockk(relaxed = true)) - return state.withMarkdown(HammerMarkdownConfiguration) - } - - private val scene = "Before the table.\n\n| Name | Age |\n| --- | --: |\n| Ada | 36 |\n\nAfter the table." - - @Test - fun `a table in a scene reads back as a table`() = runTest { - val editor = newEditor() - editor.importMarkdown(scene) - - val cells = editor.editorState.textLines.indices.filter { editor.editorState.isTableCell(it) } - assertEquals(listOf("Name", "Age", "Ada", "36"), cells.map { editor.editorState.textLines[it].text }) - - val reopened = newEditor() - reopened.importMarkdown(editor.exportAsMarkdown()) - assertEquals(editor.exportAsMarkdown(), reopened.exportAsMarkdown()) - } - - @Test - fun `a horizontal rule is not put in a table`() = runTest { - val editor = newEditor() - editor.importMarkdown(scene) - val before = editor.exportAsMarkdown() - val cell = editor.editorState.textLines.indices.first { editor.editorState.isTableCell(it) } - - editor.editorState.cursor.updatePosition(CharLineOffset(cell, 2)) - insertHorizontalRule(editor.editorState) - - assertTrue(editor.editorState.isTableCell(cell)) - assertEquals(before, editor.exportAsMarkdown()) - } -} diff --git a/composeUi/src/desktopTest/kotlin/MarkdownViewRestyleTest.kt b/composeUi/src/desktopTest/kotlin/MarkdownViewRestyleTest.kt deleted file mode 100644 index 192233980..000000000 --- a/composeUi/src/desktopTest/kotlin/MarkdownViewRestyleTest.kt +++ /dev/null @@ -1,50 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.width -import androidx.compose.runtime.CompositionLocalProvider -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.text.TextStyle -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.sp -import com.darkrockstudios.apps.hammer.common.compose.LocalEditorTextStyle -import com.darkrockstudios.apps.hammer.common.compose.markdowneditor.MarkdownView -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertTrue - -private const val VIEW_TAG = "markdown-view" - -class MarkdownViewRestyleTest { - - @get:Rule - val compose = createComposeRule() - - private fun viewHeight() = compose.onNodeWithTag(VIEW_TAG).fetchSemanticsNode().size.height - - @Test - fun `a new text size resizes text that is already rendered`() { - var fontSize by mutableStateOf(16f) - compose.setContent { - CompositionLocalProvider(LocalEditorTextStyle provides TextStyle(fontSize = fontSize.sp)) { - Box(modifier = Modifier.width(400.dp)) { - MarkdownView( - markdown = "One line of prose.\n\nAnother line of prose.", - modifier = Modifier.testTag(VIEW_TAG), - ) - } - } - } - compose.waitForIdle() - val before = viewHeight() - - fontSize = 32f - compose.waitForIdle() - - assertTrue(viewHeight() > before, "Text must grow with the font size: $before -> ${viewHeight()}") - } -} diff --git a/composeUi/src/desktopTest/kotlin/PlatformAboutSectionTest.kt b/composeUi/src/desktopTest/kotlin/PlatformAboutSectionTest.kt deleted file mode 100644 index c3d596bc5..000000000 --- a/composeUi/src/desktopTest/kotlin/PlatformAboutSectionTest.kt +++ /dev/null @@ -1,49 +0,0 @@ -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithText -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.projectselection.aboutapp.AboutApp -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme -import com.darkrockstudios.apps.hammer.common.preview.globalSettingsPreview -import com.darkrockstudios.apps.hammer.common.projectselection.about.PlatformAboutSection -import org.junit.Rule -import org.junit.Test - -/** - * The support case behind these buttons was a user who could not get at their logs, so every - * route to them has to actually render. - */ -class PlatformAboutSectionTest { - @get:Rule - val compose = createComposeRule() - - private class FakeAboutApp(logDirectoryPath: String) : AboutApp { - override val state: Value = - MutableValue(AboutApp.State(logDirectoryPath = logDirectoryPath)) - - override fun openDiscord() = Unit - override fun openReddit() = Unit - override fun openGithub() = Unit - override fun viewChangelog() = Unit - override fun openLatestRelease() = Unit - override fun checkForUpdate() = Unit - override fun updateApp() = Unit - } - - @Test - fun `every log action and the log directory are shown`() { - val logDir = "/home/someone/.config/DarkrockStudios/hammer/0/logs" - compose.setContent { - AppTheme(globalSettingsPreview) { - PlatformAboutSection(FakeAboutApp(logDir), section = 0) - } - } - - compose.onNodeWithText("Application Logs").assertIsDisplayed() - compose.onNodeWithText(logDir).assertIsDisplayed() - compose.onNodeWithText("Open log directory").assertIsDisplayed() - compose.onNodeWithText("Export Logs").assertIsDisplayed() - compose.onNodeWithText("Copy Diagnostics").assertIsDisplayed() - } -} diff --git a/composeUi/src/desktopTest/kotlin/ProjectListFooterTest.kt b/composeUi/src/desktopTest/kotlin/ProjectListFooterTest.kt deleted file mode 100644 index b9e246bf5..000000000 --- a/composeUi/src/desktopTest/kotlin/ProjectListFooterTest.kt +++ /dev/null @@ -1,87 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.size -import androidx.compose.ui.Modifier -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.SemanticsNodeInteraction -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performScrollToIndex -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.preview.projectselection.fakeProjectsList -import com.darkrockstudios.apps.hammer.common.preview.projectselection.previewProject -import com.darkrockstudios.apps.hammer.common.projectselection.CreateProjectButtonTestTag -import com.darkrockstudios.apps.hammer.common.projectselection.ProjectListTestTag -import com.darkrockstudios.apps.hammer.common.projectselection.ProjectListUi -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertTrue - -private const val PANE_TAG = "test-pane" -private const val PROJECT_COUNT = 20 - -/** The phone layout: [ProjectListUi] only shows the create bar at Compact width. */ -class ProjectListFooterTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - private fun showProjectList() { - compose.setContent { - KoinApplicationPreview { - Box(modifier = Modifier.testTag(PANE_TAG).size(360.dp, 640.dp)) { - ProjectListUi( - component = fakeProjectsList(List(PROJECT_COUNT) { testProject(it) }), - rootSnackbar = rememberRootSnackbarHostState(), - ) - } - } - } - } - - private fun SemanticsNodeInteraction.bounds() = fetchSemanticsNode().boundsInRoot - - @Test - fun `Project list fills its pane beneath the create bar`() { - showProjectList() - - val list = compose.onNodeWithTag(ProjectListTestTag).bounds() - val createBar = compose.onNodeWithTag(CreateProjectButtonTestTag).bounds() - - assertTrue( - list.bottom >= createBar.bottom, - "Create bar must overlay the list, not shrink it: list bottom ${list.bottom}, bar bottom ${createBar.bottom}", - ) - } - - @Test - fun `Last project clears the create bar when scrolled to the bottom`() { - showProjectList() - - compose.onNodeWithTag(ProjectListTestTag).performScrollToIndex(PROJECT_COUNT - 1) - - val createBar = compose.onNodeWithTag(CreateProjectButtonTestTag).bounds() - val lastProject = compose.onNodeWithText(projectName(PROJECT_COUNT - 1)).bounds() - - assertTrue( - lastProject.bottom <= createBar.top + 1f, - "Last project must scroll clear of the create bar: row bottom ${lastProject.bottom}, bar top ${createBar.top}", - ) - } - - @Test - fun `Create bar stays visible at the bottom of the list`() { - showProjectList() - - compose.onNodeWithTag(ProjectListTestTag).performScrollToIndex(PROJECT_COUNT - 1) - - compose.onNodeWithTag(CreateProjectButtonTestTag).assertIsDisplayed() - } -} - -private fun projectName(index: Int) = "Project ${index + 1}" - -private fun testProject(index: Int) = previewProject(projectName(index), tags = emptySet()) diff --git a/composeUi/src/desktopTest/kotlin/ReaderModeUiTest.kt b/composeUi/src/desktopTest/kotlin/ReaderModeUiTest.kt deleted file mode 100644 index 4343346a9..000000000 --- a/composeUi/src/desktopTest/kotlin/ReaderModeUiTest.kt +++ /dev/null @@ -1,193 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.size -import androidx.compose.ui.Modifier -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.assertTextEquals -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.onNodeWithText -import androidx.compose.ui.test.performClick -import androidx.compose.ui.test.performScrollToNode -import androidx.compose.ui.test.hasTestTag -import androidx.compose.ui.unit.dp -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.common.components.storyeditor.readermode.ReaderMode -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_EDIT_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_HEADINGS_TOGGLE_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_INCREASE_FONT_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_LIST_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_NEXT_CHAPTER_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.READER_MODE_SCENE_BREAK_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.ReaderModeUi -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.readerSceneBodyTag -import com.darkrockstudios.apps.hammer.common.storyeditor.readermode.readerSceneHeadingTag -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -class ReaderModeUiTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - private val projectDef = ProjectDef(name = "Test", path = HPath(name = "Test", path = "/", isAbsolute = true)) - - private fun item(id: Int, name: String, type: SceneItem.Type) = - SceneItem(projectDef = projectDef, type = type, id = id, name = name, order = id) - - private val chapterOne = item(1, "Arrival", SceneItem.Type.Group) - private val chapterTwo = item(4, "The Dark Night", SceneItem.Type.Group) - private val harbour = item(2, "The Harbour", SceneItem.Type.Scene) - private val lampRoom = item(3, "The Lamp Room", SceneItem.Type.Scene) - - private val reader = FakeReader( - ReaderMode.State( - chapters = listOf( - ReaderMode.ReaderChapter(chapterOne, sceneCount = 2), - ReaderMode.ReaderChapter(chapterTwo, sceneCount = 0), - ), - activeChapterId = chapterOne.id, - scenes = listOf( - ReaderMode.ReaderScene(harbour, "The keeper stepped off the ferry."), - ReaderMode.ReaderScene(lampRoom, "One hundred and nine steps."), - ), - isLoading = false, - ) - ) - - private fun showReader() { - compose.setContent { - KoinApplicationPreview { - Box(modifier = Modifier.size(420.dp, 900.dp)) { - ReaderModeUi(component = reader) - } - } - } - } - - @Test - fun `Scenes are stitched with an ornament and no headings by default`() { - showReader() - - compose.onNodeWithTag(readerSceneBodyTag(harbour.id)).assertTextEquals("The keeper stepped off the ferry.") - compose.onNodeWithTag(readerSceneBodyTag(lampRoom.id)).assertTextEquals("One hundred and nine steps.") - compose.onNodeWithTag(READER_MODE_SCENE_BREAK_TAG).assertIsDisplayed() - compose.onNodeWithTag(readerSceneHeadingTag(harbour.id)).assertDoesNotExist() - } - - @Test - fun `Scene headings replace the ornament when enabled`() { - showReader() - - compose.onNodeWithTag(READER_MODE_HEADINGS_TOGGLE_TAG).performClick() - compose.waitForIdle() - - compose.onNodeWithTag(readerSceneHeadingTag(harbour.id)).assertIsDisplayed() - compose.onNodeWithTag(readerSceneHeadingTag(lampRoom.id)).assertIsDisplayed() - compose.onNodeWithTag(READER_MODE_SCENE_BREAK_TAG).assertDoesNotExist() - } - - @Test - fun `A scene heading opens that scene in the editor`() { - reader.update { it.copy(showSceneHeadings = true) } - showReader() - - compose.onNodeWithTag(readerSceneHeadingTag(lampRoom.id)).performClick() - - assertEquals(listOf(lampRoom), reader.edited) - } - - @Test - fun `Edit opens the scene being read`() { - showReader() - - compose.onNodeWithTag(READER_MODE_EDIT_TAG).performClick() - - assertEquals(listOf(null), reader.edited) - } - - @Test - fun `The scene at the top of the column is reported as in view`() { - showReader() - compose.waitForIdle() - - assertEquals(harbour, reader.inView.last()) - } - - @Test - fun `A scroll request is acknowledged once the chapter is on screen`() { - reader.update { it.copy(scrollToSceneId = lampRoom.id) } - showReader() - compose.waitForIdle() - - assertEquals(1, reader.scrollsHandled) - } - - @Test - fun `Font size and chapter controls reach the component`() { - showReader() - - compose.onNodeWithTag(READER_MODE_INCREASE_FONT_TAG).performClick() - compose.onNodeWithTag(READER_MODE_LIST_TAG).performScrollToNode(hasTestTag(READER_MODE_NEXT_CHAPTER_TAG)) - compose.onNodeWithTag(READER_MODE_NEXT_CHAPTER_TAG).performClick() - - assertEquals(1, reader.fontIncreases) - assertEquals(1, reader.nextChapters) - } - - @Test - fun `An empty chapter says so`() { - reader.update { it.copy(activeChapterId = chapterTwo.id, scenes = emptyList()) } - showReader() - - compose.onNodeWithText("This chapter has no scenes yet").assertIsDisplayed() - } -} - -private class FakeReader(initial: ReaderMode.State) : ReaderMode { - override val state = MutableValue(initial) - - val edited = mutableListOf() - val inView = mutableListOf() - var scrollsHandled = 0 - var fontIncreases = 0 - var nextChapters = 0 - - fun update(transform: (ReaderMode.State) -> ReaderMode.State) = state.update(transform) - - override fun showChapter(chapterId: Int) {} - override fun nextChapter() { - nextChapters++ - } - - override fun previousChapter() {} - override fun showScene(sceneItem: SceneItem) {} - override fun scrollHandled() { - scrollsHandled++ - state.update { it.copy(scrollToSceneId = null) } - } - - override fun sceneInView(sceneItem: SceneItem?) { - inView.add(sceneItem) - } - - override fun editScene(sceneItem: SceneItem?) { - edited.add(sceneItem) - } - - override fun toggleSceneHeadings() = state.update { it.copy(showSceneHeadings = !it.showSceneHeadings) } - override fun increaseFontSize() { - fontIncreases++ - } - - override fun decreaseFontSize() {} - override fun resetFontSize() {} - override fun setEditorMaxWidth(width: Float) {} - override fun resetEditorMaxWidth() {} - override fun close() {} -} diff --git a/composeUi/src/desktopTest/kotlin/RichTextStylesRestyleTest.kt b/composeUi/src/desktopTest/kotlin/RichTextStylesRestyleTest.kt deleted file mode 100644 index 9a66f2630..000000000 --- a/composeUi/src/desktopTest/kotlin/RichTextStylesRestyleTest.kt +++ /dev/null @@ -1,51 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.HammerRichTextStyles -import com.darkrockstudios.apps.hammer.common.compose.HammerRichTextStylesDark -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.compose.markdown.updateRichTextStyles -import com.darkrockstudios.texteditor.RichTextStyles -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.state.TextEditorState -import io.mockk.mockk -import kotlinx.coroutines.test.TestScope -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertTrue - -/** Switching themes restyles the document in place; the body size never does (see EditorTextSizeTest). */ -class RichTextStylesRestyleTest { - - private fun TestScope.newEditor(styles: RichTextStyles): MarkdownExtension { - val state = TextEditorState(scope = this, measurer = mockk(relaxed = true)) - state.richTextStyles = styles - return state.withMarkdown(HammerMarkdownConfiguration) - } - - @Test - fun `switching themes leaves one baked style per heading`() = runTest { - val editor = newEditor(HammerRichTextStyles) - editor.importMarkdown("# Chapter One\n\nSome body text.") - val before = editor.editorState.textLines[0].spanStyles.size - - repeat(5) { step -> - editor.editorState.updateRichTextStyles( - if (step % 2 == 0) HammerRichTextStylesDark else HammerRichTextStyles - ) - } - - assertEquals(before, editor.editorState.textLines[0].spanStyles.size) - } - - @Test - fun `code spans take the new theme's background`() = runTest { - val editor = newEditor(HammerRichTextStyles) - editor.importMarkdown("Some `code` here.") - - editor.editorState.updateRichTextStyles(HammerRichTextStylesDark) - - val backgrounds = editor.editorState.textLines[0].spanStyles.map { it.item.background } - assertTrue(HammerRichTextStylesDark.codeStyle.background in backgrounds) - assertTrue(HammerRichTextStyles.codeStyle.background !in backgrounds) - } -} diff --git a/composeUi/src/desktopTest/kotlin/SceneContentLoadTest.kt b/composeUi/src/desktopTest/kotlin/SceneContentLoadTest.kt deleted file mode 100644 index 557263380..000000000 --- a/composeUi/src/desktopTest/kotlin/SceneContentLoadTest.kt +++ /dev/null @@ -1,112 +0,0 @@ -import com.darkrockstudios.apps.hammer.common.compose.ComposeRichText -import com.darkrockstudios.apps.hammer.common.compose.markdown.HammerMarkdownConfiguration -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SceneContent -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.loadSceneContent -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.sceneDiffText -import com.darkrockstudios.texteditor.markdown.MarkdownExtension -import com.darkrockstudios.texteditor.markdown.withMarkdown -import com.darkrockstudios.texteditor.richstyle.HorizontalRuleSpanStyle -import com.darkrockstudios.texteditor.state.TextEditorState -import io.mockk.mockk -import kotlinx.coroutines.test.TestScope -import kotlinx.coroutines.test.runTest -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotEquals - -class SceneContentLoadTest { - - private val projectDef = ProjectDef( - name = "Test Project", - path = HPath(path = "/test", name = "Test Project", isAbsolute = true), - ) - - private val sceneItem = SceneItem( - projectDef = projectDef, - type = SceneItem.Type.Scene, - id = 1, - name = "Test Scene", - order = 0, - ) - - private fun TestScope.newEditor(): MarkdownExtension { - val state = TextEditorState(scope = this, measurer = mockk(relaxed = true)) - return state.withMarkdown(HammerMarkdownConfiguration) - } - - private fun MarkdownExtension.horizontalRuleLines(): List = - editorState.richSpanManager.getAllRichSpans() - .filter { it.style === HorizontalRuleSpanStyle } - .map { it.range.start.line } - .sorted() - - @Test - fun `horizontal rule survives reloading a live editor buffer`() = runTest { - val original = "Before the break.\n\n---\n\nAfter the break." - - val editing = newEditor() - editing.importMarkdown(original) - val buffered = SceneContent( - scene = sceneItem, - platformRepresentation = ComposeRichText(editing), - ) - - val reopened = newEditor() - loadSceneContent(reopened, buffered) - - assertEquals(listOf(2), reopened.horizontalRuleLines()) - assertEquals(original, reopened.exportAsMarkdown()) - } - - @Test - fun `horizontal rule survives loading markdown from disk`() = runTest { - val original = "Before the break.\n\n---\n\nAfter the break." - val onDisk = SceneContent(scene = sceneItem, markdown = original) - - val reopened = newEditor() - loadSceneContent(reopened, onDisk) - - assertEquals(listOf(2), reopened.horizontalRuleLines()) - assertEquals(original, reopened.exportAsMarkdown()) - } - - @Test - fun `null content loads an empty document`() = runTest { - val editor = newEditor() - editor.importMarkdown("Some prior text") - - loadSceneContent(editor, null) - - assertEquals("", editor.exportAsMarkdown()) - } - - @Test - fun `diff text distinguishes a horizontal rule from a blank line`() = runTest { - val withRule = newEditor() - loadSceneContent(withRule, SceneContent(sceneItem, "Before.\n\n---\n\nAfter.")) - val withoutRule = newEditor() - loadSceneContent(withoutRule, SceneContent(sceneItem, "Before.\n\n\n\nAfter.")) - - assertNotEquals(sceneDiffText(withRule), sceneDiffText(withoutRule)) - } - - @Test - fun `diff text stays in the editor coordinate space`() = runTest { - val editor = newEditor() - loadSceneContent(editor, SceneContent(sceneItem, "Before.\n\n---\n\nAfter.")) - - // The diff's offsets index back into the editor, so substitution must not resize. - assertEquals(editor.editorState.getAllText().text.length, sceneDiffText(editor).length) - } - - @Test - fun `diff text leaves prose untouched`() = runTest { - val editor = newEditor() - loadSceneContent(editor, SceneContent(sceneItem, "Just prose.\n\nNo blocks here.")) - - assertEquals(editor.editorState.getAllText().text, sceneDiffText(editor)) - } -} diff --git a/composeUi/src/desktopTest/kotlin/SceneEditorSpellCheckTest.kt b/composeUi/src/desktopTest/kotlin/SceneEditorSpellCheckTest.kt deleted file mode 100644 index 247c4dcd4..000000000 --- a/composeUi/src/desktopTest/kotlin/SceneEditorSpellCheckTest.kt +++ /dev/null @@ -1,72 +0,0 @@ -import androidx.compose.ui.graphics.toPixelMap -import androidx.compose.ui.test.captureToImage -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onRoot -import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.preview.sceneeditor.fakeFocusMode -import com.darkrockstudios.apps.hammer.common.preview.sceneeditor.fakeSceneEditor -import com.darkrockstudios.apps.hammer.common.storyeditor.focusmode.FocusModeUi -import com.darkrockstudios.apps.hammer.common.storyeditor.sceneeditor.SceneEditorUi -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellChecker -import com.darkrockstudios.libs.platformspellchecker.PlatformSpellCheckerFactory -import com.darkrockstudios.libs.platformspellchecker.SpLocale -import kotlinx.coroutines.runBlocking -import org.junit.Assume.assumeTrue -import org.junit.Rule -import org.junit.Test - -class SceneEditorSpellCheckTest { - - @get:Rule - val compose = createComposeRule() - - // The squiggle is the only pure red the editor draws. - private fun squigglePixels(): Int { - val pixels = compose.onRoot().captureToImage().toPixelMap() - var count = 0 - for (x in 0 until pixels.width) { - for (y in 0 until pixels.height) { - val c = pixels[x, y] - if (c.red > 0.8f && c.green < 0.3f && c.blue < 0.3f) count++ - } - } - return count - } - - private fun englishChecker(): PlatformSpellChecker { - val factory = PlatformSpellCheckerFactory() - assumeTrue("en-US dictionary not available", factory.hasLanguage(SpLocale.EN_US)) - return runBlocking { factory.createSpellChecker(SpLocale.EN_US) } - } - - @Test - fun `a misspelling in the loaded scene is underlined`() { - val component = fakeSceneEditor(markdown = TYPO_TEXT, spellChecker = englishChecker()) - - compose.setContent { - KoinApplicationPreview { - SceneEditorUi(component, rememberRootSnackbarHostState()) - } - } - - compose.waitUntil(timeoutMillis = 10_000) { squigglePixels() > 0 } - } - - @Test - fun `a misspelling in the loaded scene is underlined in focus mode`() { - val component = fakeFocusMode(markdown = TYPO_TEXT, spellChecker = englishChecker()) - - compose.setContent { - KoinApplicationPreview { - FocusModeUi(component) - } - } - - compose.waitUntil(timeoutMillis = 10_000) { squigglePixels() > 0 } - } - - private companion object { - const val TYPO_TEXT = "This sentense has a tyypo in it." - } -} diff --git a/composeUi/src/desktopTest/kotlin/SceneListFooterTest.kt b/composeUi/src/desktopTest/kotlin/SceneListFooterTest.kt deleted file mode 100644 index d18d9f665..000000000 --- a/composeUi/src/desktopTest/kotlin/SceneListFooterTest.kt +++ /dev/null @@ -1,142 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.size -import androidx.compose.ui.Modifier -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.SemanticsNodeInteraction -import androidx.compose.ui.test.assertIsDisplayed -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performScrollToIndex -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.storyeditor.scenelist.SceneList -import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.data.MoveRequest -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SceneBuffer -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.SceneSummary -import com.darkrockstudios.apps.hammer.common.data.tree.Tree -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.SCENE_LIST_ADD_BUTTON_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.SCENE_LIST_TREE_TAG -import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.SceneListUi -import com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.sceneItemTag -import kotlinx.collections.immutable.persistentSetOf -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertTrue - -private const val PANE_TAG = "test-pane" -private const val SCENE_COUNT = 40 - -class SceneListFooterTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - private fun showSceneList(paneHeight: Dp = 600.dp) { - compose.setContent { - KoinApplicationPreview { - Box(modifier = Modifier.testTag(PANE_TAG).size(400.dp, paneHeight)) { - SceneListUi( - component = fakeComponent(), - snackbarHostState = rememberRootSnackbarHostState(), - ) - } - } - } - } - - private fun SemanticsNodeInteraction.bounds() = fetchSemanticsNode().boundsInRoot - - @Test - fun `Scene list fills the pane beneath the footer`() { - showSceneList() - - val pane = compose.onNodeWithTag(PANE_TAG).bounds() - val tree = compose.onNodeWithTag(SCENE_LIST_TREE_TAG).bounds() - - assertTrue( - tree.bottom >= pane.bottom - 1f, - "Footer must overlay the list, not shrink it: tree bottom ${tree.bottom}, pane bottom ${pane.bottom}", - ) - } - - @Test - fun `Last scene clears the footer when scrolled to the bottom`() { - showSceneList() - - compose.onNodeWithTag(SCENE_LIST_TREE_TAG).performScrollToIndex(SCENE_COUNT - 1) - - val footer = compose.onNodeWithTag(SCENE_LIST_ADD_BUTTON_TAG).bounds() - val lastScene = compose.onNodeWithTag(sceneItemTag(SCENE_COUNT)).bounds() - - assertTrue( - lastScene.bottom <= footer.top + 1f, - "Last scene must scroll clear of the footer: scene bottom ${lastScene.bottom}, footer top ${footer.top}", - ) - } - - @Test - fun `Footer stays visible at the bottom of the list`() { - showSceneList() - - compose.onNodeWithTag(SCENE_LIST_TREE_TAG).performScrollToIndex(SCENE_COUNT - 1) - - compose.onNodeWithTag(SCENE_LIST_ADD_BUTTON_TAG).assertIsDisplayed() - } -} - -private fun testProjectDef() = ProjectDef( - name = "Test", - path = HPath(name = "Test", path = "/", isAbsolute = true), -) - -private fun testScene(id: Int, order: Int, type: SceneItem.Type = SceneItem.Type.Scene) = SceneItem( - projectDef = testProjectDef(), - type = type, - id = id, - name = "Test Scene $id", - order = order, -) - -private fun testSceneSummary(): SceneSummary { - val tree = Tree() - val root = TreeNode(testScene(0, 0, SceneItem.Type.Root)) - for (i in 1..SCENE_COUNT) { - root.addChild(TreeNode(testScene(i, i - 1))) - } - tree.setRoot(root) - - return SceneSummary(tree.toImmutableTree(), persistentSetOf()) -} - -private fun fakeComponent() = object : SceneList { - override val state: Value = MutableValue( - SceneList.State( - projectDef = testProjectDef(), - sceneSummary = testSceneSummary(), - ) - ) - - override fun onSceneSelected(sceneDef: SceneItem) {} - override suspend fun moveScene(moveRequest: MoveRequest) {} - override fun loadScenes() {} - override suspend fun createScene(parent: SceneItem?, sceneName: String) {} - override suspend fun createGroup(parent: SceneItem?, groupName: String) {} - override suspend fun deleteScene(scene: SceneItem) {} - override suspend fun renameScene(scene: SceneItem, newName: String): Boolean = false - override fun onSceneListUpdate(scenes: SceneSummary) {} - override fun onSceneBufferUpdate(sceneBuffer: SceneBuffer) {} - override fun showOutlineOverview() {} - override fun showReaderMode() {} - override suspend fun archiveScene(scene: SceneItem) {} - override suspend fun unarchiveScene(scene: SceneItem) {} - override fun showArchivedScenes() {} - override fun dismissArchivedDialog() {} -} diff --git a/composeUi/src/desktopTest/kotlin/SceneTreeDragTest.kt b/composeUi/src/desktopTest/kotlin/SceneTreeDragTest.kt deleted file mode 100644 index 645d0cd2c..000000000 --- a/composeUi/src/desktopTest/kotlin/SceneTreeDragTest.kt +++ /dev/null @@ -1,331 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.scenetree - -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.PaddingValues -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.geometry.Offset -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.getBoundsInRoot -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performMouseInput -import androidx.compose.ui.test.performScrollToIndex -import androidx.compose.ui.test.performTouchInput -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.data.MoveRequest -import com.darkrockstudios.apps.hammer.common.data.SceneItem -import com.darkrockstudios.apps.hammer.common.data.SceneSummary -import com.darkrockstudios.apps.hammer.common.data.tree.Tree -import com.darkrockstudios.apps.hammer.common.data.tree.TreeNode -import kotlinx.collections.immutable.persistentSetOf -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertTrue - -private const val TREE_TAG = "tree" -private val RowHeight = 30.dp -private fun rowTag(id: Int) = "row-$id" - -/** - * Tree shape, mirroring the report in issue #837: - * - * 0 Root - * ├─ 1 Preface - * ├─ 2 Chapter 1 ─ 3 The Door Opens, 4 The Discovery - * ├─ 5 Chapter 2 ─ 6 The Vacuum, 7 Exploration - * ├─ 8 Chapter 3 ─ 9 More Cameras, 10 Verification, 11 Mouse Trap - * ├─ 12 Chapter 4 ─ 13 Wildlife Expert - * ├─ 14 Chapter 5 (empty) - * └─ 15 Water, 16 Ghost Child, 17 Skeleton, 18 Bowl of Water, 19 Overview - */ -private object Ids { - const val PREFACE = 1 - const val CH1 = 2 - const val DOOR_OPENS = 3 - const val DISCOVERY = 4 - const val CH2 = 5 - const val VACUUM = 6 - const val EXPLORATION = 7 - const val CH3 = 8 - const val MORE_CAMERAS = 9 - const val VERIFICATION = 10 - const val MOUSE_TRAP = 11 - const val CH4 = 12 - const val WILDLIFE = 13 - const val CH5 = 14 - const val WATER = 15 - const val GHOST_CHILD = 16 - const val SKELETON = 17 - const val BOWL = 18 - const val OVERVIEW = 19 -} - -class SceneTreeDragTest { - - @get:Rule - val compose = createComposeRule() - - private var moveRequest: MoveRequest? = null - private lateinit var treeState: SceneTreeState - private var summary by mutableStateOf(buildSummary(camerasAtRoot = false)) - - private fun showTree(height: Dp = 800.dp) { - compose.setContent { - val state = rememberReorderableLazyListState( - summary = summary, - moveItem = { moveRequest = it }, - ) - treeState = state - LaunchedEffect(summary) { state.updateSummary(summary) } - - Box(modifier = Modifier.size(400.dp, height)) { - SceneTree( - state = state, - modifier = Modifier.fillMaxSize().testTag(TREE_TAG), - itemUi = { node, _, _, draggable -> - Box( - modifier = draggable.fillMaxWidth().height(RowHeight) - .testTag(rowTag(node.value.id)) - ) - }, - contentPadding = PaddingValues(), - ) - } - } - } - - /** Where the row actually sits on screen, which is where the user aims. */ - private fun visualCenterOf(id: Int): Offset { - val bounds = compose.onNodeWithTag(rowTag(id)).getBoundsInRoot() - return with(compose.density) { - Offset(50f, (bounds.top + (bounds.bottom - bounds.top) / 2).toPx()) - } - } - - /** The tree is taller than its rows, so this lands on the list but on no row. */ - private fun emptySpaceBelowRows(): Offset { - val lastRow = compose.onNodeWithTag(rowTag(Ids.OVERVIEW)).getBoundsInRoot() - return with(compose.density) { Offset(50f, (lastRow.bottom + 20.dp).toPx()) } - } - - private fun longPressAt(offset: Offset) { - compose.onNodeWithTag(TREE_TAG).performMouseInput { moveTo(offset); press() } - compose.mainClock.advanceTimeBy(1_000) - } - - @Test - fun `long pressing a row grabs that row`() { - showTree() - - longPressAt(visualCenterOf(Ids.MORE_CAMERAS)) - - assertEquals(Ids.MORE_CAMERAS, treeState.selectedId) - } - - @Test - fun `long pressing a row grabs that row right after the tree changed`() { - showTree() - compose.mainClock.autoAdvance = false - - // A previous move landed and the list re-flowed. Every row must still be grabbable - // where it is drawn, not where a settling animation is heading. - summary = buildSummary(camerasAtRoot = true) - compose.mainClock.advanceTimeByFrame() - compose.mainClock.advanceTimeByFrame() - - longPressAt(visualCenterOf(Ids.VERIFICATION)) - - assertEquals(Ids.VERIFICATION, treeState.selectedId, "Grabbed the wrong row") - } - - @Test - fun `the drop target follows the list when it scrolls under a still pointer`() { - showTree(height = 200.dp) - - longPressAt(visualCenterOf(Ids.PREFACE)) - val holdAt = visualCenterOf(Ids.CH2) - compose.onNodeWithTag(TREE_TAG).performMouseInput { moveTo(holdAt) } - compose.waitForIdle() - - // Autoscroll moves the list without the pointer moving, so no drag event arrives. - compose.onNodeWithTag(TREE_TAG).performScrollToIndex(12) - compose.waitForIdle() - - compose.onNodeWithTag(TREE_TAG).performMouseInput { release() } - compose.waitForIdle() - - val request = moveRequest - assertNotNull(request, "No move was requested") - val anchorId = treeState.getTree()[request.toPosition.coords.globalIndex].value.id - val anchor = compose.onNodeWithTag(rowTag(anchorId)).getBoundsInRoot() - val top = with(compose.density) { anchor.top.toPx() } - val bottom = with(compose.density) { anchor.bottom.toPx() } - - assertTrue( - holdAt.y in top..bottom, - "Anchored to a row that is not under the pointer: $anchorId spans $top..$bottom, " + - "pointer at ${holdAt.y}", - ) - } - - @Test - fun `rows are reported in display order`() { - // A tree whose display order is not ascending by id: "More Cameras" (9) sits near the - // bottom, so anything ordered by id or by hash disagrees with what is on screen. - summary = buildSummary(camerasAtRoot = true) - showTree() - - // findInsertPosition takes the first row whose bounds contain the pointer, and row - // bounds share seams, so anything but display order makes a drop on a seam a coin toss. - assertEquals( - treeState.visibleNodes.map { it.value.id }, - treeState.rowLayouts.map { it.id }, - "Row order does not match the rendered tree", - ) - } - - @Test - fun `dropping onto a settling list anchors to the row the user sees`() { - showTree() - compose.mainClock.autoAdvance = false - - compose.onNodeWithTag(TREE_TAG) - .performMouseInput { moveTo(visualCenterOf(Ids.PREFACE)); press() } - compose.mainClock.advanceTimeBy(1_000) - - // A sync re-flows the list while the drag is already under way. - summary = buildSummary(camerasAtRoot = true) - compose.mainClock.advanceTimeByFrame() - compose.mainClock.advanceTimeByFrame() - - compose.onNodeWithTag(TREE_TAG) - .performMouseInput { moveTo(visualCenterOf(Ids.VERIFICATION)) } - compose.mainClock.advanceTimeByFrame() - compose.onNodeWithTag(TREE_TAG).performMouseInput { release() } - compose.mainClock.advanceTimeBy(1_000) - - val request = moveRequest - assertNotNull(request, "No move was requested") - assertEquals( - Ids.VERIFICATION, - treeState.getTree()[request.toPosition.coords.globalIndex].value.id, - "Anchored to a row's destination instead of where it is drawn", - ) - } - - @Test - fun `a row disposed while pressed does not stay grabbable`() { - showTree() - - // Press a row, then have it deleted out from under the finger. - compose.onNodeWithTag(TREE_TAG) - .performMouseInput { moveTo(visualCenterOf(Ids.MORE_CAMERAS)); press() } - summary = buildSummary(camerasAtRoot = false, keepCameras = false) - compose.mainClock.advanceTimeBy(1_000) - compose.onNodeWithTag(TREE_TAG).performMouseInput { release() } - - longPressAt(emptySpaceBelowRows()) - - assertEquals( - SceneTreeState.NO_SELECTION, - treeState.selectedId, - "Empty space grabbed a scene", - ) - } - - @Test - fun `a second finger cannot retarget the drag`() { - showTree() - - compose.onNodeWithTag(TREE_TAG).performTouchInput { - down(0, visualCenterOf(Ids.CH3)) - down(1, visualCenterOf(Ids.OVERVIEW)) - } - compose.mainClock.advanceTimeBy(1_000) - - assertEquals(Ids.CH3, treeState.selectedId, "The second finger retargeted the drag") - } - - @Test - fun `dragging a scene to the bottom of the list moves the scene that was grabbed`() { - showTree() - - longPressAt(visualCenterOf(Ids.MORE_CAMERAS)) - compose.onNodeWithTag(TREE_TAG) - .performMouseInput { moveTo(visualCenterOf(Ids.BOWL) + Offset(0f, 10f)) } - compose.mainClock.advanceTimeBy(16) - compose.onNodeWithTag(TREE_TAG).performMouseInput { release() } - compose.waitForIdle() - - val request = moveRequest - assertNotNull(request, "No move was requested") - assertEquals(Ids.MORE_CAMERAS, request.id, "Wrong scene was moved") - assertEquals(Ids.BOWL, treeState.getTree()[request.toPosition.coords.globalIndex].value.id) - assertEquals(false, request.toPosition.before) - } -} - -/** - * [camerasAtRoot] models "More Cameras" having been dragged out of Chapter 3 to the root, and - * [keepCameras] models it having been deleted outright. - */ -private fun buildSummary(camerasAtRoot: Boolean, keepCameras: Boolean = true): SceneSummary { - val moreCameras = sceneItem(Ids.MORE_CAMERAS, SceneItem.Type.Scene, "More Cameras") - val chapter3Children = mutableListOf>( - sceneNode(sceneItem(Ids.VERIFICATION, SceneItem.Type.Scene, "Verification")), - sceneNode(sceneItem(Ids.MOUSE_TRAP, SceneItem.Type.Scene, "Mouse Trap")), - ) - val rootTail = mutableListOf>() - if (keepCameras) { - if (camerasAtRoot) rootTail.add(sceneNode(moreCameras)) - else chapter3Children.add(0, sceneNode(moreCameras)) - } - - val tree = Tree() - tree.setRoot( - sceneNode( - sceneItem(0, SceneItem.Type.Root, ""), - sceneNode(sceneItem(Ids.PREFACE, SceneItem.Type.Scene, "Preface")), - sceneNode( - sceneItem(Ids.CH1, SceneItem.Type.Group, "Chapter 1"), - sceneNode(sceneItem(Ids.DOOR_OPENS, SceneItem.Type.Scene, "The Door Opens")), - sceneNode(sceneItem(Ids.DISCOVERY, SceneItem.Type.Scene, "The Discovery")), - ), - sceneNode( - sceneItem(Ids.CH2, SceneItem.Type.Group, "Chapter 2"), - sceneNode(sceneItem(Ids.VACUUM, SceneItem.Type.Scene, "The Vacuum")), - sceneNode(sceneItem(Ids.EXPLORATION, SceneItem.Type.Scene, "Exploration")), - ), - sceneNode( - sceneItem(Ids.CH3, SceneItem.Type.Group, "Chapter 3"), - *chapter3Children.toTypedArray(), - ), - sceneNode( - sceneItem(Ids.CH4, SceneItem.Type.Group, "Chapter 4"), - sceneNode(sceneItem(Ids.WILDLIFE, SceneItem.Type.Scene, "Wildlife Expert")), - ), - sceneNode(sceneItem(Ids.CH5, SceneItem.Type.Group, "Chapter 5")), - sceneNode(sceneItem(Ids.WATER, SceneItem.Type.Scene, "Water, Apple, Insects")), - sceneNode(sceneItem(Ids.GHOST_CHILD, SceneItem.Type.Scene, "The Ghost Child")), - sceneNode(sceneItem(Ids.SKELETON, SceneItem.Type.Scene, "A black skeleton")), - sceneNode(sceneItem(Ids.BOWL, SceneItem.Type.Scene, "A bowl of water")), - *rootTail.toTypedArray(), - sceneNode(sceneItem(Ids.OVERVIEW, SceneItem.Type.Scene, "Overview")), - ) - ) - return SceneSummary( - sceneTree = tree.toImmutableTree(), - hasDirtyBuffer = persistentSetOf(), - ) -} diff --git a/composeUi/src/desktopTest/kotlin/SceneTreeInsertPositionTest.kt b/composeUi/src/desktopTest/kotlin/SceneTreeInsertPositionTest.kt index 6c47bc8a9..5e26a4a2a 100644 --- a/composeUi/src/desktopTest/kotlin/SceneTreeInsertPositionTest.kt +++ b/composeUi/src/desktopTest/kotlin/SceneTreeInsertPositionTest.kt @@ -1,5 +1,6 @@ package com.darkrockstudios.apps.hammer.common.storyeditor.scenelist.scenetree +import androidx.compose.foundation.lazy.LazyListItemInfo import androidx.compose.runtime.mutableStateMapOf import androidx.compose.runtime.snapshots.SnapshotStateMap import androidx.compose.ui.geometry.Offset @@ -24,7 +25,15 @@ import kotlin.test.assertNotNull */ class SceneTreeInsertPositionTest { - private val rowHeight = 30f + private val rowHeight = 30 + + private class FakeItemInfo( + override val index: Int, + override val key: Any, + override val offset: Int, + override val size: Int, + override val contentType: Any? = null, + ) : LazyListItemInfo private fun dropAt( tree: ImmutableTree, @@ -34,15 +43,16 @@ class SceneTreeInsertPositionTest { fractionIntoRow: Float, ): InsertPosition? { val visibleNodes = visibleSceneNodes(tree, collapsed) - val layouts = visibleNodes.mapIndexed { index, node -> - RowLayout( - id = node.value.id, - top = index * rowHeight, - height = rowHeight, + val layouts: List = visibleNodes.mapIndexed { index, node -> + FakeItemInfo( + index = index, + key = node.value.id, + offset = index * rowHeight, + size = rowHeight, ) } - val targetLayout = layouts.first { it.id == targetId } - val dragY = targetLayout.top + (rowHeight * fractionIntoRow) + val targetLayout = layouts.first { it.key == targetId } + val dragY = targetLayout.offset + (rowHeight * fractionIntoRow) return findInsertPosition( dragOffset = Offset(0f, dragY), layouts = layouts, diff --git a/composeUi/src/desktopTest/kotlin/ScreenCharacteristicsTest.kt b/composeUi/src/desktopTest/kotlin/ScreenCharacteristicsTest.kt deleted file mode 100644 index c4b31b653..000000000 --- a/composeUi/src/desktopTest/kotlin/ScreenCharacteristicsTest.kt +++ /dev/null @@ -1,67 +0,0 @@ -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.requiredSize -import com.darkrockstudios.apps.hammer.common.compose.WindowHeightSizeClass -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass -import androidx.compose.ui.Modifier -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import com.darkrockstudios.apps.hammer.common.compose.LocalScreenCharacteristic -import com.darkrockstudios.apps.hammer.common.compose.ScreenCharacteristics -import com.darkrockstudios.apps.hammer.common.compose.SetScreenCharacteristics -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -private val WideThreshold = 720.dp - -/** - * The size classes must come from the space the UI actually occupies. The desktop - * `calculateWindowSizeClass()` reads an AWT window, which no longer exists under the - * Tao backend, so every window reported Compact. - */ -class ScreenCharacteristicsTest { - - @get:Rule - val compose = createComposeRule() - - private fun characteristicsAt(width: Dp, height: Dp): ScreenCharacteristics { - lateinit var observed: ScreenCharacteristics - compose.setContent { - Box(modifier = Modifier.requiredSize(width, height)) { - SetScreenCharacteristics(WideThreshold) { - observed = LocalScreenCharacteristic.current - } - } - } - compose.waitForIdle() - return observed - } - - @Test - fun `desktop sized window is expanded`() { - val screen = characteristicsAt(1280.dp, 900.dp) - - assertEquals(WindowWidthSizeClass.Expanded, screen.windowWidthClass) - assertEquals(WindowHeightSizeClass.Expanded, screen.windowHeightClass) - assertEquals(true, screen.isWide) - } - - @Test - fun `tablet sized window is medium`() { - val screen = characteristicsAt(700.dp, 600.dp) - - assertEquals(WindowWidthSizeClass.Medium, screen.windowWidthClass) - assertEquals(WindowHeightSizeClass.Medium, screen.windowHeightClass) - assertEquals(false, screen.isWide) - } - - @Test - fun `phone sized window is compact`() { - val screen = characteristicsAt(360.dp, 640.dp) - - assertEquals(WindowWidthSizeClass.Compact, screen.windowWidthClass) - assertEquals(WindowHeightSizeClass.Medium, screen.windowHeightClass) - assertEquals(false, screen.isWide) - } -} diff --git a/composeUi/src/desktopTest/kotlin/SearchFilterTest.kt b/composeUi/src/desktopTest/kotlin/SearchFilterTest.kt deleted file mode 100644 index c5a6982cd..000000000 --- a/composeUi/src/desktopTest/kotlin/SearchFilterTest.kt +++ /dev/null @@ -1,75 +0,0 @@ -import com.darkrockstudios.apps.hammer.base.IdeaId -import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea -import com.darkrockstudios.apps.hammer.common.data.notesrepository.note.NoteContent -import com.darkrockstudios.apps.hammer.common.data.timelinerepository.TimeLineEvent -import com.darkrockstudios.apps.hammer.common.notes.noteMatchesQuery -import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.ideaMatchesQuery -import com.darkrockstudios.apps.hammer.common.timeline.eventMatchesQuery -import org.junit.Test -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.time.Clock -import kotlin.time.Instant - -/** - * Each screen's match predicate, covering which fields it consults and how. A screen matching one of - * its own fields the wrong way is invisible to the shared helper's tests. - * - * These assert the predicates, not the composables that call them; `TimeLineOverviewUiTest` drives a - * screen's search field end to end. - */ -class SearchFilterTest { - - private fun note(content: String) = - NoteContent(id = 1, created = Clock.System.now(), content = content) - - private fun event(content: String, date: String? = null) = - TimeLineEvent(id = 1, order = 0, date = date, content = content) - - private fun idea(content: String, title: String? = null) = StoryIdea( - id = IdeaId("00000000-0000-0000-0000-000000000001"), - created = Instant.parse("2026-07-01T12:00:00Z"), - updated = Instant.parse("2026-07-01T12:00:00Z"), - title = title, - content = content, - archived = null, - ) - - @Test - fun `notes match a query across a stored escape`() { - assertTrue(noteMatchesQuery(note("A well\\-known secret"), "well-known")) - assertFalse(noteMatchesQuery(note("A well\\-known secret"), "unrelated")) - } - - @Test - fun `timeline events match on the body across a stored escape`() { - assertTrue(eventMatchesQuery(event("A well\\-known war"), "well-known")) - } - - @Test - fun `timeline events match on the plain-text date as stored`() { - assertTrue(eventMatchesQuery(event("A long war", date = "1990-2000"), "1990-2000")) - // The date is not Markdown, so it is matched exactly as the user typed it. - assertTrue(eventMatchesQuery(event("A long war", date = "1990\\-2000"), "1990\\-2000")) - } - - @Test - fun `story ideas match on the body across a stored escape`() { - assertTrue(ideaMatchesQuery(idea("A well\\-known twist"), "well-known")) - } - - @Test - fun `story ideas match on the plain-text title`() { - assertTrue(ideaMatchesQuery(idea("body text", title = "The well-known twist"), "well-known")) - assertFalse(ideaMatchesQuery(idea("body text", title = "Something else"), "well-known")) - } - - @Test - fun `literal markup is not rewritten by any screen filter`() { - assertTrue(noteMatchesQuery(note("The cost is 5*4"), "5*4")) - assertTrue(eventMatchesQuery(event("the user_name field"), "user_name")) - // Paired markers are gone from the prose on screen, so typing them finds nothing. - assertFalse(ideaMatchesQuery(idea("a **Chapter** heading"), "**Chapter**")) - assertTrue(ideaMatchesQuery(idea("a **Chapter** heading"), "Chapter heading")) - } -} diff --git a/composeUi/src/desktopTest/kotlin/StoryIdeasRotationTest.kt b/composeUi/src/desktopTest/kotlin/StoryIdeasRotationTest.kt deleted file mode 100644 index b243fc1a1..000000000 --- a/composeUi/src/desktopTest/kotlin/StoryIdeasRotationTest.kt +++ /dev/null @@ -1,55 +0,0 @@ -import androidx.compose.runtime.key -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.ui.test.assertTextEquals -import androidx.compose.ui.test.junit4.createComposeRule -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performTextInput -import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview -import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.IDEAS_EDITOR_TITLE_TAG -import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.StoryIdeasUi -import org.junit.Rule -import org.junit.Test -import kotlin.test.assertEquals - -/** - * Regression cover for #885. An Android configuration change tears the composition down and builds - * it again while the Decompose component (created with `retainedComponent`) lives on, so anything - * the editor keeps in a plain `remember` is gone by the time the new composition runs. - * - * Bumping the `key` below reproduces that half of a rotation: the whole subtree is disposed and - * recomposed against the same component. `androidx.compose.ui.test.StateRestorationTester` would - * be the closer fit, but it is an unimplemented stub on the desktop target. - */ -class StoryIdeasRotationTest : BaseTest() { - - @get:Rule - val compose = createComposeRule() - - @Test - fun `An unsaved draft survives the composition being recreated`() { - val component = FakeStoryIdeas() - component.showCreate() - val epoch = mutableStateOf(0) - var buildCount = 0 - - compose.setContent { - // Koin stays outside the key: its teardown would otherwise race the rebuilt subtree. - KoinApplicationPreview { - key(epoch.value) { - remember { buildCount++ } - StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) - } - } - } - - compose.onNodeWithTag(IDEAS_EDITOR_TITLE_TAG).performTextInput("Tides") - - epoch.value++ - compose.waitForIdle() - - assertEquals(2, buildCount, "The subtree should have been thrown away and built again") - compose.onNodeWithTag(IDEAS_EDITOR_TITLE_TAG).assertTextEquals("Tides") - } -} diff --git a/composeUi/src/desktopTest/kotlin/StoryIdeasTestFixtures.kt b/composeUi/src/desktopTest/kotlin/StoryIdeasTestFixtures.kt deleted file mode 100644 index 5598cee48..000000000 --- a/composeUi/src/desktopTest/kotlin/StoryIdeasTestFixtures.kt +++ /dev/null @@ -1,83 +0,0 @@ -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.base.IdeaId -import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea -import com.darkrockstudios.apps.hammer.common.components.projectselection.storyideas.StoryIdeas -import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import kotlin.time.Instant - -internal fun storyIdea( - uuid: String, - content: String, - title: String? = null, - archived: Boolean = false, -) = StoryIdea( - id = IdeaId(uuid), - created = Instant.parse("2026-07-01T12:00:00Z"), - updated = Instant.parse("2026-07-01T12:00:00Z"), - title = title, - content = content, - archived = if (archived) Instant.parse("2026-07-02T12:00:00Z") else null, -) - -/** - * In-memory stand-in for `StoryIdeasComponent`. It owns the editor draft the same way the real - * component does, which is the whole point: the UI must not keep unsaved text of its own. - */ -internal class FakeStoryIdeas(ideas: List = emptyList()) : StoryIdeas { - private val _state = MutableValue(StoryIdeas.State(ideas = ideas)) - override val state: Value = _state - - var createShownCount = 0 - var editedId: IdeaId? = null - - override fun showCreate() { - createShownCount++ - _state.update { - it.copy(editor = StoryIdeas.Editor.Create, draft = StoryIdeas.Draft(isEditing = true)) - } - } - - override fun editIdea(id: IdeaId) { - editedId = id - val idea = _state.value.ideas.find { it.id == id } ?: return - _state.update { - it.copy( - editor = StoryIdeas.Editor.Edit(idea), - draft = StoryIdeas.Draft( - isEditing = false, - title = idea.title.orEmpty(), - content = idea.content, - tags = idea.tags.toList(), - savedTitle = idea.title, - savedContent = idea.content, - savedTags = idea.tags, - ), - ) - } - } - - override fun closeEditor() = _state.update { it.copy(editor = null) } - override fun suggestTags(prefix: String): List = emptyList() - override fun beginEdit() = updateDraft { it.copy(isEditing = true) } - override fun discardEdit() = updateDraft { it.copy(isEditing = false) } - override fun updateTitle(title: String) = updateDraft { it.copy(title = title) } - override fun updateContent(content: String) = updateDraft { it.copy(content = content) } - override fun updateTags(tags: List) = updateDraft { it.copy(tags = tags) } - override fun updateTagDraft(tagDraft: String) = updateDraft { it.copy(tagDraft = tagDraft) } - override suspend fun saveDraft(): StoryIdeas.SaveResult = StoryIdeas.SaveResult.Saved - override suspend fun deleteIdea(id: IdeaId) {} - override suspend fun archiveIdea(id: IdeaId) {} - override suspend fun unarchiveIdea(id: IdeaId) {} - override suspend fun promoteIdea(id: IdeaId): CResult = - CResult.failure(Exception("fake")) - - private fun updateDraft(transform: (StoryIdeas.Draft) -> StoryIdeas.Draft) { - _state.update { state -> - val draft = state.draft ?: return@update state - state.copy(draft = transform(draft)) - } - } -} diff --git a/composeUi/src/desktopTest/kotlin/StoryIdeasUiTest.kt b/composeUi/src/desktopTest/kotlin/StoryIdeasUiTest.kt index c5697c735..342717d9a 100644 --- a/composeUi/src/desktopTest/kotlin/StoryIdeasUiTest.kt +++ b/composeUi/src/desktopTest/kotlin/StoryIdeasUiTest.kt @@ -3,28 +3,67 @@ import androidx.compose.ui.test.junit4.createComposeRule import androidx.compose.ui.test.onNodeWithTag import androidx.compose.ui.test.onNodeWithText import androidx.compose.ui.test.performClick -import androidx.compose.ui.test.performTextInput +import com.arkivanov.decompose.value.MutableValue +import com.arkivanov.decompose.value.Value import com.darkrockstudios.apps.hammer.base.IdeaId +import com.darkrockstudios.apps.hammer.common.components.projectselection.storyideas.StoryIdeas import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState -import com.darkrockstudios.apps.hammer.common.preview.KoinApplicationPreview +import com.darkrockstudios.apps.hammer.common.data.CResult +import com.darkrockstudios.apps.hammer.common.data.ProjectDef +import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeaError +import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.IDEAS_CREATE_FAB_TAG -import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.IDEAS_EDITOR_TITLE_TAG import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.StoryIdeasUi import com.darkrockstudios.apps.hammer.common.projectselection.storyideas.ideaCardTag import org.junit.Rule import org.junit.Test import kotlin.test.assertEquals +import kotlin.time.Instant class StoryIdeasUiTest : BaseTest() { @get:Rule val compose = createComposeRule() + private class FakeStoryIdeas(ideas: List) : StoryIdeas { + override val state: Value = MutableValue(StoryIdeas.State(ideas = ideas)) + + var createShownCount = 0 + var editedId: IdeaId? = null + + override fun showCreate() { + createShownCount++ + } + + override fun editIdea(id: IdeaId) { + editedId = id + } + + override fun closeEditor() {} + override fun suggestTags(prefix: String): List = emptyList() + override suspend fun createIdea(title: String?, content: String, tags: Set) = IdeaError.NONE + override suspend fun saveIdea(id: IdeaId, title: String?, content: String, tags: Set) = IdeaError.NONE + override suspend fun deleteIdea(id: IdeaId) {} + override suspend fun archiveIdea(id: IdeaId) {} + override suspend fun unarchiveIdea(id: IdeaId) {} + override suspend fun promoteIdea(id: IdeaId): CResult = + CResult.failure(Exception("fake")) + } + + private fun idea(uuid: String, content: String, title: String? = null, archived: Boolean = false) = StoryIdea( + id = IdeaId(uuid), + created = Instant.parse("2026-07-01T12:00:00Z"), + updated = Instant.parse("2026-07-01T12:00:00Z"), + title = title, + content = content, + archived = if (archived) Instant.parse("2026-07-02T12:00:00Z") else null, + ) + @Test fun `Idea cards render title and content`() { val component = FakeStoryIdeas( listOf( - storyIdea("00000000-0000-0000-0000-000000000001", "A courier of dreams", title = "The Courier"), + idea("00000000-0000-0000-0000-000000000001", "A courier of dreams", title = "The Courier"), ) ) @@ -38,12 +77,10 @@ class StoryIdeasUiTest : BaseTest() { @Test fun `FAB opens the create editor`() { - val component = FakeStoryIdeas() + val component = FakeStoryIdeas(emptyList()) compose.setContent { - KoinApplicationPreview { - StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) - } + StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) } compose.onNodeWithTag(IDEAS_CREATE_FAB_TAG).performClick() @@ -54,12 +91,10 @@ class StoryIdeasUiTest : BaseTest() { @Test fun `Clicking a card opens it for editing`() { val uuid = "00000000-0000-0000-0000-000000000002" - val component = FakeStoryIdeas(listOf(storyIdea(uuid, "tap me"))) + val component = FakeStoryIdeas(listOf(idea(uuid, "tap me"))) compose.setContent { - KoinApplicationPreview { - StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) - } + StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) } compose.onNodeWithTag(ideaCardTag(uuid)).performClick() @@ -71,8 +106,8 @@ class StoryIdeasUiTest : BaseTest() { fun `Archived ideas are hidden from the active list`() { val component = FakeStoryIdeas( listOf( - storyIdea("00000000-0000-0000-0000-000000000003", "active spark"), - storyIdea("00000000-0000-0000-0000-000000000004", "archived spark", archived = true), + idea("00000000-0000-0000-0000-000000000003", "active spark"), + idea("00000000-0000-0000-0000-000000000004", "archived spark", archived = true), ) ) @@ -83,20 +118,4 @@ class StoryIdeasUiTest : BaseTest() { compose.onNodeWithText("active spark").assertIsDisplayed() compose.onNodeWithText("archived spark").assertDoesNotExist() } - - @Test - fun `Typing in the editor writes through to the component`() { - val component = FakeStoryIdeas() - component.showCreate() - - compose.setContent { - KoinApplicationPreview { - StoryIdeasUi(component = component, rootSnackbar = rememberRootSnackbarHostState()) - } - } - - compose.onNodeWithTag(IDEAS_EDITOR_TITLE_TAG).performTextInput("Tides") - - assertEquals("Tides", component.state.value.draft?.title) - } } diff --git a/composeUi/src/desktopTest/kotlin/TimeLineOverviewUiTest.kt b/composeUi/src/desktopTest/kotlin/TimeLineOverviewUiTest.kt index 40998d90f..3618c8895 100644 --- a/composeUi/src/desktopTest/kotlin/TimeLineOverviewUiTest.kt +++ b/composeUi/src/desktopTest/kotlin/TimeLineOverviewUiTest.kt @@ -136,42 +136,6 @@ class TimeLineOverviewUiTest : BaseTest() { } */ - @OptIn(ExperimentalTestApi::class, ExperimentalSharedTransitionApi::class) - @Test - fun `Search filters the list on the prose a reader sees`() { - val data = TimeLineOverview.State( - timeLine = TimeLineContainer( - events = listOf( - TimeLineEvent(id = 0, order = 0, date = null, content = "A well\\-known road"), - TimeLineEvent(id = 1, order = 1, date = null, content = "An unrelated event"), - ) - ) - ) - val component = componentSetup(data) - - compose.setContent { - SharedTransitionLayout { - AnimatedVisibility(visible = true) { - TimeLineOverviewUi( - component = component, - scope = scope, - showCreate = {}, - viewEvent = {}, - sharedTransitionScope = this@SharedTransitionLayout, - animatedVisibilityScope = this@AnimatedVisibility, - ) - } - } - } - - compose.onNodeWithContentDescription("Search timeline").performClick() - compose.onNodeWithTag(TIME_LINE_SEARCH_TAG).performTextInput("well-known") - - // The query never contains the stored escape, so only resolving the content can match it. - compose.onAllNodesWithTag(EVENT_CARD_TAG).assertCountEquals(1) - compose.onNodeWithText("An unrelated event").assertDoesNotExist() - } - @OptIn(ExperimentalSharedTransitionApi::class) @Test fun `Event Card Click`() { diff --git a/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/MatchesShortcutTest.kt b/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/MatchesShortcutTest.kt deleted file mode 100644 index bb108e5ab..000000000 --- a/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/MatchesShortcutTest.kt +++ /dev/null @@ -1,91 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.foundation.focusable -import androidx.compose.foundation.layout.Box -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.remember -import androidx.compose.ui.Modifier -import androidx.compose.ui.ExperimentalComposeUiApi -import androidx.compose.ui.focus.FocusRequester -import androidx.compose.ui.focus.focusRequester -import androidx.compose.ui.input.key.Key -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.test.ExperimentalTestApi -import androidx.compose.ui.test.onNodeWithTag -import androidx.compose.ui.test.performKeyInput -import androidx.compose.ui.test.pressKey -import androidx.compose.ui.test.runComposeUiTest -import androidx.compose.ui.test.withKeyDown -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -@OptIn(ExperimentalTestApi::class, ExperimentalComposeUiApi::class) -class MatchesShortcutTest { - - private fun shortcutFirings( - shortcut: Modifier.(onFired: () -> Unit) -> Modifier, - press: androidx.compose.ui.test.KeyInjectionScope.() -> Unit, - ): Int { - var fired = 0 - runComposeUiTest { - setContent { - val focusRequester = remember { FocusRequester() } - Box( - Modifier - .testTag("root") - .focusRequester(focusRequester) - .focusable() - .shortcut { fired++ } - ) - LaunchedEffect(Unit) { focusRequester.requestFocus() } - } - onNodeWithTag("root").performKeyInput(press) - } - return fired - } - - @Test - fun `bare F3 fires the sync shortcut`() { - assertEquals(1, shortcutFirings({ onKeyShortcut(Key.F3, action = it) }) { pressKey(Key.F3) }) - } - - @Test - fun `F3 with an extra modifier does not fire`() { - assertEquals( - 0, - shortcutFirings({ onKeyShortcut(Key.F3, action = it) }) { - withKeyDown(Key.CtrlLeft) { pressKey(Key.F3) } - }, - ) - assertEquals( - 0, - shortcutFirings({ onKeyShortcut(Key.F3, action = it) }) { - withKeyDown(Key.ShiftLeft) { pressKey(Key.F3) } - }, - ) - } - - @Test - fun `ctrl shift S fires save all`() { - assertEquals( - 1, - shortcutFirings({ onKeyShortcut(Key.S, ctrl = true, shift = true, action = it) }) { - withKeyDown(Key.CtrlLeft) { withKeyDown(Key.ShiftLeft) { pressKey(Key.S) } } - }, - ) - } - - @Test - fun `AltGr shift S does not fire save all`() { - assertEquals( - 0, - shortcutFirings({ onKeyShortcut(Key.S, ctrl = true, shift = true, action = it) }) { - withKeyDown(Key.CtrlLeft) { - withKeyDown(Key.AltLeft) { - withKeyDown(Key.ShiftLeft) { pressKey(Key.S) } - } - } - }, - ) - } -} diff --git a/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHostTest.kt b/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHostTest.kt deleted file mode 100644 index 94da80192..000000000 --- a/composeUi/src/desktopTest/kotlin/com/darkrockstudios/apps/hammer/common/compose/ProjectShortcutHostTest.kt +++ /dev/null @@ -1,41 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class ProjectShortcutHostTest { - - @Test - fun `unbound host reports the key as unhandled`() { - val host = ProjectShortcutHost() - - assertFalse(host.startProjectSync()) - assertFalse(host.saveAllBuffers()) - } - - @Test - fun `bound host runs the actions and claims the key`() { - var syncs = 0 - var saves = 0 - val host = ProjectShortcutHost() - host.bind(startSync = { syncs++ }, saveAll = { saves++ }) - - assertTrue(host.startProjectSync()) - assertTrue(host.saveAllBuffers()) - assertEquals(1, syncs) - assertEquals(1, saves) - } - - @Test - fun `unbinding stops the actions running`() { - var syncs = 0 - val host = ProjectShortcutHost() - host.bind(startSync = { syncs++ }, saveAll = {}) - host.unbind() - - assertFalse(host.startProjectSync()) - assertEquals(0, syncs) - } -} diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/MainViewController.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/MainViewController.kt index 740c05028..fccae15f4 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/MainViewController.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/MainViewController.kt @@ -7,7 +7,6 @@ import androidx.compose.runtime.getValue import androidx.compose.ui.window.ComposeUIViewController import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.common.components.iosroot.IosRoot -import com.darkrockstudios.apps.hammer.common.compose.ProjectShortcutHost import com.darkrockstudios.apps.hammer.common.compose.rememberKoinInject import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore @@ -16,15 +15,12 @@ import com.darkrockstudios.apps.hammer.common.projectroot.ProjectRootScaffold import com.darkrockstudios.apps.hammer.common.projectselection.ProjectSelectScaffold import platform.UIKit.UIViewController -// shortcutHost is owned by the Swift container: UIKit key commands are the only key hook that -// does not depend on what Compose has focused, and Kotlin cannot override that category member. -fun MainViewController(root: IosRoot, shortcutHost: ProjectShortcutHost): UIViewController = - ComposeUIViewController { - HammerApp(root, shortcutHost) - } +fun MainViewController(root: IosRoot): UIViewController = ComposeUIViewController { + HammerApp(root) +} @Composable -private fun HammerApp(root: IosRoot, shortcutHost: ProjectShortcutHost) { +private fun HammerApp(root: IosRoot) { val globalSettingsStore: GlobalSettingsStore = rememberKoinInject() val settingsState by globalSettingsStore.globalSettingsUpdates .collectAsState(initial = globalSettingsStore.globalSettings) @@ -32,7 +28,7 @@ private fun HammerApp(root: IosRoot, shortcutHost: ProjectShortcutHost) { val systemDark = isSystemInDarkTheme() val isDark = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> systemDark } @@ -46,7 +42,6 @@ private fun HammerApp(root: IosRoot, shortcutHost: ProjectShortcutHost) { ProjectRootScaffold( component = destination.component, onCloseRequest = { root.closeProject() }, - shortcutHost = shortcutHost, ) null -> Unit diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.ios.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.ios.kt deleted file mode 100644 index 8d006cb8b..000000000 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ClipboardCopier.ios.kt +++ /dev/null @@ -1,9 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose - -import androidx.compose.runtime.Composable -import platform.UIKit.UIPasteboard - -@Composable -actual fun rememberClipboardCopier(): (String) -> Unit = { text -> - UIPasteboard.generalPasteboard.string = text -} diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt index 726847387..a06aeb804 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/MpScrollBar.kt @@ -1,15 +1,8 @@ package com.darkrockstudios.apps.hammer.common.compose -import androidx.compose.foundation.ScrollState import androidx.compose.foundation.lazy.LazyListState -import androidx.compose.foundation.lazy.grid.LazyGridState -import androidx.compose.foundation.lazy.staggeredgrid.LazyStaggeredGridState import androidx.compose.runtime.Composable import androidx.compose.ui.Modifier -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp - -actual val MpScrollBarGutter: Dp = 0.dp @Composable actual fun MpScrollBarList( @@ -18,27 +11,3 @@ actual fun MpScrollBarList( ) { // iOS shows inline scroll indicators natively; no explicit scrollbar composable needed. } - -@Composable -actual fun MpScrollBarColumn( - modifier: Modifier, - state: ScrollState -) { - // iOS shows inline scroll indicators natively; no explicit scrollbar composable needed. -} - -@Composable -actual fun MpScrollBarGrid( - modifier: Modifier, - state: LazyGridState -) { - // iOS shows inline scroll indicators natively; no explicit scrollbar composable needed. -} - -@Composable -actual fun MpScrollBarStaggeredGrid( - modifier: Modifier, - state: LazyStaggeredGridState -) { - // iOS shows inline scroll indicators natively; no explicit scrollbar composable needed. -} diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt new file mode 100644 index 000000000..c73f45bdd --- /dev/null +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/Resources.kt @@ -0,0 +1,8 @@ +package com.darkrockstudios.apps.hammer.common.compose + +import androidx.compose.runtime.Composable +import androidx.compose.ui.graphics.painter.Painter + +@Composable +actual fun painterResource(res: String, drawableKlass: Any?): Painter = + error("String-based painterResource is not supported on iOS; use org.jetbrains.compose.resources.painterResource(DrawableResource) instead") diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt deleted file mode 100644 index 9257fe121..000000000 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/designsystem/HorizontalResizePointerIcon.kt +++ /dev/null @@ -1,5 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.designsystem - -import androidx.compose.ui.input.pointer.PointerIcon - -actual fun horizontalResizePointerIcon(): PointerIcon = PointerIcon.Default diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt index ec93612e5..b45fab864 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/markdowneditor/EditorAction.kt @@ -20,20 +20,19 @@ import com.darkrockstudios.apps.hammer.common.compose.Ui internal actual fun EditorAction( icon: ImageVector, active: Boolean, - enabled: Boolean, onClick: () -> Unit ) { val painter = rememberVectorPainter(icon) Box( modifier = Modifier - .clickable(enabled = enabled) { onClick() } + .clickable { onClick() } .padding(Ui.Padding.L) ) { Icon( modifier = Modifier.size(24.dp), painter = painter, - tint = editorActionColor(active, enabled), + tint = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, contentDescription = null ) } @@ -43,12 +42,11 @@ internal actual fun EditorAction( internal actual fun EditorTextAction( label: String, active: Boolean, - enabled: Boolean, onClick: () -> Unit, ) { Box( modifier = Modifier - .clickable(enabled = enabled) { onClick() } + .clickable { onClick() } .padding(Ui.Padding.L) .defaultMinSize(minWidth = 24.dp, minHeight = 24.dp), contentAlignment = Alignment.Center, @@ -56,7 +54,7 @@ internal actual fun EditorTextAction( Text( text = label, style = MaterialTheme.typography.labelLarge, - color = editorActionColor(active, enabled), + color = if (active) MaterialTheme.colorScheme.inversePrimary else MaterialTheme.colorScheme.onSurfaceVariant, ) } } diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.ios.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.ios.kt deleted file mode 100644 index dedca9705..000000000 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/theme/OledBlackAvailability.ios.kt +++ /dev/null @@ -1,3 +0,0 @@ -package com.darkrockstudios.apps.hammer.common.compose.theme - -actual val oledBlackThemeAvailable: Boolean = true diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt index 778d6d5ca..66b88b534 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projecthome/ExportDirectoryPicker.kt @@ -3,21 +3,15 @@ package com.darkrockstudios.apps.hammer.common.projecthome import androidx.compose.runtime.Composable import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue +import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.common.components.projecthome.ProjectHome import com.darkrockstudios.apps.hammer.common.compose.rememberDefaultDispatcher -import com.darkrockstudios.apps.hammer.common.data.ExportOptions -import com.darkrockstudios.apps.hammer.project_home_action_export_toast_failure import com.darkrockstudios.apps.hammer.project_home_action_export_toast_success -import io.github.aakira.napier.Napier import io.github.vinceglb.filekit.dialogs.compose.rememberDirectoryPickerLauncher import io.github.vinceglb.filekit.path import io.github.vinceglb.filekit.startAccessingSecurityScopedResource import io.github.vinceglb.filekit.stopAccessingSecurityScopedResource -import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.launch @@ -28,27 +22,19 @@ actual fun ExportDirectoryPicker( scope: CoroutineScope, ) { val defaultDispatcher = rememberDefaultDispatcher() - // Snapshot of the confirmed options taken when the picker launches; the picker - // does not block the app, so options must not be re-read afterwards. - var confirmedOptions by remember { mutableStateOf(null) } + val state by component.state.subscribeAsState() val directoryPickerLauncher = rememberDirectoryPickerLauncher { directory -> - val options = confirmedOptions - if (directory != null && options != null) { + if (directory != null) { + val options = state.exportOptions scope.launch(defaultDispatcher) { // FileKit's absolutePath() returns nsUrl.absoluteString (with "file://" scheme), which okio's // posix sink can't open — use .path for the bare filesystem path. UIDocumentPicker URLs are // security-scoped, so writes outside the sandbox require start/stopAccessingSecurityScopedResource. val accessGranted = directory.startAccessingSecurityScopedResource() - // A renderer failure must surface as a toast; an uncaught throw here takes down the app. try { component.exportProject(directory.path, options) component.showToast(Res.string.project_home_action_export_toast_success) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - Napier.e("Story export failed", e) - component.showToast(Res.string.project_home_action_export_toast_failure) } finally { if (accessGranted) directory.stopAccessingSecurityScopedResource() } @@ -60,7 +46,6 @@ actual fun ExportDirectoryPicker( LaunchedEffect(show) { if (show) { - confirmedOptions = component.state.value.exportOptions directoryPickerLauncher.launch() } } diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.ios.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.ios.kt index 8537ff134..a43aa79fe 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.ios.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/projectselection/about/PlatformAboutSection.ios.kt @@ -1,18 +1,11 @@ package com.darkrockstudios.apps.hammer.common.projectselection.about -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.ExperimentalLayoutApi -import androidx.compose.foundation.layout.FlowRow -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.rememberCoroutineScope import androidx.compose.runtime.setValue -import androidx.compose.ui.unit.dp import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.about_logs_export_button @@ -43,43 +36,27 @@ import platform.UIKit.popoverPresentationController import platform.darwin.dispatch_async import platform.darwin.dispatch_get_main_queue -@OptIn(ExperimentalLayoutApi::class) @Composable actual fun PlatformAboutSection(component: AboutApp, section: Int) { val scope = rememberCoroutineScope() val state by component.state.subscribeAsState() var exporting by remember { mutableStateOf(false) } - var status by remember { mutableStateOf(null) } HdHairlineSection( section = section, title = Res.string.about_logs_header.get(), ) { - Column(verticalArrangement = Arrangement.spacedBy(14.dp)) { - FlowRow( - horizontalArrangement = Arrangement.spacedBy(12.dp), - verticalArrangement = Arrangement.spacedBy(12.dp), - ) { - HdHairlineButton( - label = Res.string.about_logs_export_button.get(), - onClick = { - if (exporting) return@HdHairlineButton - exporting = true - scope.launch { - exportAndShareLogs(state.logDirectoryPath) - exporting = false - } - }, - ) - CopyDiagnosticsButton( - logDirectoryPath = state.logDirectoryPath, - onStatus = { status = it }, - ) - } - status?.let { - Text(text = it, style = MaterialTheme.typography.bodySmall) - } - } + HdHairlineButton( + label = Res.string.about_logs_export_button.get(), + onClick = { + if (exporting) return@HdHairlineButton + exporting = true + scope.launch { + exportAndShareLogs(state.logDirectoryPath) + exporting = false + } + }, + ) } } diff --git a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt index c12edfce8..c7a67e780 100644 --- a/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt +++ b/composeUi/src/iosMain/kotlin/com/darkrockstudios/apps/hammer/common/storyeditor/sceneeditor/EditorTopBar.kt @@ -9,14 +9,13 @@ import androidx.compose.foundation.layout.statusBars import androidx.compose.foundation.layout.width import androidx.compose.foundation.layout.windowInsetsPadding import androidx.compose.material.icons.Icons -import androidx.compose.material.icons.automirrored.filled.MenuBook import androidx.compose.material.icons.filled.Fullscreen import androidx.compose.material.icons.filled.Info import androidx.compose.material.icons.filled.Save import androidx.compose.material3.Icon import androidx.compose.material3.IconButton import androidx.compose.material3.MaterialTheme -import com.darkrockstudios.apps.hammer.common.compose.WindowWidthSizeClass +import androidx.compose.material3.windowsizeclass.WindowWidthSizeClass import androidx.compose.runtime.Composable import androidx.compose.runtime.derivedStateOf import androidx.compose.runtime.getValue @@ -44,7 +43,6 @@ import com.darkrockstudios.apps.hammer.common.compose.resources.get import com.darkrockstudios.apps.hammer.common.storyeditor.sceneTypeMeta import com.darkrockstudios.apps.hammer.scene_editor_cancel_button import com.darkrockstudios.apps.hammer.scene_editor_focus_mode_button -import com.darkrockstudios.apps.hammer.scene_editor_menu_item_read import com.darkrockstudios.apps.hammer.scene_editor_metadata_button import com.darkrockstudios.apps.hammer.scene_editor_name_hint import com.darkrockstudios.apps.hammer.scene_editor_rename_button @@ -113,16 +111,6 @@ actual fun EditorTopBar( } } - if (screen.windowWidthClass != WindowWidthSizeClass.Compact) { - IconButton(onClick = component::readScene) { - Icon( - imageVector = Icons.AutoMirrored.Filled.MenuBook, - contentDescription = Res.string.scene_editor_menu_item_read.get(), - tint = MaterialTheme.colorScheme.onSurface - ) - } - } - if (screen.windowWidthClass == WindowWidthSizeClass.Expanded) { IconButton(onClick = component::enterFocusMode) { Icon( diff --git a/crowdin.yml b/crowdin.yml index a6b5af6f8..05c253fc5 100644 --- a/crowdin.yml +++ b/crowdin.yml @@ -1,11 +1,6 @@ project_id_env: CROWDIN_PROJECT_ID api_token_env: CROWDIN_PERSONAL_TOKEN -# Crowdin's default commit message carries [ci skip], which stops Build CI from -# running on the translation PRs. Supplying a message replaces the default. -commit_message: "New translations from Crowdin" -append_commit_message: false - files: # Not strings*.xml: Crowdin's * requires at least one character, so that # pattern silently skips strings.xml itself. This directory only ever holds @@ -14,10 +9,6 @@ files: translation: /common/src/commonMain/composeResources/values-%android_code%/%original_file_name% translate_attributes: 0 content_segmentation: 0 - # Every file here must be named *_android.xml. The Crowdin post-export - # processor unescapes quotes for the Compose resources and only skips files - # with that suffix, and it sees file names, not paths. AAPT rejects an - # unescaped apostrophe, so a file without the suffix breaks the Android build. - source: /android/src/main/res/values/strings*.xml translation: /android/src/main/res/values-%android_code%/%original_file_name% translate_attributes: 0 diff --git a/desktop/build.gradle.kts b/desktop/build.gradle.kts index 866fb29f1..e33c72b5d 100644 --- a/desktop/build.gradle.kts +++ b/desktop/build.gradle.kts @@ -1,5 +1,3 @@ -import com.darkrockstudios.build.DistributionChannel -import com.darkrockstudios.build.distributionChannel import com.darkrockstudios.build.registerLinuxDistributionTasks import org.jetbrains.compose.desktop.application.dsl.TargetFormat import java.util.zip.ZipFile @@ -18,8 +16,9 @@ plugins { group = "com.darkrockstudios.apps.hammer.desktop" version = libs.versions.app.get() -// -Pchannel=mac-app-store -PbuildNumber=N enables App Store packaging. -val isAppStoreRelease: Boolean = project.distributionChannel() == DistributionChannel.MAC_APP_STORE +// -PmacOsAppStoreRelease=true -PbuildNumber=N enables App Store packaging. +val isAppStoreRelease: Boolean = + (project.findProperty("macOsAppStoreRelease") as String?)?.toBoolean() ?: false val macBuildNumber: String = (project.findProperty("buildNumber") as String?) ?: "1" @@ -34,6 +33,7 @@ configurations.all { kotlin { jvmToolchain { languageVersion.set(JavaLanguageVersion.of(libs.versions.jvm.get().toInt())) + vendor.set(JvmVendorSpec.JETBRAINS) } jvm() sourceSets { @@ -58,16 +58,14 @@ kotlin { implementation(project(":composeUi")) implementation(libs.jetbrains.compose.components.ui.tooling.preview) implementation(compose.desktop.currentOs) - implementation(libs.cairn) implementation(libs.clikt) implementation(libs.nucleus.darkmode.detector) - implementation(libs.nucleus.application) - implementation(libs.nucleus.decorated.window.tao) + implementation(libs.nucleus.decorated.window.jbr) implementation(libs.nucleus.decorated.window.material3) implementation(libs.nucleus.launcher.windows) implementation(libs.nucleus.launcher.linux) implementation(libs.nucleus.launcher.macos) - implementation(libs.nucleus.updater.runtime) + implementation(libs.splashify) } } val jvmTest by getting { @@ -79,15 +77,15 @@ kotlin { } } -// Pin jpackage's bundled runtime to the project's toolchain JDK rather than -// whichever JVM happens to be running Gradle. -val packagingLauncher = javaToolchains.launcherFor { +// Pin jpackage's bundled runtime to the JetBrains Runtime. +val jbrLauncher = javaToolchains.launcherFor { languageVersion.set(JavaLanguageVersion.of(libs.versions.jvm.get().toInt())) + vendor.set(JvmVendorSpec.JETBRAINS) } compose.desktop { application { - javaHome = packagingLauncher.get().metadata.installationPath.asFile.absolutePath + javaHome = jbrLauncher.get().metadata.installationPath.asFile.absolutePath mainClass = "com.darkrockstudios.apps.hammer.desktop.MainKt" nativeDistributions { targetFormats( @@ -113,10 +111,6 @@ compose.desktop { menuGroup = "Hammer" shortcut = true console = false - // Thar be dragons: this is the MSI UpgradeCode every installed copy carries. jpackage - // derived it from vendor + name; it is pinned so a renamed package or an added vendor - // can never make a new MSI install beside the old one instead of over it. - upgradeUuid = "BA26F056-C16C-38AF-BD48-C993BEAFBE7A" iconFile.set(project.file("icons/windows.ico")) } @@ -160,6 +154,7 @@ compose.desktop { } jvmArgs("-Dcompose.application.configure.swing.globals=false") if (isAppStoreRelease) { + jvmArgs("-Dhammer.app.store=true") // Load libjnidispatch.jnilib from Contents/app/resources/, never extract. jvmArgs("-Djna.nounpack=true", "-Djna.nosys=true") // Lets Nucleus' System.loadLibrary find our pre-bundled signed dylibs @@ -198,15 +193,10 @@ val extractMacosNativeLibs = tasks.register("extractMacosNativeLibs") { val nativeLibs = listOf( Triple("net.java.dev.jna", "jna", "com/sun/jna/darwin-aarch64/libjnidispatch.jnilib"), - Triple("dev.nucleusframework", "nucleus.launcher-macos", "nucleus/native/darwin-aarch64/libnucleus_launcher_macos.dylib"), - Triple("dev.nucleusframework", "nucleus.darkmode-detector", "nucleus/native/darwin-aarch64/libnucleus_darkmode.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-core", "nucleus/native/darwin-aarch64/libnucleus_layout_direction.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao_dnd.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao_macos_deco.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao_macos_native_view.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao_macos_popup.dylib"), - Triple("dev.nucleusframework", "nucleus.decorated-window-tao", "nucleus/native/darwin-aarch64/libnucleus_tao_metal.dylib"), + Triple("io.github.kdroidfilter", "nucleus.launcher-macos", "nucleus/native/darwin-aarch64/libnucleus_launcher_macos.dylib"), + Triple("io.github.kdroidfilter", "nucleus.darkmode-detector", "nucleus/native/darwin-aarch64/libnucleus_darkmode.dylib"), + Triple("io.github.kdroidfilter", "nucleus.decorated-window-core", "nucleus/native/darwin-aarch64/libnucleus_layout_direction.dylib"), + Triple("io.github.kdroidfilter", "nucleus.decorated-window-jbr", "nucleus/native/darwin-aarch64/libnucleus_macos.dylib"), ) val runtime = configurations.named("jvmRuntimeClasspath") @@ -244,26 +234,7 @@ val compileMacosBookmarksLib = tasks.register("compileMacosBookmarksLib") { val outDir = layout.buildDirectory.dir("macos-native-libs/macos").get().asFile val outFile = outDir.resolve("libhammer_bookmarks.dylib") - // Declared as an input so a flags-only edit — another framework, a version-min - // bump — reruns the task instead of leaving a stale dylib UP-TO-DATE for - // signMacAppResources to sign into the bundle. The absolute -o and source - // paths stay out of it; inputs.file/outputs.file already cover those, and - // baking them in would make the fingerprint machine-specific. - val clangArgs = listOf( - "-dynamiclib", - "-fobjc-arc", - "-O2", - "-arch", "arm64", - "-mmacosx-version-min=12.0", - "-framework", "Foundation", - // AppKit backs the first-run folder picker and its alerts, which - // must be native — AWT would claim NSApp and wedge the Tao loop. - "-framework", "AppKit", - "-install_name", "@rpath/libhammer_bookmarks.dylib", - ) - inputs.file(src).withPropertyName("source").withPathSensitivity(PathSensitivity.RELATIVE) - inputs.property("clangArgs", clangArgs) outputs.file(outFile) val execOps = project.providers @@ -271,7 +242,17 @@ val compileMacosBookmarksLib = tasks.register("compileMacosBookmarksLib") { outDir.mkdirs() execOps.exec { executable = "clang" - args(clangArgs + listOf("-o", outFile.absolutePath, src.absolutePath)) + args( + "-dynamiclib", + "-fobjc-arc", + "-O2", + "-arch", "arm64", + "-mmacosx-version-min=12.0", + "-framework", "Foundation", + "-install_name", "@rpath/libhammer_bookmarks.dylib", + "-o", outFile.absolutePath, + src.absolutePath + ) }.result.get() logger.lifecycle("Compiled ${outFile.name}") } diff --git a/desktop/macos-native/HammerBookmarks.m b/desktop/macos-native/HammerBookmarks.m index 86af6e960..a6a117481 100644 --- a/desktop/macos-native/HammerBookmarks.m +++ b/desktop/macos-native/HammerBookmarks.m @@ -9,20 +9,13 @@ * security-scoped bookmark (NSURL bookmarkData with the security-scope * option) and resolve it at startup. * - * This dylib exposes C functions JNA can call. Strings returned by - * create/resolve/pick are heap-allocated and must be freed via + * This dylib exposes 4 C functions JNA can call. Strings returned by + * create/resolve are heap-allocated and must be freed via * hammer_bookmark_free_string. Resolved NSURLs are retained internally * so stop_access can find them by path without the caller round-tripping * the NSURL pointer. - * - * It also hosts the first-run folder picker and its alerts. Those are - * deliberately native rather than AWT/Swing: they run before the Compose - * application starts, and initializing AWT first permanently wedges the - * Tao backend's event loop (see hammer_dialog_pick_directory). */ #import -#import -#include #include #include @@ -122,106 +115,3 @@ void hammer_bookmark_stop(const char *path) { void hammer_bookmark_free_string(const char *s) { if (s != NULL) free((void *) s); } - -#pragma mark - First-run dialogs - -/* - * AppKit refuses to instantiate an NSWindow anywhere but thread 0, and both - * dialogs below are NSWindows underneath. The JVM's `main` thread is not - * thread 0 — on macOS the java launcher runs main on a pthread of its own - * (JavaMain/ThreadJavaMain) and parks thread 0 in a CFRunLoop, which is what - * makes AppKit usable at all. So we hop onto the main queue and block until - * the user answers. That parked run loop is what services the queue; without - * it this dispatch_sync would deadlock rather than return. - */ -static void run_on_main_sync(dispatch_block_t block) { - if (pthread_main_np()) { - block(); - } else { - dispatch_sync(dispatch_get_main_queue(), block); - } -} - -/* - * NSAlert and NSOpenPanel need an NSApplication instance and a foreground - * activation policy to appear and take keyboard focus. Creating NSApp is all - * we do — the main run loop is left untouched so the Tao backend can claim it - * once startup finishes. (Letting AWT create NSApp instead is what breaks Tao: - * AWT parks the AppKit run loop on its own thread, and Tao's loop on the main - * thread then never receives events, so the app hangs with no window.) - */ -static void ensure_app(void) { - [NSApplication sharedApplication]; - [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular]; - [NSApp activateIgnoringOtherApps:YES]; -} - -static NSString *ns_or_nil(const char *s) { - return s == NULL ? nil : [NSString stringWithUTF8String:s]; -} - -/* - * Modal two-button alert. Returns 1 when the user chose the primary button - * and 0 for the secondary button. - */ -int hammer_dialog_confirm(const char *title, - const char *message, - const char *primaryButton, - const char *secondaryButton) { - __block int result = 0; - run_on_main_sync(^{ - @autoreleasepool { - ensure_app(); - NSAlert *alert = [[NSAlert alloc] init]; - alert.alertStyle = NSAlertStyleInformational; - NSString *t = ns_or_nil(title); - NSString *m = ns_or_nil(message); - if (t != nil) alert.messageText = t; - if (m != nil) alert.informativeText = m; - NSString *primary = ns_or_nil(primaryButton); - NSString *secondary = ns_or_nil(secondaryButton); - if (primary != nil) [alert addButtonWithTitle:primary]; - if (secondary != nil) [alert addButtonWithTitle:secondary]; - // Buttons come back in the order added, starting at NSAlertFirstButtonReturn. - result = ([alert runModal] == NSAlertFirstButtonReturn) ? 1 : 0; - } - }); - return result; -} - -/* - * Modal directory chooser. Returns the selected path (caller frees via - * hammer_bookmark_free_string) or NULL if the user cancelled. - * - * Under the sandbox this is the Powerbox panel, and it is the only thing that - * can widen our file access — picking here is what makes the subsequent - * hammer_bookmark_create call succeed. - */ -const char *hammer_dialog_pick_directory(const char *title, - const char *message, - const char *prompt) { - __block char *result = NULL; - run_on_main_sync(^{ - @autoreleasepool { - ensure_app(); - NSOpenPanel *panel = [NSOpenPanel openPanel]; - panel.canChooseFiles = NO; - panel.canChooseDirectories = YES; - panel.allowsMultipleSelection = NO; - panel.canCreateDirectories = YES; - NSString *t = ns_or_nil(title); - NSString *m = ns_or_nil(message); - NSString *p = ns_or_nil(prompt); - if (t != nil) panel.title = t; - if (m != nil) panel.message = m; - if (p != nil) panel.prompt = p; - // Deliberately no directoryURL: NSHomeDirectory() is the sandbox - // container, and the panel already defaults to the real ~/Documents. - if ([panel runModal] != NSModalResponseOK) return; - NSURL *url = panel.URL; - if (url == nil) return; - result = copy_cstring([url path]); - } - }); - return result; -} diff --git a/desktop/proguard-rules.pro b/desktop/proguard-rules.pro index ca6a1ecf5..8ff2e171a 100644 --- a/desktop/proguard-rules.pro +++ b/desktop/proguard-rules.pro @@ -58,22 +58,15 @@ # NUCLEUS LAUNCHER (JNI bridge classes — JNI invokes static on*(...) callbacks) # Windows launcher ships its own keep rules via the Nucleus Gradle plugin. ################################################################################ --keep class dev.nucleusframework.launcher.linux.NativeLinuxLauncherBridge { +-keep class io.github.kdroidfilter.nucleus.launcher.linux.NativeLinuxLauncherBridge { native ; static ** on*(...); } --keep class dev.nucleusframework.launcher.macos.NativeMacOsDockMenuBridge { +-keep class io.github.kdroidfilter.nucleus.launcher.macos.NativeMacOsDockMenuBridge { native ; static ** on*(...); } -################################################################################ -# NUCLEUS TAO BACKEND (native window layer: JNI bridges call back into these, -# and the Tao main dispatcher is discovered reflectively via ServiceLoader) -################################################################################ --keep class dev.nucleusframework.window.tao.** { *; } --keep class kotlinx.coroutines.internal.MainDispatcherFactory - ################################################################################ # LIBRARIES (Broad Keeps for Stability) ################################################################################ @@ -91,14 +84,6 @@ ################################################################################ -keep class * implements org.slf4j.spi.SLF4JServiceProvider { *; } -################################################################################ -# COMMONS-LOGGING (PDFBox, used by PDF export) -# LogFactory resolves its implementation by name, so the shrinker sees no -# reference to LogFactoryImpl and drops it. PDDocument's static init then dies. -################################################################################ --keep class org.apache.commons.logging.** { *; } --dontwarn org.apache.commons.logging.** - ################################################################################ # CLEANUP & WARNING SUPPRESSION ################################################################################ diff --git a/desktop/scripts/build-appstore.sh b/desktop/scripts/build-appstore.sh index e5e878ad9..fbbdc57a7 100755 --- a/desktop/scripts/build-appstore.sh +++ b/desktop/scripts/build-appstore.sh @@ -62,7 +62,8 @@ fi echo "→ Building Hammer for the Mac App Store (build #$BUILD_NUMBER)" ./gradlew --stop -./gradlew :desktop:packageReleasePkg -Pchannel=mac-app-store -Pformat=pkg \ +./gradlew :desktop:packageReleasePkg \ + -PmacOsAppStoreRelease=true \ -PbuildNumber="$BUILD_NUMBER" \ --no-daemon diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ConfirmCloseDialogs.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ConfirmCloseDialogs.kt index 65c03ac11..d260dc184 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ConfirmCloseDialogs.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ConfirmCloseDialogs.kt @@ -48,7 +48,7 @@ internal fun confirmCloseUnsavedEncyclopediaDialog( SimpleConfirm( title = Res.string.unsaved_encyclopedia_dialog_title.get(), message = Res.string.unsaved_encyclopedia_dialog_message.get(), - positiveButton = discardButtonText(closeType), + positiveButton = Res.string.unsaved_dialog_positive_button.get(), negativeButton = Res.string.unsaved_dialog_negative_button.get(), onDismiss = { /* Noop */ }, onNegative = { @@ -70,7 +70,7 @@ internal fun confirmCloseUnsavedTimelineDialog( SimpleConfirm( title = Res.string.unsaved_timeline_dialog_title.get(), message = Res.string.unsaved_timeline_dialog_message.get(), - positiveButton = discardButtonText(closeType), + positiveButton = Res.string.unsaved_dialog_positive_button.get(), negativeButton = Res.string.unsaved_dialog_negative_button.get(), onDismiss = { /* Noop */ }, onNegative = { @@ -92,7 +92,7 @@ internal fun confirmCloseUnsavedNotesDialog( SimpleConfirm( title = Res.string.unsaved_notes_dialog_title.get(), message = Res.string.unsaved_notes_dialog_message.get(), - positiveButton = discardButtonText(closeType), + positiveButton = Res.string.unsaved_dialog_positive_button.get(), negativeButton = Res.string.unsaved_dialog_negative_button.get(), onDismiss = { /* Noop */ }, onNegative = { @@ -103,12 +103,3 @@ internal fun confirmCloseUnsavedNotesDialog( } ) } - -/** "Discard and close" while a window close is pending, plain "Discard" for a sync gate. */ -@Composable -private fun discardButtonText(closeType: ApplicationState.CloseType): String = - if (closeType == ApplicationState.CloseType.None) { - Res.string.unsaved_entity_dialog_negative_button.get() - } else { - Res.string.unsaved_dialog_positive_button.get() - } diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/Main.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/Main.kt index 0ec69e553..6ee2e2852 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/Main.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/Main.kt @@ -4,16 +4,16 @@ import androidx.compose.material.ExperimentalMaterialApi import androidx.compose.runtime.ExperimentalComposeApi import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue +import androidx.compose.ui.window.ApplicationScope +import androidx.compose.ui.window.application import coil3.ImageLoader import coil3.compose.setSingletonImageLoaderFactory -import com.arkivanov.decompose.DecomposeSettings import com.arkivanov.decompose.ExperimentalDecomposeApi import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.arkivanov.decompose.value.MutableValue import com.arkivanov.decompose.value.getAndUpdate +import com.darkrockstudios.apps.hammer.base.BuildMetadata import com.darkrockstudios.apps.hammer.common.AppCloseManager import com.darkrockstudios.apps.hammer.common.compose.getDefaultDispatcher import com.darkrockstudios.apps.hammer.common.compose.getMainDispatcher @@ -31,23 +31,20 @@ import com.darkrockstudios.apps.hammer.common.dependencyinjection.mainModule import com.darkrockstudios.apps.hammer.common.getInDevelopmentMode import com.darkrockstudios.apps.hammer.common.getLogDirectory import com.darkrockstudios.apps.hammer.common.logStartupBanner -import com.darkrockstudios.apps.hammer.common.startupBanner +import com.darkrockstudios.apps.hammer.common.platformStartupInfo import com.darkrockstudios.apps.hammer.common.setInDevelopmentMode import com.darkrockstudios.apps.hammer.desktop.aboutlibraries.aboutLibrariesModule import com.darkrockstudios.apps.hammer.desktop.sandbox.SandboxStartup import com.darkrockstudios.apps.hammer.desktop.shortcuts.QuickShortcuts -import dev.nucleusframework.application.NucleusApplicationScope -import dev.nucleusframework.application.NucleusBackend -import dev.nucleusframework.application.nucleusApplication -import dev.nucleusframework.darkmodedetector.isSystemInDarkMode -import dev.nucleusframework.window.NucleusDecoratedWindowTheme import io.github.aakira.napier.DebugAntilog import io.github.aakira.napier.Napier +import io.github.kdroidfilter.nucleus.darkmodedetector.isSystemInDarkMode +import io.github.kdroidfilter.nucleus.window.NucleusDecoratedWindowTheme +import io.github.sudarshanmhasrup.splashify.SplashifyApp import io.github.vinceglb.filekit.FileKit import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.cancel -import kotlinx.coroutines.delay import kotlinx.coroutines.launch import kotlinx.coroutines.runBlocking import kotlinx.coroutines.withContext @@ -97,7 +94,7 @@ private fun writeCrashDump(thread: Thread, throwable: Throwable) { File(dir).mkdirs() File(dir, "crash-${System.currentTimeMillis()}.txt").writeText( buildString { - append(startupBanner() + "\n") + append("Hammer v${BuildMetadata.APP_VERSION} | ${platformStartupInfo()}\n") append("Uncaught exception on thread '${thread.name}'\n\n") append(throwable.stackTraceToString()) } @@ -159,6 +156,11 @@ fun main(args: Array) { val quickShortcuts = getKoin().get() quickShortcuts.init() + if (initialProject == null) { + // When opening a project, the subsequent ApplicationState.openProject() will refresh. + appScope.launch { quickShortcuts.refresh() } + } + val scope = CoroutineScope(getDefaultDispatcher()) val mainDispatcher = getMainDispatcher() @@ -173,25 +175,9 @@ fun main(args: Array) { } } - // Decompose's ServiceLoader-provided checker only knows the AWT EDT, but the - // Tao backend drives the UI (and Dispatchers.Main) from Tao's own main thread. - DecomposeSettings.update { it.copy(mainThreadCheckEnabled = false) } - Napier.i("Startup: entering Compose application") - nucleusApplication( - args = args, - backend = NucleusBackend.Tao, - enableSingleInstance = false, - ) { - LaunchedEffect(Unit) { - Napier.i("Startup: first composition") - // Refreshed from inside composition, never from a coroutine racing - // the launch: an implementation that touches AWT (the macOS dock - // menu does) must not get there before the Tao backend has claimed - // AppKit, or the app hangs with no window. See SandboxStartup. - // When opening a project, ApplicationState.openProject() refreshes instead. - if (initialProject == null) quickShortcuts.refresh() - } + application { + LaunchedEffect(Unit) { Napier.i("Startup: first composition") } val applicationState = remember { ApplicationState( appScope = appScope, @@ -212,40 +198,24 @@ fun main(args: Array) { val systemDark = isSystemInDarkMode() val darkMode = when (settingsState.uiTheme) { UiTheme.Light -> false - UiTheme.Dark, UiTheme.OledBlack -> true + UiTheme.Dark -> true UiTheme.FollowSystem -> systemDark } NucleusDecoratedWindowTheme(isDark = darkMode) { AppTheme(useDarkTheme = darkMode, settings = settingsState) { when (val windowState = applicationState.windows.value) { is WindowState.ProjectSectionWindow -> { - var showSplash by remember { mutableStateOf(true) } - // The real window always exists, merely minimized behind the splash, and - // the hand-off is timed here rather than inside either window: a window - // that fails to render can neither stall it nor swallow the app. - LaunchedEffect(Unit) { - withContext(Dispatchers.Default) { delay(SplashDurationMs.toLong()) } - showSplash = false - } - ProjectSelectionWindow( - settings = settingsState, - darkMode = darkMode, - minimized = showSplash, - ) { project -> - applicationState.openProject(project) - } - if (showSplash) { - SplashWindow() + SplashifyApp( + splashScreen = { SplashScreen() } + ) { + ProjectSelectionWindow { project -> + applicationState.openProject(project) + } } } is WindowState.ProjectWindow -> { - ProjectEditorWindow( - app = applicationState, - projectDef = windowState.projectDef, - settings = settingsState, - darkMode = darkMode, - ) + ProjectEditorWindow(applicationState, windowState.projectDef) } } } @@ -264,7 +234,7 @@ internal enum class ConfirmCloseResult { Cancel } -internal fun NucleusApplicationScope.performClose( +internal fun ApplicationScope.performClose( app: ApplicationState, closeType: ApplicationState.CloseType ) { @@ -280,7 +250,7 @@ internal fun NucleusApplicationScope.performClose( } } -internal fun NucleusApplicationScope.onRequestClose( +internal fun ApplicationScope.onRequestClose( component: AppCloseManager, app: ApplicationState, closeType: ApplicationState.CloseType diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectEditorWindow.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectEditorWindow.kt index 7c83a82e6..c66020348 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectEditorWindow.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectEditorWindow.kt @@ -10,11 +10,24 @@ import androidx.compose.material3.ExperimentalMaterial3Api import androidx.compose.material3.MaterialTheme import androidx.compose.material3.SnackbarHost import androidx.compose.material3.Text -import androidx.compose.runtime.* +import androidx.compose.runtime.Composable +import androidx.compose.runtime.ExperimentalComposeApi +import androidx.compose.runtime.LaunchedEffect +import androidx.compose.runtime.getValue +import androidx.compose.runtime.remember +import androidx.compose.runtime.rememberCoroutineScope import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.input.key.* +import androidx.compose.ui.input.key.Key +import androidx.compose.ui.input.key.KeyEventType +import androidx.compose.ui.input.key.isCtrlPressed +import androidx.compose.ui.input.key.isMetaPressed +import androidx.compose.ui.input.key.isShiftPressed +import androidx.compose.ui.input.key.key +import androidx.compose.ui.input.key.type +import androidx.compose.ui.res.painterResource import androidx.compose.ui.unit.dp +import androidx.compose.ui.window.ApplicationScope import androidx.compose.ui.window.FrameWindowScope import androidx.compose.ui.window.MenuBar import com.arkivanov.decompose.DefaultComponentContext @@ -23,40 +36,40 @@ import com.arkivanov.decompose.extensions.compose.lifecycle.LifecycleController import com.arkivanov.decompose.extensions.compose.subscribeAsState import com.arkivanov.essenty.backhandler.BackDispatcher import com.arkivanov.essenty.lifecycle.LifecycleRegistry -import com.darkrockstudios.apps.hammer.* +import com.darkrockstudios.apps.hammer.Res import com.darkrockstudios.apps.hammer.base.BuildMetadata import com.darkrockstudios.apps.hammer.common.AppCloseManager import com.darkrockstudios.apps.hammer.common.components.projectroot.CloseConfirm import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectRoot import com.darkrockstudios.apps.hammer.common.components.projectroot.ProjectRootComponent -import com.darkrockstudios.apps.hammer.common.compose.* +import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRail +import com.darkrockstudios.apps.hammer.common.compose.rememberMainDispatcher +import com.darkrockstudios.apps.hammer.common.compose.rememberRootSnackbarHostState import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.compose.theme.ProjectThemeOverride import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.projectroot.ProjectRootFab import com.darkrockstudios.apps.hammer.common.projectroot.ProjectRootUi import com.darkrockstudios.apps.hammer.common.projectroot.toHdNavRailDestination -import dev.nucleusframework.application.NucleusApplicationScope -import dev.nucleusframework.window.material.MaterialDecoratedWindow -import dev.nucleusframework.window.material.MaterialTitleBar +import com.darkrockstudios.apps.hammer.project_window_menu_file +import com.darkrockstudios.apps.hammer.project_window_menu_item_close +import com.darkrockstudios.apps.hammer.project_window_menu_item_exit +import com.darkrockstudios.apps.hammer.project_window_title +import io.github.kdroidfilter.nucleus.window.material.MaterialDecoratedWindow +import io.github.kdroidfilter.nucleus.window.material.MaterialTitleBar import kotlinx.coroutines.launch import kotlinx.coroutines.withContext -import org.jetbrains.compose.resources.painterResource @OptIn(ExperimentalMaterial3Api::class) @ExperimentalComposeApi @ExperimentalDecomposeApi @ExperimentalMaterialApi @Composable -internal fun NucleusApplicationScope.ProjectEditorWindow( +internal fun ApplicationScope.ProjectEditorWindow( app: ApplicationState, projectDef: ProjectDef, - settings: GlobalSettings, - darkMode: Boolean, ) { val backDispatcher = BackDispatcher() val lifecycle = remember { LifecycleRegistry() } @@ -88,40 +101,37 @@ internal fun NucleusApplicationScope.ProjectEditorWindow( } val windowTitle = Res.string.project_window_title.get(projectDef.name) - val shortcutHost = remember { ProjectShortcutHost() } - MaterialDecoratedWindow( title = windowTitle, state = windowState, - icon = painterResource(Res.drawable.hammer_icon), + icon = painterResource("icon.png"), onCloseRequest = { onRequestClose(component, app, ApplicationState.CloseType.Application) }, - onPreviewKeyEvent = { event -> - when (event.toProjectShortcut()) { - ProjectShortcut.SyncProject -> shortcutHost.startProjectSync() - ProjectShortcut.SaveAll -> shortcutHost.saveAllBuffers() - null -> false - } - }, onKeyEvent = { event -> - when (event.toProjectEditorShortcut()) { - WindowShortcut.Back -> backDispatcher.back() - - WindowShortcut.GlobalSearch -> { + when { + event.key == Key.Escape && event.type == KeyEventType.KeyUp -> { + backDispatcher.back() + } + event.type == KeyEventType.KeyDown && + event.key == Key.F && + event.isShiftPressed && + (event.isCtrlPressed || event.isMetaPressed) -> { component.showGlobalSearch() true } - - WindowShortcut.CloseProject -> { + event.type == KeyEventType.KeyDown && + event.key == Key.W && + (event.isCtrlPressed || event.isMetaPressed) -> { onRequestClose(component, app, ApplicationState.CloseType.Project) true } - WindowShortcut.Quit -> { + event.type == KeyEventType.KeyDown && + event.key == Key.Q && + (event.isCtrlPressed || event.isMetaPressed) -> { onRequestClose(component, app, ApplicationState.CloseType.Application) true } - - null -> false + else -> false } } ) { @@ -136,91 +146,78 @@ internal fun NucleusApplicationScope.ProjectEditorWindow( ) } - // Tao windows are their own ComposeScene: locals provided outside the - // window (AppTheme in Main.kt) don't reach this content, so re-apply. - AppTheme(useDarkTheme = darkMode, settings = settings) { - AppContent(component, shortcutHost) + // The old menu bar approach +// Column { +// EditorMenuBar(component, app, ::onRequestClose) +// +// AppContent(component) +// } + AppContent(component) - LaunchedEffect(closeRequest) { - if (closeRequest != ApplicationState.CloseType.None) { - component.requestClose() - } + LaunchedEffect(closeRequest) { + if (closeRequest != ApplicationState.CloseType.None) { + component.requestClose() } + } - if (shouldConfirmClose.isNotEmpty()) { - val item = shouldConfirmClose.first() - when (item) { - CloseConfirm.Scenes -> { - confirmCloseUnsavedScenesDialog(closeRequest) { result, closeType -> - scope.launch { - when (result) { - ConfirmCloseResult.SaveAll -> component.storeDirtyBuffers() - ConfirmCloseResult.Discard -> component.discardUnsaved(CloseConfirm.Scenes) - ConfirmCloseResult.Cancel -> Unit - } + if (shouldConfirmClose.isNotEmpty()) { + val item = shouldConfirmClose.first() + when (item) { + CloseConfirm.Scenes -> { + confirmCloseUnsavedScenesDialog(closeRequest) { result, closeType -> + scope.launch { + if (result == ConfirmCloseResult.SaveAll) { + component.storeDirtyBuffers() + } - withContext(mainDispatcher) { - if (result != ConfirmCloseResult.Cancel) { - component.closeRequestDealtWith(CloseConfirm.Scenes) - } else { - cancelClose() - } + withContext(mainDispatcher) { + if (result != ConfirmCloseResult.Cancel) { + component.closeRequestDealtWith(CloseConfirm.Scenes) + } else { + cancelClose() } } } } - - CloseConfirm.Notes -> { - confirmCloseUnsavedNotesDialog(closeRequest) { result, closeType -> - when (result) { - ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") - ConfirmCloseResult.Discard -> scope.launch { - component.discardUnsaved(CloseConfirm.Notes) - withContext(mainDispatcher) { - component.closeRequestDealtWith(CloseConfirm.Notes) - } - } - ConfirmCloseResult.Cancel -> cancelClose() - } - } - } - - CloseConfirm.Encyclopedia -> { - confirmCloseUnsavedEncyclopediaDialog(closeRequest) { result, closeType -> - when (result) { - ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") - ConfirmCloseResult.Discard -> scope.launch { - component.discardUnsaved(CloseConfirm.Encyclopedia) - withContext(mainDispatcher) { - component.closeRequestDealtWith(CloseConfirm.Encyclopedia) - } - } - ConfirmCloseResult.Cancel -> cancelClose() - } - } - } - - CloseConfirm.Timeline -> { - confirmCloseUnsavedTimelineDialog(closeRequest) { result, closeType -> - when (result) { - ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") - ConfirmCloseResult.Discard -> scope.launch { - component.discardUnsaved(CloseConfirm.Timeline) - withContext(mainDispatcher) { - component.closeRequestDealtWith(CloseConfirm.Timeline) - } - } - ConfirmCloseResult.Cancel -> cancelClose() - } - } - } - - CloseConfirm.Sync -> { - component.showProjectSync() - } - - CloseConfirm.Complete -> performClose(app, closeRequest) } + + CloseConfirm.Notes -> { + confirmCloseUnsavedNotesDialog(closeRequest) { result, closeType -> + when (result) { + ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") + ConfirmCloseResult.Discard -> component.closeRequestDealtWith(CloseConfirm.Notes) + ConfirmCloseResult.Cancel -> cancelClose() + } + } + } + + CloseConfirm.Encyclopedia -> { + confirmCloseUnsavedEncyclopediaDialog(closeRequest) { result, closeType -> + when (result) { + ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") + ConfirmCloseResult.Discard -> component.closeRequestDealtWith(CloseConfirm.Encyclopedia) + ConfirmCloseResult.Cancel -> cancelClose() + } + } + } + + CloseConfirm.Timeline -> { + confirmCloseUnsavedTimelineDialog(closeRequest) { result, closeType -> + when (result) { + ConfirmCloseResult.SaveAll -> error("Unhandled close type: $closeType") + ConfirmCloseResult.Discard -> component.closeRequestDealtWith( + CloseConfirm.Timeline + ) + ConfirmCloseResult.Cancel -> cancelClose() + } + } + } + + CloseConfirm.Sync -> { + component.showProjectSync() + } + + CloseConfirm.Complete -> performClose(app, closeRequest) } } } @@ -264,7 +261,7 @@ private fun FrameWindowScope.EditorMenuBar( } @Composable -private fun AppContent(component: ProjectRoot, shortcutHost: ProjectShortcutHost) { +private fun AppContent(component: ProjectRoot) { val router by component.routerState.subscribeAsState() val themeState by component.projectTheme.subscribeAsState() val navRailState by component.navRailState.subscribeAsState() @@ -289,7 +286,7 @@ private fun AppContent(component: ProjectRoot, shortcutHost: ProjectShortcutHost }, ) - ProjectRootUi(component, rootSnackbar, shortcutHost = shortcutHost) + ProjectRootUi(component, rootSnackbar) } SnackbarHost( @@ -306,4 +303,4 @@ private fun AppContent(component: ProjectRoot, shortcutHost: ProjectShortcutHost } } } -} +} \ No newline at end of file diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectSelectionWindow.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectSelectionWindow.kt index 2e07c9ff4..229eda397 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectSelectionWindow.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/ProjectSelectionWindow.kt @@ -1,7 +1,6 @@ package com.darkrockstudios.apps.hammer.desktop import androidx.compose.foundation.background -import androidx.compose.foundation.layout.Box import androidx.compose.foundation.layout.Row import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.padding @@ -9,11 +8,21 @@ import androidx.compose.material.ExperimentalMaterialApi import androidx.compose.material3.MaterialTheme import androidx.compose.material3.Scaffold import androidx.compose.material3.Text -import androidx.compose.runtime.* +import androidx.compose.runtime.Composable +import androidx.compose.runtime.ExperimentalComposeApi +import androidx.compose.runtime.getValue +import androidx.compose.runtime.remember import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier -import androidx.compose.ui.input.key.* +import androidx.compose.ui.input.key.Key +import androidx.compose.ui.input.key.KeyEventType +import androidx.compose.ui.input.key.isCtrlPressed +import androidx.compose.ui.input.key.isMetaPressed +import androidx.compose.ui.input.key.key +import androidx.compose.ui.input.key.type +import androidx.compose.ui.res.painterResource import androidx.compose.ui.unit.dp +import androidx.compose.ui.window.ApplicationScope import com.arkivanov.decompose.DefaultComponentContext import com.arkivanov.decompose.ExperimentalDecomposeApi import com.arkivanov.decompose.extensions.compose.lifecycle.LifecycleController @@ -28,29 +37,18 @@ import com.darkrockstudios.apps.hammer.common.compose.Ui import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdMonoLabel import com.darkrockstudios.apps.hammer.common.compose.designsystem.HdNavRail import com.darkrockstudios.apps.hammer.common.compose.resources.get -import com.darkrockstudios.apps.hammer.common.compose.theme.AppTheme import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings import com.darkrockstudios.apps.hammer.common.projectselection.ProjectSelectionUi import com.darkrockstudios.apps.hammer.common.projectselection.toHdNavRailDestination import com.darkrockstudios.apps.hammer.common.util.getAppVersionString -import com.darkrockstudios.apps.hammer.hammer_icon -import com.darkrockstudios.cairn.CairnAboutOverlay -import com.darkrockstudios.cairn.CairnAppId -import com.darkrockstudios.cairn.CairnConfig -import dev.nucleusframework.application.NucleusApplicationScope -import dev.nucleusframework.window.material.MaterialDecoratedWindow -import dev.nucleusframework.window.material.MaterialTitleBar -import org.jetbrains.compose.resources.painterResource +import io.github.kdroidfilter.nucleus.window.material.MaterialDecoratedWindow +import io.github.kdroidfilter.nucleus.window.material.MaterialTitleBar @ExperimentalMaterialApi @ExperimentalComposeApi @ExperimentalDecomposeApi @Composable -internal fun NucleusApplicationScope.ProjectSelectionWindow( - settings: GlobalSettings, - darkMode: Boolean, - minimized: Boolean = false, +internal fun ApplicationScope.ProjectSelectionWindow( onProjectSelected: (projectDef: ProjectDef) -> Unit ) { val backDispatcher = BackDispatcher() @@ -59,14 +57,7 @@ internal fun NucleusApplicationScope.ProjectSelectionWindow( val windowState = rememberPersistedWindowState( WindowGeometryStore.Window.ProjectSelect, defaultSize = coerceWindowSize(900.dp, 800.dp), - startMinimized = minimized, ) - - // Restore once the splash is done. One-way on purpose: a later user-initiated - // minimize must stick. - LaunchedEffect(minimized) { - if (!minimized) windowState.isMinimized = false - } val component = remember { ProjectSelectionComponent( componentContext = compContext, @@ -80,15 +71,17 @@ internal fun NucleusApplicationScope.ProjectSelectionWindow( title = title, state = windowState, onCloseRequest = ::exitApplication, - icon = painterResource(Res.drawable.hammer_icon), + icon = painterResource("icon.png"), onKeyEvent = { event -> - when (event.toProjectSelectionShortcut()) { - WindowShortcut.Back -> { + when { + event.key == Key.Escape && event.type == KeyEventType.KeyUp -> { backDispatcher.back() true } - WindowShortcut.Quit -> { + event.type == KeyEventType.KeyDown && + event.key == Key.Q && + (event.isCtrlPressed || event.isMetaPressed) -> { exitApplication() true } @@ -104,11 +97,7 @@ internal fun NucleusApplicationScope.ProjectSelectionWindow( modifier = Modifier.align(Alignment.CenterHorizontally), ) } - // Tao windows are their own ComposeScene: locals provided outside the - // window (AppTheme in Main.kt) don't reach this content, so re-apply. - AppTheme(useDarkTheme = darkMode, settings = settings) { - Content(component) - } + Content(component) } } @@ -118,56 +107,40 @@ internal fun NucleusApplicationScope.ProjectSelectionWindow( fun Content(component: ProjectSelection) { val stackState by component.stack.subscribeAsState() val navRailState by component.navRailState.subscribeAsState() - var showStudio by remember { mutableStateOf(false) } val destinations = ProjectSelection.Locations.entries.map { it.toHdNavRailDestination() } - // The overlay is hoisted above the nav rail so its ceremony covers the - // whole window, not just the content pane. - Box(modifier = Modifier.fillMaxSize()) { - Scaffold( - modifier = Modifier - .fillMaxSize() - .background(MaterialTheme.colorScheme.background), - content = { innerPadding -> - Row( - modifier = Modifier - .padding(innerPadding) - .fillMaxSize() - .background(MaterialTheme.colorScheme.background) - ) { - HdNavRail( - destinations = destinations, - selectedId = stackState.active.configuration.location, - onSelect = { component.showLocation(it) }, - expanded = navRailState.expanded, - onToggleExpanded = { component.toggleNavRailExpanded() }, - footer = { - val versionText = remember { getAppVersionString() } - HdMonoLabel( - text = versionText, - color = MaterialTheme.colorScheme.onSurfaceVariant, - ) - }, - ) + Scaffold( + modifier = Modifier + .fillMaxSize() + .background(MaterialTheme.colorScheme.background), + content = { innerPadding -> + Row( + modifier = Modifier + .padding(innerPadding) + .fillMaxSize() + .background(MaterialTheme.colorScheme.background) + ) { + HdNavRail( + destinations = destinations, + selectedId = stackState.active.configuration.location, + onSelect = { component.showLocation(it) }, + expanded = navRailState.expanded, + onToggleExpanded = { component.toggleNavRailExpanded() }, + footer = { + val versionText = remember { getAppVersionString() } + HdMonoLabel( + text = versionText, + color = MaterialTheme.colorScheme.onSurfaceVariant, + ) + }, + ) - ProjectSelectionUi( - component, - onShowStudio = { showStudio = true }, - modifier = Modifier.padding(start = Ui.Padding.XL, top = Ui.Padding.XL), - ) - } - }, - ) - - CairnAboutOverlay( - visible = showStudio, - config = CairnConfig( - currentAppId = CairnAppId.Hammer, - // Cairn stamps its own "v", ours already carries one. - versionName = getAppVersionString().removePrefix("v"), - ), - onDismissed = { showStudio = false }, - ) - } + ProjectSelectionUi( + component, + Modifier.padding(start = Ui.Padding.XL, top = Ui.Padding.XL) + ) + } + }, + ) } \ No newline at end of file diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/SplashScreen.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/SplashScreen.kt index e5eb8203a..c59389753 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/SplashScreen.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/SplashScreen.kt @@ -1,19 +1,13 @@ package com.darkrockstudios.apps.hammer.desktop -import androidx.compose.animation.core.LinearEasing import androidx.compose.animation.core.animateFloatAsState -import androidx.compose.animation.core.tween import androidx.compose.foundation.Image import androidx.compose.foundation.background import androidx.compose.foundation.layout.* import androidx.compose.foundation.shape.CircleShape import androidx.compose.material3.Text import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.draw.clip @@ -21,17 +15,12 @@ import androidx.compose.ui.graphics.Color import androidx.compose.ui.text.font.FontFamily import androidx.compose.ui.text.font.FontWeight import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.DpSize import androidx.compose.ui.unit.dp import androidx.compose.ui.unit.sp -import androidx.compose.ui.window.WindowPosition -import androidx.compose.ui.window.rememberWindowState import com.darkrockstudios.apps.hammer.* -import dev.nucleusframework.application.DecoratedWindow -import dev.nucleusframework.application.NucleusApplicationScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.delay -import kotlinx.coroutines.withContext +import io.github.sudarshanmhasrup.splashify.ui.config.SplashScreenSize +import io.github.sudarshanmhasrup.splashify.ui.config.SplashScreenStyle +import io.github.sudarshanmhasrup.splashify.ui.splashscreen.SimpleSplashScreen import org.jetbrains.compose.resources.Font import org.jetbrains.compose.resources.painterResource import org.jetbrains.compose.resources.stringResource @@ -44,50 +33,27 @@ private val TitleColor = Color(0xFFEDE0DB) private val SubtitleColor = Color(0xFFB9ACA6) private val TrackColor = Color(0x33FFFFFF) -internal const val SplashDurationMs = 600 - -/** - * Borderless splash window shown over the main window while it spins up. Purely - * cosmetic: it owns no timer and gates nothing, so no way it can fail is a way the - * app fails to appear. The caller decides when it goes away. - */ @Composable -internal fun NucleusApplicationScope.SplashWindow() { - val windowState = rememberWindowState( - size = DpSize(600.dp, 380.dp), - position = WindowPosition(Alignment.Center), +fun SplashScreen() { + val size = SplashScreenSize( + width = 600.dp, + height = 380.dp ) - DecoratedWindow( - onCloseRequest = {}, - state = windowState, - title = "", - undecorated = true, - resizable = false, - ) { - var filling by remember { mutableStateOf(false) } - LaunchedEffect(Unit) { filling = true } + val style = SplashScreenStyle( + backgroundColor = SplashBackground, + cornerRadius = 16.dp + ) - SplashScreen(if (filling) 1f else 0f) - } -} - -@Composable -private fun SplashScreen(progress: Float) { val typewriter = FontFamily(Font(Res.font.Kingthings_Trypewriter_2)) val mono = FontFamily(Font(Res.font.IBMPlexMono_SemiBold)) - val animatedProgress by animateFloatAsState( - targetValue = progress, - animationSpec = tween(durationMillis = SplashDurationMs, easing = LinearEasing), - ) + SimpleSplashScreen( + size = size, + style = style + ) { progress -> + val animatedProgress by animateFloatAsState(targetValue = progress) - Box( - modifier = Modifier - .fillMaxSize() - .background(SplashBackground), - contentAlignment = Alignment.Center, - ) { Column( modifier = Modifier .fillMaxWidth() diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowGeometryStore.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowGeometryStore.kt index 108eeb916..2a5dc5751 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowGeometryStore.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowGeometryStore.kt @@ -61,14 +61,12 @@ class WindowGeometryStore(private val settings: Settings) { fun rememberPersistedWindowState( window: WindowGeometryStore.Window, defaultSize: DpSize, - startMinimized: Boolean = false, ): WindowState { val store = remember { getKoin().get() } val initial = remember { store.load(window, defaultSize) } val windowState = rememberWindowState( size = initial.size, placement = if (initial.maximized) WindowPlacement.Maximized else WindowPlacement.Floating, - isMinimized = startMinimized, ) LaunchedEffect(windowState) { diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcuts.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcuts.kt deleted file mode 100644 index c7a9c5f1e..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcuts.kt +++ /dev/null @@ -1,44 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop - -import androidx.compose.ui.input.key.* -import com.darkrockstudios.apps.hammer.common.compose.matchesShortcut - -/** - * Modifiers must match exactly, and no chord may use Alt: AltGr arrives as Ctrl+Alt, so - * either would fire while a Turkish, German, or Polish layout types the character on that - * key. - */ -internal enum class WindowShortcut { - Back, - Quit, - CloseProject, - GlobalSearch, -} - -/** Project actions, matched pre-focus so a focused editor cannot swallow them. */ -internal enum class ProjectShortcut { - SyncProject, - SaveAll, -} - -internal fun KeyEvent.toProjectShortcut(): ProjectShortcut? = when { - matchesShortcut(Key.F3) -> ProjectShortcut.SyncProject - matchesShortcut(Key.S, ctrl = true, shift = true) -> ProjectShortcut.SaveAll - else -> null -} - -internal fun KeyEvent.toProjectSelectionShortcut(): WindowShortcut? = when { - isBack() -> WindowShortcut.Back - matchesShortcut(Key.Q, ctrl = true) -> WindowShortcut.Quit - else -> null -} - -internal fun KeyEvent.toProjectEditorShortcut(): WindowShortcut? = when { - isBack() -> WindowShortcut.Back - matchesShortcut(Key.F, ctrl = true, shift = true) -> WindowShortcut.GlobalSearch - matchesShortcut(Key.W, ctrl = true) -> WindowShortcut.CloseProject - matchesShortcut(Key.Q, ctrl = true) -> WindowShortcut.Quit - else -> null -} - -private fun KeyEvent.isBack(): Boolean = key == Key.Escape && type == KeyEventType.KeyUp diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowUtils.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowUtils.kt index 943a1b50b..936ac5828 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowUtils.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowUtils.kt @@ -6,6 +6,9 @@ import androidx.compose.ui.unit.coerceIn import androidx.compose.ui.unit.dp import java.awt.Toolkit +fun getScreenWidth() = Toolkit.getDefaultToolkit().screenSize.width.dp +fun getScreenHeight() = Toolkit.getDefaultToolkit().screenSize.height.dp + fun coerceWindowSize(targetWidth: Dp, targetHeight: Dp): DpSize { val min = 100.dp val maxPercent = 0.9 diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/desktopModule.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/desktopModule.kt index 62e236626..f5d3009c4 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/desktopModule.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/desktopModule.kt @@ -1,16 +1,10 @@ package com.darkrockstudios.apps.hammer.desktop -import com.darkrockstudios.apps.hammer.base.DistributionChannel -import com.darkrockstudios.apps.hammer.base.PackageFormat import com.darkrockstudios.apps.hammer.common.HostOs -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater +import com.darkrockstudios.apps.hammer.common.IS_APP_STORE import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_IO -import com.darkrockstudios.apps.hammer.common.getInDevelopmentMode import com.darkrockstudios.apps.hammer.common.hostOs -import com.darkrockstudios.apps.hammer.desktop.update.GlobalSettingsUpdatePreferences -import com.darkrockstudios.apps.hammer.desktop.update.createAppUpdater import com.darkrockstudios.apps.hammer.common.sandbox.NoopSandboxFileAccess import com.darkrockstudios.apps.hammer.common.sandbox.SandboxFileAccess import com.darkrockstudios.apps.hammer.desktop.sandbox.MacOsBookmarks @@ -40,20 +34,10 @@ val desktopModule: Module = module { } } single { - if (DistributionChannel.isMacAppStore && MacOsBookmarks.isAvailable) { + if (IS_APP_STORE && MacOsBookmarks.isAvailable) { MacOsSandboxFileAccess(get()) } else { NoopSandboxFileAccess } } - single { - createAppUpdater( - channel = DistributionChannel.current, - format = PackageFormat.current, - devMode = getInDevelopmentMode(), - preferences = GlobalSettingsUpdatePreferences(get()), - appScope = get(named(APP_SCOPE)), - ioDispatcher = get(named(DISPATCHER_IO)), - ) - } } diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/MacOsBookmarks.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/MacOsBookmarks.kt index 7e3f168b6..0df9dafa1 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/MacOsBookmarks.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/MacOsBookmarks.kt @@ -21,14 +21,6 @@ internal interface HammerBookmarksLib : Library { fun hammer_bookmark_resolve_and_start(base64Bookmark: String, outStale: IntByReference): Pointer? fun hammer_bookmark_stop(path: String) fun hammer_bookmark_free_string(s: Pointer) - fun hammer_dialog_confirm( - title: String?, - message: String?, - primaryButton: String?, - secondaryButton: String?, - ): Int - - fun hammer_dialog_pick_directory(title: String?, message: String?, prompt: String?): Pointer? } internal object MacOsBookmarks { @@ -75,29 +67,6 @@ internal object MacOsBookmarks { if (activePath == path) activePath = null } - /** - * Native two-button alert. True when the user chose the primary button. - * - * Deliberately not [javax.swing.JOptionPane]: this runs before the Compose - * application starts, and initializing AWT first leaves the Tao backend's - * event loop with no events to pump, hanging the app on a blank screen. - */ - fun confirm(title: String, message: String, primaryButton: String, secondaryButton: String): Boolean { - val lib = lib ?: return false - return lib.hammer_dialog_confirm(title, message, primaryButton, secondaryButton) == 1 - } - - /** Native directory chooser (the Powerbox panel when sandboxed). Null when cancelled. */ - fun pickDirectory(title: String, message: String, prompt: String): String? { - val lib = lib ?: return null - val ptr = lib.hammer_dialog_pick_directory(title, message, prompt) ?: return null - return try { - ptr.getString(0) - } finally { - lib.hammer_bookmark_free_string(ptr) - } - } - private fun tryLoadLib(): HammerBookmarksLib? { val osName = System.getProperty("os.name") ?: return null if (!osName.lowercase().contains("mac")) return null diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStartup.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStartup.kt index a55260343..a397e3011 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStartup.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStartup.kt @@ -1,9 +1,17 @@ package com.darkrockstudios.apps.hammer.desktop.sandbox -import com.darkrockstudios.apps.hammer.base.DistributionChannel +import com.darkrockstudios.apps.hammer.* +import com.darkrockstudios.apps.hammer.common.IS_APP_STORE import com.darkrockstudios.apps.hammer.common.data.globalsettings.datasource.GlobalSettingsDatasource +import com.darkrockstudios.apps.hammer.common.util.StrRes import io.github.aakira.napier.Napier +import kotlinx.coroutines.runBlocking +import org.jetbrains.compose.resources.StringResource import org.koin.java.KoinJavaComponent.getKoin +import java.awt.FileDialog +import java.awt.Frame +import java.io.File +import javax.swing.JOptionPane import kotlin.system.exitProcess /** @@ -14,26 +22,18 @@ import kotlin.system.exitProcess * from the projects dir, which is inaccessible in the sandbox until we * activate a security-scoped bookmark for it. * - * Nothing on this path may touch AWT, directly or indirectly. All of it runs - * before the Compose application starts, and whatever creates `NSApp` first - * owns it: if that is AWT, the Tao backend's event loop — which blocks the - * main thread expecting AppKit events — never gets any, and the app runs on - * with no window and no crash. Two separate things used to do exactly that, - * and both had to go: the Swing/AWT dialogs (now native AppKit via - * [MacOsBookmarks]) and Compose Resources string lookup (now [SandboxStrings], - * because `getString()` reaches `Toolkit.getDefaultToolkit()` on desktop). - * - * The hang only ever bites on first launch — later launches resolve a stored - * bookmark and never get here — which is exactly how it reached App Review. - * * No-op on non-sandboxed builds. */ object SandboxStartup { - private fun str(key: String): String = SandboxStrings.get(key) + private val strRes: StrRes by lazy { getKoin().get(StrRes::class) } + + // These dialogs run on the startup thread before any Compose UI exists, so + // resolve the (suspend) localized strings synchronously. + private fun str(res: StringResource): String = runBlocking { strRes.get(res) } fun ensureProjectsDirAccess() { - if (!DistributionChannel.isMacAppStore) return + if (!IS_APP_STORE) return if (!MacOsBookmarks.isAvailable) { Napier.w("App Store flavor but bookmark dylib unavailable — projects-dir access likely to fail") return @@ -58,7 +58,6 @@ object SandboxStartup { val (path, bookmark) = pickDirectoryUntilSuccessfulOrQuit() bookmarkStore.saveProjectsDirBookmark(bookmark) datasource.storeSettings(datasource.loadSettings().copy(projectsDirectory = path)) - Napier.i("Projects directory set to picked path: $path") } private fun refreshIfNeeded( @@ -85,14 +84,10 @@ object SandboxStartup { while (true) { val picked = showNativeDirectoryPicker() if (picked != null) { - Napier.i("User picked projects directory: $picked") - val bookmark = MacOsBookmarks.createBookmark(picked) + val bookmark = MacOsBookmarks.createBookmark(picked.absolutePath) if (bookmark != null) { val resolved = MacOsBookmarks.resolveAndStartAccess(bookmark) - if (resolved != null) { - Napier.i("Bookmark for picked directory resolved to: ${resolved.path}") - return resolved.path to bookmark - } + if (resolved != null) return resolved.path to bookmark Napier.w("Could not start access on a freshly-created bookmark; retrying") } else { Napier.w("Could not create bookmark for picked directory; retrying") @@ -105,27 +100,55 @@ object SandboxStartup { } } - // Same string for title and message on purpose: modern macOS hides an open - // panel's title bar, so `message` is the only one the user actually reads. - private fun showNativeDirectoryPicker(): String? = MacOsBookmarks.pickDirectory( - title = str(SandboxStrings.PICKER_TITLE), - message = str(SandboxStrings.PICKER_TITLE), - prompt = str(SandboxStrings.CHOOSE_FOLDER_BUTTON), - ) + private fun showNativeDirectoryPicker(): File? { + // macOS-specific AWT toggle to make FileDialog pick directories rather + // than files. Restore the previous value so we don't leak this into any + // other dialog Compose Desktop might open later. + val key = "apple.awt.fileDialogForDirectories" + val prior = System.getProperty(key) + System.setProperty(key, "true") + try { + // Don't set dialog.directory — user.home is the sandbox container. + // NSOpenPanel runs out-of-process and defaults to the real ~/Documents. + val dialog = FileDialog(null as Frame?, str(Res.string.sandbox_picker_title), FileDialog.LOAD) + dialog.isVisible = true + val name = dialog.file ?: return null + val dir = dialog.directory ?: return null + return File(dir, name) + } finally { + if (prior == null) System.clearProperty(key) else System.setProperty(key, prior) + } + } // Shown once before the native picker so first-time users understand why // macOS is about to ask them to choose a folder. - private fun confirmIntroOrQuit(): Boolean = MacOsBookmarks.confirm( - title = str(SandboxStrings.INTRO_TITLE), - message = str(SandboxStrings.INTRO_MESSAGE), - primaryButton = str(SandboxStrings.CHOOSE_FOLDER_BUTTON), - secondaryButton = str(SandboxStrings.QUIT_BUTTON), - ) + private fun confirmIntroOrQuit(): Boolean { + val options = arrayOf(str(Res.string.sandbox_choose_folder_button), str(Res.string.sandbox_quit_button)) + val result = JOptionPane.showOptionDialog( + null, + str(Res.string.sandbox_intro_message), + str(Res.string.sandbox_intro_title), + JOptionPane.YES_NO_OPTION, + JOptionPane.INFORMATION_MESSAGE, + null, + options, + options[0], + ) + return result == JOptionPane.YES_OPTION + } - private fun confirmRetryOrQuit(): Boolean = MacOsBookmarks.confirm( - title = "Hammer", - message = str(SandboxStrings.RETRY_MESSAGE), - primaryButton = str(SandboxStrings.CHOOSE_FOLDER_BUTTON), - secondaryButton = str(SandboxStrings.QUIT_BUTTON), - ) + private fun confirmRetryOrQuit(): Boolean { + val options = arrayOf(str(Res.string.sandbox_choose_folder_button), str(Res.string.sandbox_quit_button)) + val result = JOptionPane.showOptionDialog( + null, + str(Res.string.sandbox_retry_message), + "Hammer", + JOptionPane.YES_NO_OPTION, + JOptionPane.WARNING_MESSAGE, + null, + options, + options[0], + ) + return result == JOptionPane.YES_OPTION + } } diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStrings.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStrings.kt deleted file mode 100644 index 9e4ebbd20..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStrings.kt +++ /dev/null @@ -1,97 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.sandbox - -import io.github.aakira.napier.Napier -import java.util.Base64 -import java.util.Locale - -/** - * Reads the first-run dialog strings straight out of the packaged Compose - * Resources value files, without going through Compose Resources itself. - * - * That detour exists because `getString()` cannot be called before the Compose - * application starts. On desktop it resolves a [org.jetbrains.compose.resources.ResourceEnvironment] - * via `getSystemEnvironment()`, which calls `Toolkit.getDefaultToolkit()` to - * pick a density qualifier — and that initializes AWT. AWT then owns `NSApp`, - * the Tao backend's event loop gets no events, and the app runs on with no - * window and no crash (see [SandboxStartup]). Supplying our own environment - * isn't an option either: `ResourceEnvironment`'s constructor is internal. - * - * The `.cvr` files are a Compose Resources implementation detail — an ASCII - * `version:0` header followed by `string||` lines, with - * XML escapes already resolved at build time, so a value here matches what - * `getString()` would have returned. Reading them keeps the translations - * Crowdin manages rather than forking a second copy of these strings. Since - * the format is not a public contract, every step degrades rather than throws: - * an unknown version or unreadable file falls back to English, and a key missing - * from every layer falls back to the key name, so a Compose upgrade can spoil - * the dialog text but never block startup. - */ -internal object SandboxStrings { - - private const val RESOURCE_DIR = "composeResources/com.darkrockstudios.apps.hammer" - private const val FILE_NAME = "strings_desktop.commonMain.cvr" - private const val SUPPORTED_VERSION = "version:0" - private const val DEFAULT_VALUES_DIR = "values" - - const val INTRO_TITLE = "sandbox_intro_title" - const val INTRO_MESSAGE = "sandbox_intro_message" - const val PICKER_TITLE = "sandbox_picker_title" - const val CHOOSE_FOLDER_BUTTON = "sandbox_choose_folder_button" - const val QUIT_BUTTON = "sandbox_quit_button" - const val RETRY_MESSAGE = "sandbox_retry_message" - - /** Localized value for [key], falling back to the key itself if it can't be resolved. */ - fun get(key: String): String = strings[key]?.takeIf { it.isNotBlank() } ?: key - - private val strings: Map by lazy { load(Locale.getDefault()) } - - /** - * Layers each value file over the less specific ones beneath it, so English - * still backs a key a translation is missing. Compose's own fallback is - * per-key; taking a single value file wholesale would render the raw key name - * for anything Crowdin has not round-tripped yet. - */ - internal fun load(locale: Locale): Map = - candidateDirs(locale).asReversed().fold(emptyMap()) { merged, dir -> - merged + (readValues(dir) ?: emptyMap()) - } - - /** Most specific locale first, English last — mirrors Compose's own qualifier fallback. */ - internal fun candidateDirs(locale: Locale): List = buildList { - val language = locale.language - val country = locale.country - if (language.isNotEmpty() && country.isNotEmpty()) add("$DEFAULT_VALUES_DIR-$language-r$country") - if (language.isNotEmpty()) add("$DEFAULT_VALUES_DIR-$language") - add(DEFAULT_VALUES_DIR) - } - - private fun readValues(valuesDir: String): Map? { - val path = "$RESOURCE_DIR/$valuesDir/$FILE_NAME" - val text = runCatching { - javaClass.classLoader.getResourceAsStream(path)?.use { it.readBytes().decodeToString() } - }.onFailure { Napier.w("Could not read sandbox strings from $path", it) }.getOrNull() ?: return null - - return parse(text, path) - } - - internal fun parse(text: String, path: String = FILE_NAME): Map? { - val lines = text.lineSequence().filter { it.isNotBlank() }.toList() - if (lines.firstOrNull()?.trim() != SUPPORTED_VERSION) { - Napier.w("Unexpected Compose Resources value-file version in $path — ignoring it") - return null - } - - // Values are base64 on a single line each, so multi-line strings survive - // this line-based parse intact. - val parsed = lines.drop(1).mapNotNull { line -> - val parts = line.split('|', limit = 3) - if (parts.size < 3 || parts[0] != "string") return@mapNotNull null - val decoded = runCatching { Base64.getDecoder().decode(parts[2]).decodeToString() }.getOrNull() - // Blank values are dropped rather than kept, so an empty translation - // falls through to the English layer instead of shadowing it. - decoded?.trim()?.takeIf { it.isNotEmpty() }?.let { parts[1] to it } - }.toMap() - - return parsed.ifEmpty { null } - } -} diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/LinuxQuicklist.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/LinuxQuicklist.kt index 31ec05975..fdb469db5 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/LinuxQuicklist.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/LinuxQuicklist.kt @@ -3,17 +3,17 @@ package com.darkrockstudios.apps.hammer.desktop.shortcuts import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import io.github.aakira.napier.Napier -import dev.nucleusframework.freedesktop.icons.FreedesktopIcon -import dev.nucleusframework.launcher.linux.DbusmenuItem -import dev.nucleusframework.launcher.linux.LauncherProperties -import dev.nucleusframework.launcher.linux.LinuxLauncherEntry +import io.github.kdroidfilter.nucleus.freedesktop.icons.FreedesktopIcon +import io.github.kdroidfilter.nucleus.launcher.linux.DbusmenuItem +import io.github.kdroidfilter.nucleus.launcher.linux.LauncherProperties +import io.github.kdroidfilter.nucleus.launcher.linux.LinuxLauncherEntry import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.asSharedFlow import kotlinx.coroutines.withContext import java.util.concurrent.ConcurrentHashMap import kotlin.coroutines.CoroutineContext -import dev.nucleusframework.launcher.linux.LinuxQuicklist as NucleusQuicklist +import io.github.kdroidfilter.nucleus.launcher.linux.LinuxQuicklist as NucleusQuicklist class LinuxQuicklist( private val projectsRepository: ProjectsRepository, diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/MacOsDockShortcuts.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/MacOsDockShortcuts.kt index e6273240f..ba3c8036c 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/MacOsDockShortcuts.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/MacOsDockShortcuts.kt @@ -3,9 +3,9 @@ package com.darkrockstudios.apps.hammer.desktop.shortcuts import com.darkrockstudios.apps.hammer.common.data.ProjectDef import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository import io.github.aakira.napier.Napier -import dev.nucleusframework.launcher.macos.DockMenuItem -import dev.nucleusframework.launcher.macos.DockMenuListener -import dev.nucleusframework.launcher.macos.MacOsDockMenu +import io.github.kdroidfilter.nucleus.launcher.macos.DockMenuItem +import io.github.kdroidfilter.nucleus.launcher.macos.DockMenuListener +import io.github.kdroidfilter.nucleus.launcher.macos.MacOsDockMenu import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.asSharedFlow @@ -40,23 +40,16 @@ class MacOsDockShortcuts( runCatching { val recent = projectsRepository.getRecentProjects(MAX_RECENT_PROJECTS, excludeCurrent) idToProject.clear() - @Suppress("UNUSED_VARIABLE") val items = recent.mapIndexed { idx, def -> val id = idx + 1 idToProject[id] = def DockMenuItem(id = id, title = def.name) } - // Publishing the menu is commented out along with the rest of this - // implementation being unbound (see desktopModule). It used to hop to - // the EDT so AWT would have installed the NSApplicationDelegate that - // Nucleus method-swizzles in nativeSetDockMenu — but touching AWT is - // exactly what hangs the app when it wins the race against the Tao - // backend claiming AppKit (see SandboxStartup). Re-enabling this needs - // a non-AWT way to get that delegate installed first; restoring the - // SwingUtilities call as-is would reintroduce the hang. - // javax.swing.SwingUtilities.invokeLater { - // MacOsDockMenu.setDockMenu(items) - // } + // Defer to the EDT so AWT has installed the NSApplicationDelegate + // that Nucleus method-swizzles in nativeSetDockMenu. + javax.swing.SwingUtilities.invokeLater { + MacOsDockMenu.setDockMenu(items) + } }.onFailure { Napier.w("Failed to refresh macOS dock menu", it) } } } diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/WindowsJumpList.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/WindowsJumpList.kt index c6ce91756..84e09cd50 100644 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/WindowsJumpList.kt +++ b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/shortcuts/WindowsJumpList.kt @@ -6,7 +6,7 @@ import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRe import com.darkrockstudios.apps.hammer.desktop.PROJECT_FLAG import com.darkrockstudios.apps.hammer.jump_list_recent_projects import io.github.aakira.napier.Napier -import dev.nucleusframework.launcher.windows.* +import io.github.kdroidfilter.nucleus.launcher.windows.* import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.SharedFlow import kotlinx.coroutines.flow.asSharedFlow diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProvider.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProvider.kt deleted file mode 100644 index fa29c2477..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProvider.kt +++ /dev/null @@ -1,46 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.base.GITHUB_URL -import dev.nucleusframework.core.runtime.Platform -import dev.nucleusframework.updater.provider.UpdateProvider - -/** - * Points the Nucleus updater at the fixed-name assets on the latest GitHub release. - * - * Nucleus's own GitHubProvider downloads from `releases/download/v{version}/`, which does not - * exist for a partial-release tag such as `v1.2.4+google-play`. `releases/latest/download/` is a - * plain redirect to whatever release is marked latest: no API call, no token, no rate limit, and - * the same URLs the README links. - */ -class HammerReleaseProvider( - private val baseUrl: String = defaultBaseUrl(), -) : UpdateProvider { - - override fun getUpdateMetadataUrl(channel: String, platform: Platform): String = - "$baseUrl/${metadataFileName(platform)}" - - override fun getDownloadUrl(fileName: String, version: String): String = "$baseUrl/$fileName" - - companion object { - /** - * Substitutes a local server for the GitHub release, for end-to-end testing of a packaged - * build. The environment variable form exists because an installed app has no command line - * to put a system property on. - */ - const val BASE_URL_PROPERTY = "hammer.update.baseUrl" - const val BASE_URL_ENV = "HAMMER_UPDATE_BASE_URL" - - fun defaultBaseUrl( - property: String? = System.getProperty(BASE_URL_PROPERTY), - environment: String? = System.getenv(BASE_URL_ENV), - ): String = - (property ?: environment)?.trim()?.trimEnd('/')?.takeIf { it.isNotEmpty() } - ?: "${GITHUB_URL}releases/latest/download" - - fun metadataFileName(platform: Platform): String = when (platform) { - Platform.MacOS -> "latest-mac.yml" - Platform.Linux -> "latest-linux.yml" - Platform.Windows, Platform.Unknown -> "latest.yml" - } - } -} diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdater.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdater.kt deleted file mode 100644 index 769f5cf8c..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdater.kt +++ /dev/null @@ -1,135 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import dev.nucleusframework.updater.NucleusUpdater -import dev.nucleusframework.updater.UpdateInfo -import dev.nucleusframework.updater.UpdateResult -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Job -import kotlinx.coroutines.delay -import kotlinx.coroutines.flow.MutableStateFlow -import kotlinx.coroutines.flow.StateFlow -import kotlinx.coroutines.flow.asStateFlow -import kotlinx.coroutines.isActive -import kotlinx.coroutines.launch -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.withContext -import java.io.File -import kotlin.coroutines.CoroutineContext -import kotlin.time.Duration -import kotlin.time.Duration.Companion.hours -import kotlin.time.Duration.Companion.seconds - -private const val PERCENT_MAX = 100.0 - -/** - * [AppUpdater] over the Nucleus updater runtime. [start] checks once shortly after launch and - * then on a schedule while the user allows it; a failed check is logged and never shown. - * [update] downloads, verifies, and hands the file to [install], which by default quits the app - * and relaunches the new version. - */ -class NucleusAppUpdater( - private val updater: NucleusUpdater, - private val installable: Boolean, - private val preferences: UpdatePreferences, - private val scope: CoroutineScope, - private val ioDispatcher: CoroutineContext, - private val initialDelay: Duration = 10.seconds, - private val checkInterval: Duration = 6.hours, - private val install: (File) -> Unit = updater::installAndRestart, -) : AppUpdater { - - private val _state = MutableStateFlow(AppUpdateState.Idle) - override val state: StateFlow = _state.asStateFlow() - - private val checking = Mutex() - - @Volatile - private var available: UpdateInfo? = null - - @Volatile - private var updateJob: Job? = null - - fun start() { - scope.launch { - delay(initialDelay) - while (isActive) { - if (preferences.automaticChecks) check() - delay(checkInterval) - } - } - } - - override fun checkNow() { - scope.launch { check() } - } - - private suspend fun check() { - if (updateJob?.isActive == true) return - if (!checking.tryLock()) return - try { - // An offered release stays on screen while it is re-checked; Checking is only shown - // when there is nothing better to show. - if (available == null) _state.value = AppUpdateState.Checking - val result = withContext(ioDispatcher) { updater.checkForUpdates() } - _state.value = when (result) { - is UpdateResult.Available -> { - available = result.info - availableState(result.info) - } - - UpdateResult.NotAvailable -> { - available = null - AppUpdateState.UpToDate - } - - is UpdateResult.Error -> { - Napier.w("Update check failed", result.exception) - available?.let(::availableState) ?: AppUpdateState.Idle - } - } - } finally { - checking.unlock() - } - } - - private fun availableState(info: UpdateInfo) = AppUpdateState.Available( - version = info.version, - installable = installable, - dismissed = preferences.dismissedVersion == info.version, - ) - - override fun update() { - val info = available ?: return - if (!installable || updateJob?.isActive == true) return - updateJob = scope.launch { - try { - var downloaded: File? = null - updater.downloadUpdate(info).collect { progress -> - downloaded = progress.file ?: downloaded - _state.value = AppUpdateState.Downloading( - version = info.version, - fraction = (progress.percent / PERCENT_MAX).toFloat().coerceIn(0f, 1f), - ) - } - val installer = checkNotNull(downloaded) { "Download finished without a file" } - _state.value = AppUpdateState.Installing(info.version) - withContext(ioDispatcher) { install(installer) } - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.w("Update to ${info.version} failed", e) - _state.value = AppUpdateState.Failed(info.version, e.message ?: e::class.simpleName.orEmpty()) - } - } - } - - override fun dismiss() { - val current = _state.value as? AppUpdateState.Available ?: return - _state.value = current.copy(dismissed = true) - scope.launch { preferences.dismiss(current.version) } - } -} diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdatePreferences.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdatePreferences.kt deleted file mode 100644 index f51ea815c..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdatePreferences.kt +++ /dev/null @@ -1,19 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore - -/** The two settings the updater reads, narrowed so the updater can be driven by an in-memory fake. */ -interface UpdatePreferences { - val automaticChecks: Boolean - val dismissedVersion: String? - suspend fun dismiss(version: String) -} - -class GlobalSettingsUpdatePreferences(private val store: GlobalSettingsStore) : UpdatePreferences { - override val automaticChecks: Boolean get() = store.globalSettings.automaticUpdateChecks - override val dismissedVersion: String? get() = store.globalSettings.dismissedUpdateVersion - - override suspend fun dismiss(version: String) { - store.updateSettings { it.copy(dismissedUpdateVersion = version) } - } -} diff --git a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupport.kt b/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupport.kt deleted file mode 100644 index 69b66d647..000000000 --- a/desktop/src/jvmMain/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupport.kt +++ /dev/null @@ -1,69 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.base.BuildMetadata -import com.darkrockstudios.apps.hammer.base.DistributionChannel -import com.darkrockstudios.apps.hammer.base.PackageFormat -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdater -import com.darkrockstudios.apps.hammer.common.data.appupdate.NoOpAppUpdater -import dev.nucleusframework.updater.NucleusUpdater -import kotlinx.coroutines.CoroutineScope -import kotlin.coroutines.CoroutineContext - -/** Only the direct-download vehicles update themselves; every store updates the app itself. */ -fun channelMayUpdate(channel: DistributionChannel): Boolean = - channel == DistributionChannel.GITHUB || channel == DistributionChannel.APPIMAGE - -/** - * The Nucleus executable type whose release asset this install updates from, or null when the - * format has no self-update path at all. The EXE is a wrapped MSI, so the MSI upgrades either. - * The DMG and PKG both leave a bundle that only a signed, notarized zip could swap, and the - * release has no such zip yet, so they are told about releases without downloading them. - */ -fun nucleusExecutableType(format: PackageFormat): String? = when (format) { - PackageFormat.MSI, PackageFormat.EXE -> "msi" - PackageFormat.DEB -> "deb" - PackageFormat.RPM -> "rpm" - PackageFormat.APPIMAGE -> "appimage" - PackageFormat.DMG, PackageFormat.PKG -> "dmg" - PackageFormat.NONE, PackageFormat.MSIX, PackageFormat.SNAP, PackageFormat.FLATPAK -> null -} - -/** Formats Nucleus installs and relaunches on its own; the rest are told and sent to the release page. */ -fun canInstallInPlace(format: PackageFormat): Boolean = when (format) { - PackageFormat.MSI, PackageFormat.EXE, PackageFormat.DEB, PackageFormat.RPM, PackageFormat.APPIMAGE -> true - PackageFormat.NONE, PackageFormat.DMG, PackageFormat.PKG, PackageFormat.MSIX, - PackageFormat.SNAP, PackageFormat.FLATPAK -> false -} - -/** - * Thar be dragons: this is the only place a [NucleusUpdater] may be constructed. Its constructor - * opens a `java.net.http.HttpClient`, whose NIO selector crashes under the MSIX sandbox (the - * same bug that moved Ktor to OkHttp in #938), so it must never be built on a store channel, - * not even to read a version. - */ -fun createAppUpdater( - channel: DistributionChannel, - format: PackageFormat, - devMode: Boolean, - preferences: UpdatePreferences, - appScope: CoroutineScope, - ioDispatcher: CoroutineContext, - currentVersion: String = BuildMetadata.APP_VERSION, -): AppUpdater { - if (!channelMayUpdate(channel) || devMode) return NoOpAppUpdater - val executableType = nucleusExecutableType(format) ?: return NoOpAppUpdater - - val updater = NucleusUpdater { - this.currentVersion = currentVersion - provider = HammerReleaseProvider() - this.executableType = executableType - differentialDownload = false - } - return NucleusAppUpdater( - updater = updater, - installable = canInstallInPlace(format), - preferences = preferences, - scope = appScope, - ioDispatcher = ioDispatcher, - ).also { it.start() } -} diff --git a/desktop/src/jvmMain/resources/aboutlibraries.json b/desktop/src/jvmMain/resources/aboutlibraries.json index dc40e814d..ed5fd6c06 100644 --- a/desktop/src/jvmMain/resources/aboutlibraries.json +++ b/desktop/src/jvmMain/resources/aboutlibraries.json @@ -199,10 +199,10 @@ }, { "uniqueId": "androidx.lifecycle:lifecycle-common-jvm", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle-Common", "description": "Android Lifecycle-Common", - "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0", + "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0", "developers": [ { "name": "The Android Open Source Project" @@ -224,10 +224,10 @@ }, { "uniqueId": "androidx.lifecycle:lifecycle-runtime-compose-desktop", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle Runtime Compose", "description": "Compose integration with Lifecycle", - "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0", + "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0", "developers": [ { "name": "The Android Open Source Project" @@ -249,10 +249,10 @@ }, { "uniqueId": "androidx.lifecycle:lifecycle-runtime-desktop", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle Runtime", "description": "Android Lifecycle Runtime", - "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0", + "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0", "developers": [ { "name": "The Android Open Source Project" @@ -274,10 +274,10 @@ }, { "uniqueId": "androidx.lifecycle:lifecycle-viewmodel-desktop", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle ViewModel", "description": "Android Lifecycle ViewModel", - "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0", + "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0", "developers": [ { "name": "The Android Open Source Project" @@ -299,10 +299,10 @@ }, { "uniqueId": "androidx.lifecycle:lifecycle-viewmodel-savedstate-desktop", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle ViewModel with SavedState", "description": "Android Lifecycle ViewModel", - "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.11.0", + "website": "https://developer.android.com/jetpack/androidx/releases/lifecycle#2.10.0", "developers": [ { "name": "The Android Open Source Project" @@ -531,35 +531,13 @@ "licenses": [ "MIT" ], - "funding": [ - ] - }, - { - "uniqueId": "com.darkrockstudios:cairn-desktop", - "artifactVersion": "0.2.2", - "name": "Cairn", - "description": "A Compose Multiplatform About screen for the Dark Rock Studios family of apps.", - "website": "https://github.com/Wavesonics/Cairn", - "developers": [ - { - "name": "Adam Brown" - } - ], - "scm": { - "connection": "scm:git:git://github.com/Wavesonics/Cairn.git", - "developerConnection": "scm:git:ssh://github.com/Wavesonics/Cairn.git", - "url": "https://github.com/Wavesonics/Cairn" - }, - "licenses": [ - "Apache-2.0" - ], "funding": [ ] }, { "uniqueId": "com.darkrockstudios:composetexteditor-desktop", - "artifactVersion": "2.4.3", + "artifactVersion": "2.3.1", "name": "Compose Text Editor", "description": "A Kotlin Multiplatform Text Editor.", "website": "https://github.com/Darkrock-Studios/ComposeTextEditor", @@ -582,7 +560,7 @@ }, { "uniqueId": "com.darkrockstudios:composetexteditor-find-desktop", - "artifactVersion": "2.4.3", + "artifactVersion": "2.3.1", "name": "Compose Text Editor Find", "description": "Find functionality addon for Compose Text Editor.", "website": "https://github.com/Darkrock-Studios/ComposeTextEditor", @@ -605,7 +583,7 @@ }, { "uniqueId": "com.darkrockstudios:composetexteditor-spellcheck-desktop", - "artifactVersion": "2.4.3", + "artifactVersion": "2.3.1", "name": "Compose Text Editor Spell Check", "description": "Spell checking addon for Compose Text Editor.", "website": "https://github.com/Darkrock-Studios/ComposeTextEditor", @@ -651,19 +629,19 @@ }, { "uniqueId": "com.darkrockstudios:platform-spellcheckerkt-desktop", - "artifactVersion": "1.4.0", + "artifactVersion": "1.3.1", "name": "PlatformSpellChecker", "description": "A Kotlin Multiplatform library providing spell checking functionality for Android, iOS, and Desktop platforms", - "website": "https://github.com/Darkrock-Studios/PlatformSpellCheckerKt", + "website": "https://github.com/Wavesonics/PlatformSpellCheckerKt", "developers": [ { "name": "Adam Brown" } ], "scm": { - "connection": "scm:git:git://github.com/Darkrock-Studios/PlatformSpellCheckerKt.git", - "developerConnection": "scm:git:ssh://github.com/Darkrock-Studios/PlatformSpellCheckerKt.git", - "url": "https://github.com/Darkrock-Studios/PlatformSpellCheckerKt" + "connection": "scm:git:git://github.com/Wavesonics/PlatformSpellCheckerKt.git", + "developerConnection": "scm:git:ssh://github.com/Wavesonics/PlatformSpellCheckerKt.git", + "url": "https://github.com/Wavesonics/PlatformSpellCheckerKt" }, "licenses": [ "MIT" @@ -741,72 +719,6 @@ ] }, - { - "uniqueId": "com.fleeksoft.charset:charset-jvm", - "artifactVersion": "0.0.8", - "name": "charset", - "description": "Kotlin Multiplatform Charsets", - "website": "https://github.com/fleeksoft/charset", - "developers": [ - { - "name": "Sabeeh Ul Hussnain Anjum" - } - ], - "scm": { - "connection": "https://github.com/fleeksoft/charset.git", - "url": "https://github.com/fleeksoft/charset" - }, - "licenses": [ - "Apache-2.0" - ], - "funding": [ - - ] - }, - { - "uniqueId": "com.fleeksoft.io:io-core-jvm", - "artifactVersion": "0.0.8", - "name": "io-core", - "description": "Kotlin Multiplatform IO", - "website": "https://github.com/fleeksoft/fleeksoft-io", - "developers": [ - { - "name": "Sabeeh Ul Hussnain Anjum" - } - ], - "scm": { - "connection": "https://github.com/fleeksoft/fleeksoft-io.git", - "url": "https://github.com/fleeksoft/fleeksoft-io" - }, - "licenses": [ - "Apache-2.0" - ], - "funding": [ - - ] - }, - { - "uniqueId": "com.fleeksoft.ksoup:ksoup-jvm", - "artifactVersion": "0.2.6", - "name": "ksoup", - "description": "Ksoup is a Kotlin Multiplatform library for working with HTML and XML, and offers an easy-to-use API for URL fetching, data parsing, extraction, and manipulation using DOM and CSS selectors.", - "website": "https://github.com/fleeksoft/ksoup", - "developers": [ - { - "name": "Sabeeh Ul Hussnain Anjum" - } - ], - "scm": { - "connection": "https://github.com/fleeksoft/ksoup.git", - "url": "https://github.com/fleeksoft/ksoup" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, { "uniqueId": "com.github.ajalt.clikt:clikt-core-jvm", "artifactVersion": "5.1.0", @@ -1387,19 +1299,19 @@ }, { "uniqueId": "com.squareup.okio:okio-jvm", - "artifactVersion": "3.18.1", + "artifactVersion": "3.17.0", "name": "okio", "description": "A modern I/O library for Android, Java, and Kotlin Multiplatform.", - "website": "https://github.com/lysine-dev/okio/", + "website": "https://github.com/square/okio/", "developers": [ { "name": "Square, Inc." } ], "scm": { - "connection": "scm:git:git://github.com/lysine-dev/okio.git", - "developerConnection": "scm:git:ssh://git@github.com/lysine-dev/okio.git", - "url": "https://github.com/lysine-dev/okio/" + "connection": "scm:git:git://github.com/square/okio.git", + "developerConnection": "scm:git:ssh://git@github.com/square/okio.git", + "url": "https://github.com/square/okio/" }, "licenses": [ "Apache-2.0" @@ -1521,328 +1433,6 @@ ] }, - { - "uniqueId": "dev.nucleusframework:nucleus.aot-runtime", - "artifactVersion": "2.4.4", - "name": "Nucleus AOT Runtime", - "description": "AOT runtime library for the Nucleus Gradle plugin", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.core-runtime", - "artifactVersion": "2.4.4", - "name": "Nucleus Core Runtime", - "description": "Core runtime library for the Nucleus Gradle plugin", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.darkmode-detector", - "artifactVersion": "2.4.4", - "name": "Nucleus Dark Mode Detector", - "description": "Reactive dark mode detection for Compose Desktop across Windows, macOS and Linux", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.decorated-window-awt", - "artifactVersion": "2.4.4", - "name": "Nucleus Decorated Window AWT", - "description": "AWT/Compose Desktop integration of Nucleus Decorated Window (consumed by JBR and JNI backends)", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.decorated-window-core", - "artifactVersion": "2.4.4", - "name": "Nucleus Decorated Window Core", - "description": "Shared types, layout, styling, and resources for Nucleus Decorated Window", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.decorated-window-material3", - "artifactVersion": "2.4.4", - "name": "Nucleus Material Decorated Window", - "description": "Material 3 integration for Nucleus Decorated Window", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.decorated-window-tao", - "artifactVersion": "2.4.4", - "name": "Nucleus Decorated Window Tao", - "description": "Experimental no-AWT decorated window backend for Compose Desktop, powered by Tao via direct JNI for macOS, Windows, and Linux.", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.freedesktop-icons", - "artifactVersion": "2.4.4", - "name": "Nucleus Freedesktop Icons", - "description": "Type-safe freedesktop icon naming specification constants for JVM desktop applications", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.graalvm-runtime", - "artifactVersion": "2.4.4", - "name": "Nucleus GraalVM Runtime", - "description": "GraalVM native-image runtime initialization and font manager substitutions", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.launcher-linux", - "artifactVersion": "2.4.4", - "name": "Nucleus Launcher Linux", - "description": "Unity Launcher API (com.canonical.Unity.LauncherEntry) for JVM desktop applications via JNI", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.launcher-macos", - "artifactVersion": "2.4.4", - "name": "Nucleus Launcher macOS", - "description": "macOS dock context menu for JVM desktop applications via JNI", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.launcher-windows", - "artifactVersion": "2.4.4", - "name": "Nucleus Launcher Windows", - "description": "Windows Launcher API (Badge Notifications) for JVM desktop applications via JNI", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.linux-hidpi", - "artifactVersion": "2.4.4", - "name": "Nucleus Linux HiDPI", - "description": "Native HiDPI scale factor detection for Compose Desktop on Linux (GSettings, GDK_SCALE, Xft.dpi)", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, - { - "uniqueId": "dev.nucleusframework:nucleus.nucleus-application", - "artifactVersion": "2.4.4", - "name": "Nucleus Application", - "description": "Unified entry point picking the decorated-window backend (JBR/JNI AWT or no-AWT Tao) and exposing a backend-agnostic window handle.", - "website": "https://github.com/NucleusFramework/Nucleus", - "developers": [ - { - "name": "NucleusFramework" - } - ], - "scm": { - "connection": "scm:git:git://github.com/NucleusFramework/Nucleus.git", - "developerConnection": "scm:git:ssh://git@github.com/NucleusFramework/Nucleus.git", - "url": "https://github.com/NucleusFramework/Nucleus" - }, - "licenses": [ - "MIT" - ], - "funding": [ - - ] - }, { "uniqueId": "io.coil-kt.coil3:coil-compose-core-jvm", "artifactVersion": "3.5.0", @@ -2003,6 +1593,213 @@ ] }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.core-runtime", + "artifactVersion": "1.15.7", + "name": "Nucleus Core Runtime", + "description": "Core runtime library for the Nucleus Gradle plugin", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.darkmode-detector", + "artifactVersion": "1.15.7", + "name": "Nucleus Dark Mode Detector", + "description": "Reactive dark mode detection for Compose Desktop across Windows, macOS and Linux", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.decorated-window-core", + "artifactVersion": "1.15.7", + "name": "Nucleus Decorated Window Core", + "description": "Shared types, layout, styling, and resources for Nucleus Decorated Window", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.decorated-window-jbr", + "artifactVersion": "1.15.7", + "name": "Nucleus Decorated Window JBR", + "description": "JBR-based custom decorated window with native title bar for Compose Desktop", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.decorated-window-material3", + "artifactVersion": "1.15.7", + "name": "Nucleus Material Decorated Window", + "description": "Material 3 integration for Nucleus Decorated Window", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.freedesktop-icons", + "artifactVersion": "1.15.7", + "name": "Nucleus Freedesktop Icons", + "description": "Type-safe freedesktop icon naming specification constants for JVM desktop applications", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.launcher-linux", + "artifactVersion": "1.15.7", + "name": "Nucleus Launcher Linux", + "description": "Unity Launcher API (com.canonical.Unity.LauncherEntry) for JVM desktop applications via JNI", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.launcher-macos", + "artifactVersion": "1.15.7", + "name": "Nucleus Launcher macOS", + "description": "macOS dock context menu for JVM desktop applications via JNI", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, + { + "uniqueId": "io.github.kdroidfilter:nucleus.launcher-windows", + "artifactVersion": "1.15.7", + "name": "Nucleus Launcher Windows", + "description": "Windows Launcher API (Badge Notifications) for JVM desktop applications via JNI", + "website": "https://github.com/kdroidFilter/Nucleus", + "developers": [ + { + "name": "kdroidFilter" + } + ], + "scm": { + "connection": "scm:git:git://github.com/kdroidFilter/Nucleus.git", + "developerConnection": "scm:git:ssh://git@github.com/kdroidFilter/Nucleus.git", + "url": "https://github.com/kdroidFilter/Nucleus" + }, + "licenses": [ + "MIT" + ], + "funding": [ + + ] + }, { "uniqueId": "io.github.koalaplot:koalaplot-core-desktop", "artifactVersion": "0.11.2", @@ -2028,7 +1825,7 @@ }, { "uniqueId": "io.github.pdvrieze.xmlutil:core-jvm", - "artifactVersion": "1.0.2", + "artifactVersion": "1.0.1", "name": "core", "description": "Component of the XMLUtil library", "website": "https://github.com/pdvrieze/xmlutil", @@ -2094,9 +1891,32 @@ ] }, + { + "uniqueId": "io.github.sudarshanmhasrup.splashify:splashify-desktop", + "artifactVersion": "1.0.0-alpha1", + "name": "Splashify", + "description": "A Kotlin Multiplatform library for effortless, customizable splash screens in Compose Multiplatform desktop apps.", + "website": "https://github.com/sudarshanmhasrup/splashify", + "developers": [ + { + "name": "Sudarshan Mhasrup" + } + ], + "scm": { + "connection": "scm:git:https://github.com/sudarshanmhasrup/splashify.git", + "developerConnection": "scm:git:ssh://git@github.com/sudarshanmhasrup/splashify.git", + "url": "https://github.com/sudarshanmhasrup/splashify" + }, + "licenses": [ + "Apache-2.0" + ], + "funding": [ + + ] + }, { "uniqueId": "io.github.vinceglb:filekit-core-jvm", - "artifactVersion": "0.15.0", + "artifactVersion": "0.14.2", "name": "FileKit", "description": "Files, Media, Folder Picker and File saver library for Kotlin Multiplatform and Compose Multiplatform", "website": "https://github.com/vinceglb/FileKit", @@ -2141,7 +1961,7 @@ }, { "uniqueId": "io.ktor:ktor-client-auth-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-auth", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2163,7 +1983,7 @@ }, { "uniqueId": "io.ktor:ktor-client-content-negotiation-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-content-negotiation", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2185,7 +2005,7 @@ }, { "uniqueId": "io.ktor:ktor-client-core-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-core", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2207,7 +2027,7 @@ }, { "uniqueId": "io.ktor:ktor-client-encoding-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-encoding", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2229,7 +2049,7 @@ }, { "uniqueId": "io.ktor:ktor-client-java-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-java", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2251,7 +2071,7 @@ }, { "uniqueId": "io.ktor:ktor-client-logging-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-client-logging", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2273,7 +2093,7 @@ }, { "uniqueId": "io.ktor:ktor-events-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-events", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2295,7 +2115,7 @@ }, { "uniqueId": "io.ktor:ktor-http-cio-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-http-cio", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2317,7 +2137,7 @@ }, { "uniqueId": "io.ktor:ktor-http-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-http", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2339,7 +2159,7 @@ }, { "uniqueId": "io.ktor:ktor-io-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-io", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2361,7 +2181,7 @@ }, { "uniqueId": "io.ktor:ktor-network-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-network", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2383,7 +2203,7 @@ }, { "uniqueId": "io.ktor:ktor-serialization-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-serialization", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2405,7 +2225,7 @@ }, { "uniqueId": "io.ktor:ktor-serialization-kotlinx-json-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-serialization-kotlinx-json", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2427,7 +2247,7 @@ }, { "uniqueId": "io.ktor:ktor-serialization-kotlinx-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-serialization-kotlinx", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2449,7 +2269,7 @@ }, { "uniqueId": "io.ktor:ktor-sse-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-sse", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2471,7 +2291,7 @@ }, { "uniqueId": "io.ktor:ktor-utils-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-utils", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2493,7 +2313,7 @@ }, { "uniqueId": "io.ktor:ktor-websocket-serialization-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-websocket-serialization", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2515,7 +2335,7 @@ }, { "uniqueId": "io.ktor:ktor-websockets-jvm", - "artifactVersion": "3.5.2", + "artifactVersion": "3.5.1", "name": "ktor-websockets", "description": "Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.", "website": "https://github.com/ktorio/ktor", @@ -2636,7 +2456,7 @@ }, { "uniqueId": "no.synth:kmp-zip-jvm", - "artifactVersion": "0.13.0", + "artifactVersion": "0.12.2", "name": "kmp-zip", "description": "Kotlin Multiplatform ZIP streams for JVM, iOS, macOS, Linux, Windows, and Wasm/JS", "website": "https://github.com/henrik242/kmp-zip", @@ -2659,7 +2479,7 @@ }, { "uniqueId": "no.synth:kmp-zip-okio-jvm", - "artifactVersion": "0.13.0", + "artifactVersion": "0.12.2", "name": "kmp-zip-okio", "description": "OkIO BufferedSource/BufferedSink adapters for kmp-zip ZipInputStream and ZipOutputStream", "website": "https://github.com/henrik242/kmp-zip", @@ -2960,11 +2780,11 @@ ] }, { - "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-common-jvm", - "artifactVersion": "2.11.0", + "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-common", + "artifactVersion": "2.10.0", "name": "Lifecycle-Common", "description": "Android Lifecycle-Common", - "website": "https://github.com/JetBrains/compose-multiplatform", + "website": "https://github.com/JetBrains/compose-jb", "developers": [ { "name": "Compose Multiplatform Team", @@ -2972,9 +2792,33 @@ } ], "scm": { - "connection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "developerConnection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "url": "https://github.com/JetBrains/compose-multiplatform" + "connection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "developerConnection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "url": "https://github.com/JetBrains/compose-jb" + }, + "licenses": [ + "Apache-2.0" + ], + "funding": [ + + ] + }, + { + "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-runtime", + "artifactVersion": "2.10.0", + "name": "Lifecycle Runtime", + "description": "Android Lifecycle Runtime", + "website": "https://github.com/JetBrains/compose-jb", + "developers": [ + { + "name": "Compose Multiplatform Team", + "organisationUrl": "https://www.jetbrains.com" + } + ], + "scm": { + "connection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "developerConnection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "url": "https://github.com/JetBrains/compose-jb" }, "licenses": [ "Apache-2.0" @@ -2985,10 +2829,10 @@ }, { "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-runtime-compose-desktop", - "artifactVersion": "2.11.0", + "artifactVersion": "2.10.0", "name": "Lifecycle Runtime Compose", "description": "Compose integration with Lifecycle", - "website": "https://github.com/JetBrains/compose-multiplatform", + "website": "https://github.com/JetBrains/compose-jb", "developers": [ { "name": "Compose Multiplatform Team", @@ -2996,9 +2840,9 @@ } ], "scm": { - "connection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "developerConnection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "url": "https://github.com/JetBrains/compose-multiplatform" + "connection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "developerConnection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "url": "https://github.com/JetBrains/compose-jb" }, "licenses": [ "Apache-2.0" @@ -3008,35 +2852,11 @@ ] }, { - "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-runtime-desktop", - "artifactVersion": "2.11.0", - "name": "Lifecycle Runtime", - "description": "Android Lifecycle Runtime", - "website": "https://github.com/JetBrains/compose-multiplatform", - "developers": [ - { - "name": "Compose Multiplatform Team", - "organisationUrl": "https://www.jetbrains.com" - } - ], - "scm": { - "connection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "developerConnection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "url": "https://github.com/JetBrains/compose-multiplatform" - }, - "licenses": [ - "Apache-2.0" - ], - "funding": [ - - ] - }, - { - "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-desktop", - "artifactVersion": "2.11.0", + "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel", + "artifactVersion": "2.10.0", "name": "Lifecycle ViewModel", "description": "Android Lifecycle ViewModel", - "website": "https://github.com/JetBrains/compose-multiplatform", + "website": "https://github.com/JetBrains/compose-jb", "developers": [ { "name": "Compose Multiplatform Team", @@ -3044,9 +2864,9 @@ } ], "scm": { - "connection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "developerConnection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "url": "https://github.com/JetBrains/compose-multiplatform" + "connection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "developerConnection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "url": "https://github.com/JetBrains/compose-jb" }, "licenses": [ "Apache-2.0" @@ -3056,11 +2876,11 @@ ] }, { - "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-savedstate-desktop", - "artifactVersion": "2.11.0", + "uniqueId": "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-savedstate", + "artifactVersion": "2.9.6", "name": "Lifecycle ViewModel with SavedState", "description": "Android Lifecycle ViewModel", - "website": "https://github.com/JetBrains/compose-multiplatform", + "website": "https://github.com/JetBrains/compose-jb", "developers": [ { "name": "Compose Multiplatform Team", @@ -3068,9 +2888,9 @@ } ], "scm": { - "connection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "developerConnection": "scm:git:https://github.com/JetBrains/compose-multiplatform.git", - "url": "https://github.com/JetBrains/compose-multiplatform" + "connection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "developerConnection": "scm:git:https://github.com/JetBrains/compose-jb.git", + "url": "https://github.com/JetBrains/compose-jb" }, "licenses": [ "Apache-2.0" @@ -4180,7 +4000,7 @@ }, { "uniqueId": "org.jetbrains.kotlinx:kotlinx-io-bytestring-jvm", - "artifactVersion": "0.9.1", + "artifactVersion": "0.9.0", "name": "kotlinx-io-bytestring", "description": "IO support for Kotlin", "website": "https://github.com/Kotlin/kotlinx-io", @@ -4202,7 +4022,7 @@ }, { "uniqueId": "org.jetbrains.kotlinx:kotlinx-io-core-jvm", - "artifactVersion": "0.9.1", + "artifactVersion": "0.9.0", "name": "kotlinx-io-core", "description": "IO support for Kotlin", "website": "https://github.com/Kotlin/kotlinx-io", @@ -4312,7 +4132,7 @@ }, { "uniqueId": "org.jetbrains.runtime:jbr-api", - "artifactVersion": "1.9.0", + "artifactVersion": "1.10.1", "name": "jbr-api", "description": "Interface for the functionality specific to https://github.com/JetBrains/JetBrainsRuntime", "website": "https://github.com/JetBrains/JetBrainsRuntimeApi", @@ -4455,7 +4275,7 @@ }, { "uniqueId": "org.jetbrains:markdown-jvm", - "artifactVersion": "0.7.8", + "artifactVersion": "0.7.7", "name": "markdown", "description": "Markdown parser in Kotlin", "website": "https://github.com/JetBrains/markdown", diff --git a/desktop/src/jvmMain/resources/icon.png b/desktop/src/jvmMain/resources/icon.png new file mode 100644 index 000000000..41a2becc0 Binary files /dev/null and b/desktop/src/jvmMain/resources/icon.png differ diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcutsTest.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcutsTest.kt deleted file mode 100644 index 901a41864..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/WindowShortcutsTest.kt +++ /dev/null @@ -1,101 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop - -import androidx.compose.ui.InternalComposeUiApi -import androidx.compose.ui.input.key.Key -import androidx.compose.ui.input.key.KeyEvent -import androidx.compose.ui.input.key.KeyEventType -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull - -@OptIn(InternalComposeUiApi::class) -class WindowShortcutsTest { - - private fun keyDown( - key: Key, - ctrl: Boolean = false, - meta: Boolean = false, - alt: Boolean = false, - shift: Boolean = false, - ) = KeyEvent( - key = key, - type = KeyEventType.KeyDown, - isCtrlPressed = ctrl, - isMetaPressed = meta, - isAltPressed = alt, - isShiftPressed = shift, - ) - - @Test - fun `ctrl Q quits from the project selection window`() { - assertEquals(WindowShortcut.Quit, keyDown(Key.Q, ctrl = true).toProjectSelectionShortcut()) - } - - @Test - fun `cmd Q quits from the project selection window`() { - assertEquals(WindowShortcut.Quit, keyDown(Key.Q, meta = true).toProjectSelectionShortcut()) - } - - @Test - fun `AltGr Q types an at sign instead of quitting`() { - val altGrQ = keyDown(Key.Q, ctrl = true, alt = true) - - assertNull(altGrQ.toProjectSelectionShortcut()) - assertNull(altGrQ.toProjectEditorShortcut()) - } - - @Test - fun `AltGr W does not close the project`() { - assertNull(keyDown(Key.W, ctrl = true, alt = true).toProjectEditorShortcut()) - } - - @Test - fun `ctrl W closes the project`() { - assertEquals(WindowShortcut.CloseProject, keyDown(Key.W, ctrl = true).toProjectEditorShortcut()) - } - - @Test - fun `ctrl shift F opens global search`() { - assertEquals( - WindowShortcut.GlobalSearch, - keyDown(Key.F, ctrl = true, shift = true).toProjectEditorShortcut(), - ) - } - - @Test - fun `escape navigates back on key up only`() { - val keyUp = KeyEvent(key = Key.Escape, type = KeyEventType.KeyUp) - - assertEquals(WindowShortcut.Back, keyUp.toProjectSelectionShortcut()) - assertEquals(WindowShortcut.Back, keyUp.toProjectEditorShortcut()) - assertNull(keyDown(Key.Escape).toProjectEditorShortcut()) - } - - @Test - fun `unmodified keys are not shortcuts`() { - assertNull(keyDown(Key.Q).toProjectSelectionShortcut()) - assertNull(keyDown(Key.W).toProjectEditorShortcut()) - } - - @Test - fun `F3 starts a project sync`() { - assertEquals(ProjectShortcut.SyncProject, keyDown(Key.F3).toProjectShortcut()) - assertNull(keyDown(Key.F3, ctrl = true).toProjectShortcut()) - } - - @Test - fun `ctrl shift S saves all buffers`() { - assertEquals( - ProjectShortcut.SaveAll, - keyDown(Key.S, ctrl = true, shift = true).toProjectShortcut(), - ) - } - - @Test - fun `AltGr S types its character instead of saving`() { - assertNull(keyDown(Key.S, ctrl = true, alt = true).toProjectShortcut()) - assertNull( - keyDown(Key.S, ctrl = true, alt = true, shift = true).toProjectShortcut(), - ) - } -} diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStringsTest.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStringsTest.kt deleted file mode 100644 index 499003cce..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/sandbox/SandboxStringsTest.kt +++ /dev/null @@ -1,120 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.sandbox - -import java.util.Locale -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotEquals -import kotlin.test.assertNull -import kotlin.test.assertTrue - -/** - * [SandboxStrings] reads a Compose Resources implementation detail (the `.cvr` - * value files). These tests are the tripwire for that coupling: if a Compose - * upgrade changes the format or the resource path, the first-run dialogs would - * silently degrade to showing raw key names, and only on a Mac App Store first - * launch. Catch it here instead. - */ -class SandboxStringsTest { - - @Test - fun `every first-run dialog key resolves to real text`() { - val keys = listOf( - SandboxStrings.INTRO_TITLE, - SandboxStrings.INTRO_MESSAGE, - SandboxStrings.PICKER_TITLE, - SandboxStrings.CHOOSE_FOLDER_BUTTON, - SandboxStrings.QUIT_BUTTON, - SandboxStrings.RETRY_MESSAGE, - ) - keys.forEach { key -> - val value = SandboxStrings.get(key) - // get() falls back to the key name, so equality means it failed to load. - assertNotEquals(key, value, "'$key' did not resolve from the packaged value files") - assertTrue(value.isNotBlank(), "'$key' resolved to blank text") - } - } - - @Test - fun `english values load and match the known source text`() { - val strings = SandboxStrings.load(Locale.ENGLISH) - assertEquals("Welcome to Hammer", strings[SandboxStrings.INTRO_TITLE]) - assertEquals("Choose Folder", strings[SandboxStrings.CHOOSE_FOLDER_BUTTON]) - assertEquals("Quit", strings[SandboxStrings.QUIT_BUTTON]) - } - - @Test - fun `a translated locale resolves to its own text`() { - // French is checked in rather than generated, so it is a stable fixture. - val french = SandboxStrings.load(Locale.FRENCH) - val english = SandboxStrings.load(Locale.ENGLISH) - assertNotEquals( - english[SandboxStrings.INTRO_TITLE], - french[SandboxStrings.INTRO_TITLE], - "French should not fall back to the English value file", - ) - } - - @Test - fun `a translation missing a key still resolves it from english`() { - // Translated value files run behind the English one — the encyclopedia - // strings already differ by two keys — so every locale must layer English - // underneath rather than replace it, or an untranslated key would render - // as its own name in the first-run dialog. - val english = SandboxStrings.load(Locale.ENGLISH) - listOf(Locale.FRENCH, Locale.GERMAN, Locale.ITALIAN).forEach { locale -> - val strings = SandboxStrings.load(locale) - english.keys.forEach { key -> - assertTrue( - strings[key]?.isNotBlank() == true, - "'$key' is missing from $locale instead of falling back to English", - ) - } - } - } - - @Test - fun `unknown locale falls back to english`() { - val strings = SandboxStrings.load(Locale.forLanguageTag("zz")) - assertEquals("Welcome to Hammer", strings[SandboxStrings.INTRO_TITLE]) - } - - @Test - fun `candidate dirs go most specific first and end at the default`() { - assertEquals( - listOf("values-pt-rBR", "values-pt", "values"), - SandboxStrings.candidateDirs(Locale.forLanguageTag("pt-BR")), - ) - assertEquals(listOf("values-fr", "values"), SandboxStrings.candidateDirs(Locale.FRENCH)) - } - - @Test - fun `multi-line values survive the line-based parse`() { - // Values are base64 on one line each, so an embedded newline must round-trip. - val encoded = java.util.Base64.getEncoder().encodeToString("first\nsecond".toByteArray()) - val parsed = SandboxStrings.parse("version:0\nstring|multiline|$encoded") - assertEquals("first\nsecond", parsed?.get("multiline")) - } - - @Test - fun `an unsupported file version is rejected rather than half-parsed`() { - val encoded = java.util.Base64.getEncoder().encodeToString("value".toByteArray()) - assertNull(SandboxStrings.parse("version:99\nstring|key|$encoded")) - } - - @Test - fun `malformed lines are skipped without failing the whole file`() { - val encoded = java.util.Base64.getEncoder().encodeToString("kept".toByteArray()) - val parsed = SandboxStrings.parse( - """ - version:0 - garbage-with-no-delimiters - plural|ignored_type|$encoded - string|good|$encoded - string|bad_base64|!!!not-base64!!! - """.trimIndent() - ) - assertEquals("kept", parsed?.get("good")) - assertNull(parsed?.get("ignored_type")) - assertNull(parsed?.get("bad_base64")) - } -} diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/FakeUpdatePreferences.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/FakeUpdatePreferences.kt deleted file mode 100644 index b199fdaab..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/FakeUpdatePreferences.kt +++ /dev/null @@ -1,10 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -class FakeUpdatePreferences( - override var automaticChecks: Boolean = true, - override var dismissedVersion: String? = null, -) : UpdatePreferences { - override suspend fun dismiss(version: String) { - dismissedVersion = version - } -} diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProviderTest.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProviderTest.kt deleted file mode 100644 index 048e32f9d..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/HammerReleaseProviderTest.kt +++ /dev/null @@ -1,66 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import dev.nucleusframework.core.runtime.Platform -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test - -class HammerReleaseProviderTest { - - @AfterEach - fun clearOverride() { - System.clearProperty(HammerReleaseProvider.BASE_URL_PROPERTY) - } - - @Test - fun `metadata lives on the latest release, one file per platform`() { - val provider = HammerReleaseProvider() - val base = "https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download" - - assertEquals("$base/latest.yml", provider.getUpdateMetadataUrl("latest", Platform.Windows)) - assertEquals("$base/latest-mac.yml", provider.getUpdateMetadataUrl("latest", Platform.MacOS)) - assertEquals("$base/latest-linux.yml", provider.getUpdateMetadataUrl("latest", Platform.Linux)) - assertEquals("$base/latest.yml", provider.getUpdateMetadataUrl("latest", Platform.Unknown)) - } - - @Test - fun `downloads ignore the version and use the fixed asset name`() { - val provider = HammerReleaseProvider() - - assertEquals( - "https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download/hammer.msi", - provider.getDownloadUrl("hammer.msi", "3.12.0"), - ) - } - - @Test - fun `a system property substitutes a local server`() { - System.setProperty(HammerReleaseProvider.BASE_URL_PROPERTY, "http://localhost:8000/") - val provider = HammerReleaseProvider() - - assertEquals("http://localhost:8000/latest.yml", provider.getUpdateMetadataUrl("latest", Platform.Windows)) - assertEquals("http://localhost:8000/hammer.deb", provider.getDownloadUrl("hammer.deb", "1.0.0")) - } - - @Test - fun `a blank override falls back to GitHub`() { - System.setProperty(HammerReleaseProvider.BASE_URL_PROPERTY, " ") - - assertEquals( - "https://github.com/Darkrock-Studios/hammer-editor/releases/latest/download", - HammerReleaseProvider.defaultBaseUrl(), - ) - } - - @Test - fun `the environment variable stands in when no property is set`() { - assertEquals( - "http://localhost:8000", - HammerReleaseProvider.defaultBaseUrl(property = null, environment = "http://localhost:8000/"), - ) - assertEquals( - "http://property:1", - HammerReleaseProvider.defaultBaseUrl(property = "http://property:1", environment = "http://env:2"), - ) - } -} diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdaterTest.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdaterTest.kt deleted file mode 100644 index d6f1a495a..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/NucleusAppUpdaterTest.kt +++ /dev/null @@ -1,273 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.common.data.appupdate.AppUpdateState -import com.sun.net.httpserver.HttpExchange -import com.sun.net.httpserver.HttpServer -import dev.nucleusframework.updater.NucleusUpdater -import kotlinx.coroutines.CompletableDeferred -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.SupervisorJob -import kotlinx.coroutines.cancel -import kotlinx.coroutines.delay -import kotlinx.coroutines.flow.first -import kotlinx.coroutines.launch -import kotlinx.coroutines.runBlocking -import kotlinx.coroutines.withTimeout -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import java.io.File -import java.net.InetSocketAddress -import java.nio.file.Files -import java.security.MessageDigest -import java.util.Base64 -import java.util.concurrent.atomic.AtomicBoolean -import kotlin.time.Duration -import kotlin.time.Duration.Companion.hours -import kotlin.time.Duration.Companion.milliseconds -import kotlin.time.Duration.Companion.seconds - -/** - * Drives the real Nucleus updater against a local HTTP server standing in for the GitHub - * release, so the check, the download and the digest check are the production code paths. - * Only the final hand-over to the installer is replaced, since the real one exits the process. - */ -class NucleusAppUpdaterTest { - - private val asset = ByteArray(60_000) { (it * 7 % 251).toByte() } - private var servedVersion = "9.9.9" - private var servedSha512 = sha512Base64(asset) - private var metadataStatus = 200 - - private lateinit var server: HttpServer - private lateinit var scope: CoroutineScope - private lateinit var cacheDir: File - - @BeforeEach - fun start() { - server = HttpServer.create(InetSocketAddress("127.0.0.1", 0), 0) - server.createContext("/") { exchange -> - val path = exchange.requestURI.path - when { - path.endsWith(".yml") && metadataStatus != 200 -> respond(exchange, metadataStatus, ByteArray(0)) - path.endsWith(".yml") -> respond(exchange, 200, metadata().toByteArray()) - path.endsWith("/hammer.msi") -> respond(exchange, 200, asset) - else -> respond(exchange, 404, ByteArray(0)) - } - } - server.start() - scope = CoroutineScope(SupervisorJob() + Dispatchers.Default) - cacheDir = Files.createTempDirectory("hammer-update-test").toFile() - } - - @AfterEach - fun stop() { - scope.cancel() - server.stop(0) - cacheDir.deleteRecursively() - } - - @Test - fun `a newer release is reported as available`() = runBlocking { - val updater = newUpdater() - - updater.checkNow() - - val available = updater.awaitState() - assertEquals(AppUpdateState.Available("9.9.9", installable = true, dismissed = false), available) - } - - @Test - fun `the installed version is up to date`() = runBlocking { - servedVersion = "1.0.0" - val updater = newUpdater() - - updater.checkNow() - - assertEquals(AppUpdateState.UpToDate, updater.awaitState()) - } - - @Test - fun `a failed check is swallowed`() = runBlocking { - metadataStatus = 503 - val updater = newUpdater() - val seen = updater.recordStates() - - updater.checkNow() - - await { seen.contains(AppUpdateState.Checking) && seen.last() == AppUpdateState.Idle } - assertFalse(seen.any { it is AppUpdateState.Failed }) - } - - @Test - fun `a release this install cannot apply is announced but not installable`() = runBlocking { - val updater = newUpdater(installable = false) - - updater.checkNow() - val available = updater.awaitState() - assertFalse(available.installable) - - updater.update() - delay(200.milliseconds) - assertEquals(available, updater.state.value) - } - - @Test - fun `a version the user dismissed stays dismissed`() = runBlocking { - val updater = newUpdater(preferences = FakeUpdatePreferences(dismissedVersion = "9.9.9")) - - updater.checkNow() - - assertTrue(updater.awaitState().dismissed) - } - - @Test - fun `dismiss hides the version and records it`() = runBlocking { - val preferences = FakeUpdatePreferences() - val updater = newUpdater(preferences = preferences) - updater.checkNow() - updater.awaitState() - - updater.dismiss() - - assertTrue((updater.state.value as AppUpdateState.Available).dismissed) - await { preferences.dismissedVersion == "9.9.9" } - } - - @Test - fun `a re-check keeps the offered release on screen`() = runBlocking { - val updater = newUpdater() - val seen = updater.recordStates() - updater.checkNow() - val offered = updater.awaitState() - val before = seen.size - - metadataStatus = 503 - updater.checkNow() - delay(500.milliseconds) - - assertEquals(offered, updater.state.value) - assertFalse(seen.drop(before).contains(AppUpdateState.Checking)) - } - - @Test - fun `update downloads, verifies, and hands the installer over`() = runBlocking { - val installed = CompletableDeferred() - val updater = newUpdater(install = { file -> installed.complete(file) }) - val seen = updater.recordStates() - updater.checkNow() - updater.awaitState() - - updater.update() - - updater.awaitState() - val file = withTimeout(TIMEOUT) { installed.await() } - assertTrue(asset.contentEquals(file.readBytes())) - assertEquals("hammer.msi", file.name) - assertTrue(seen.any { it is AppUpdateState.Downloading && it.fraction == 1f }) - // The real installer script removes its staging directory; the stand-in has to. - file.parentFile.deleteRecursively() - assertFalse(file.exists()) - } - - @Test - fun `a corrupt download fails instead of installing`() = runBlocking { - servedSha512 = sha512Base64(ByteArray(10)) - val installed = AtomicBoolean(false) - val updater = newUpdater(install = { installed.set(true) }) - updater.checkNow() - updater.awaitState() - - updater.update() - - val failed = updater.awaitState() - assertEquals("9.9.9", failed.version) - assertFalse(installed.get()) - } - - @Test - fun `automatic checks obey the preference`() = runBlocking { - val preferences = FakeUpdatePreferences(automaticChecks = false) - val updater = newUpdater( - preferences = preferences, - initialDelay = Duration.ZERO, - checkInterval = 50.milliseconds, - ) - val seen = updater.recordStates() - - updater.start() - delay(400.milliseconds) - assertFalse(seen.contains(AppUpdateState.Checking)) - assertNull(updater.state.value as? AppUpdateState.Available) - - preferences.automaticChecks = true - assertEquals("9.9.9", updater.awaitState().version) - } - - private fun newUpdater( - installable: Boolean = true, - preferences: FakeUpdatePreferences = FakeUpdatePreferences(), - initialDelay: Duration = 10.seconds, - checkInterval: Duration = 6.hours, - install: (File) -> Unit = {}, - ): NucleusAppUpdater { - val nucleus = NucleusUpdater { - currentVersion = "1.0.0" - provider = HammerReleaseProvider("http://127.0.0.1:${server.address.port}") - executableType = "msi" - differentialDownload = false - cacheDir = this@NucleusAppUpdaterTest.cacheDir - } - return NucleusAppUpdater( - updater = nucleus, - installable = installable, - preferences = preferences, - scope = scope, - ioDispatcher = Dispatchers.IO, - initialDelay = initialDelay, - checkInterval = checkInterval, - install = install, - ) - } - - private fun metadata(): String = listOf( - "version: $servedVersion", - "releaseDate: 2026-10-20T00:00:00Z", - "files:", - " - url: hammer.msi", - " sha512: $servedSha512", - " size: ${asset.size}", - ).joinToString("\n") - - private fun NucleusAppUpdater.recordStates(): List { - val seen = java.util.concurrent.CopyOnWriteArrayList() - scope.launch { state.collect { seen += it } } - return seen - } - - private suspend inline fun NucleusAppUpdater.awaitState(): T = - withTimeout(TIMEOUT) { state.first { it is T } as T } - - private suspend fun await(condition: () -> Boolean) { - withTimeout(TIMEOUT) { - while (!condition()) delay(20.milliseconds) - } - } - - private fun respond(exchange: HttpExchange, status: Int, body: ByteArray) { - exchange.sendResponseHeaders(status, if (body.isEmpty()) -1L else body.size.toLong()) - exchange.responseBody.use { it.write(body) } - } - - private fun sha512Base64(bytes: ByteArray): String = - Base64.getEncoder().encodeToString(MessageDigest.getInstance("SHA-512").digest(bytes)) - - private companion object { - val TIMEOUT = 20.seconds - } -} diff --git a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupportTest.kt b/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupportTest.kt deleted file mode 100644 index e20a94e75..000000000 --- a/desktop/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/desktop/update/UpdaterSupportTest.kt +++ /dev/null @@ -1,85 +0,0 @@ -package com.darkrockstudios.apps.hammer.desktop.update - -import com.darkrockstudios.apps.hammer.base.DistributionChannel -import com.darkrockstudios.apps.hammer.base.PackageFormat -import com.darkrockstudios.apps.hammer.common.data.appupdate.NoOpAppUpdater -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.SupervisorJob -import kotlinx.coroutines.cancel -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.Assertions.assertSame -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.Test - -class UpdaterSupportTest { - - private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Default) - - @AfterEach - fun tearDown() { - scope.cancel() - } - - @Test - fun `only the direct download channels may update`() { - val allowed = DistributionChannel.entries.filter(::channelMayUpdate) - assertEquals(listOf(DistributionChannel.GITHUB, DistributionChannel.APPIMAGE), allowed) - } - - @Test - fun `every format maps to the asset it updates from`() { - assertEquals("msi", nucleusExecutableType(PackageFormat.MSI)) - assertEquals("msi", nucleusExecutableType(PackageFormat.EXE)) - assertEquals("deb", nucleusExecutableType(PackageFormat.DEB)) - assertEquals("rpm", nucleusExecutableType(PackageFormat.RPM)) - assertEquals("appimage", nucleusExecutableType(PackageFormat.APPIMAGE)) - assertEquals("dmg", nucleusExecutableType(PackageFormat.DMG)) - assertEquals("dmg", nucleusExecutableType(PackageFormat.PKG)) - for (format in listOf(PackageFormat.NONE, PackageFormat.MSIX, PackageFormat.SNAP, PackageFormat.FLATPAK)) { - assertNull(nucleusExecutableType(format), format.token) - } - } - - @Test - fun `macOS installs are announced but not installed in place`() { - assertTrue(canInstallInPlace(PackageFormat.MSI)) - assertTrue(canInstallInPlace(PackageFormat.EXE)) - assertTrue(canInstallInPlace(PackageFormat.DEB)) - assertTrue(canInstallInPlace(PackageFormat.RPM)) - assertTrue(canInstallInPlace(PackageFormat.APPIMAGE)) - assertFalse(canInstallInPlace(PackageFormat.DMG)) - assertFalse(canInstallInPlace(PackageFormat.PKG)) - } - - @Test - fun `store channels, dev runs, and unpackaged builds get the no-op updater`() { - assertSame(NoOpAppUpdater, create(DistributionChannel.MICROSOFT_STORE, PackageFormat.MSIX)) - assertSame(NoOpAppUpdater, create(DistributionChannel.MAC_APP_STORE, PackageFormat.PKG)) - assertSame(NoOpAppUpdater, create(DistributionChannel.SNAP, PackageFormat.SNAP)) - assertSame(NoOpAppUpdater, create(DistributionChannel.DEV, PackageFormat.NONE)) - assertSame(NoOpAppUpdater, create(DistributionChannel.GITHUB, PackageFormat.NONE)) - assertSame(NoOpAppUpdater, create(DistributionChannel.GITHUB, PackageFormat.MSI, devMode = true)) - } - - @Test - fun `the GitHub and AppImage builds get a real updater`() { - assertTrue(create(DistributionChannel.GITHUB, PackageFormat.MSI) is NucleusAppUpdater) - assertTrue(create(DistributionChannel.GITHUB, PackageFormat.DMG) is NucleusAppUpdater) - assertTrue(create(DistributionChannel.APPIMAGE, PackageFormat.APPIMAGE) is NucleusAppUpdater) - } - - private fun create(channel: DistributionChannel, format: PackageFormat, devMode: Boolean = false) = - createAppUpdater( - channel = channel, - format = format, - devMode = devMode, - preferences = FakeUpdatePreferences(), - appScope = scope, - ioDispatcher = Dispatchers.IO, - currentVersion = "1.0.0", - ) -} diff --git a/docker/Dockerfile b/docker/Dockerfile index 95d5c92b1..af6b30398 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -28,20 +28,14 @@ RUN groupadd --gid 1000 hammer \ # setting JAVA_OPTS for heap would otherwise silently relocate all durable state. ENV SERVER_OPTS="-Duser.home=/data" -# JNA, which the CLI's terminal library pulls in, extracts a shared object and executes -# it. On Linux it ignores java.io.tmpdir and uses $XDG_CACHE_HOME (defaulting to -# /.cache), so without this it lands on the /data volume, which many hosts -# mount noexec. Keep it on the image layer instead. -ENV XDG_CACHE_HOME=/home/hammer/.cache - ARG DIST_DIR=server/build/install/server -COPY --chown=1000:1000 ${DIST_DIR}/ /opt/hammer/ +COPY ${DIST_DIR}/ /opt/hammer/ # hammer_data itself must exist and be owned here: bind-mounting a config file # into it would otherwise have Docker create the parent as root, leaving the # unprivileged server unable to write pgdata. RUN mkdir -p /data/hammer_data \ - && chown -R hammer:hammer /data + && chown -R hammer:hammer /data /opt/hammer USER hammer WORKDIR /opt/hammer diff --git a/docker/config.example.toml b/docker/config.example.toml index 8429d6f06..b2edb2c9f 100644 --- a/docker/config.example.toml +++ b/docker/config.example.toml @@ -12,10 +12,6 @@ host = "hammer.example.com" # HEALTHCHECK both assume 8080; changing it means changing those too. port = 8080 -# Time zone for rendered timestamps and log lines, as an IANA zone ID. Defaults to -# the container's zone (UTC unless TZ is set in docker-compose.yml). -# timezone = "Europe/Paris" - # Do NOT set bindHosts under Docker. The main server guide recommends # ["127.0.0.1", "::1"] behind a reverse proxy, but inside a container that binds # the container's own loopback, so the published port reaches nothing and the diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 6c9cf2e13..e02f81cd7 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -21,17 +21,8 @@ services: # Loopback by default: this connector is plain HTTP, and published ports # bypass host firewall rules. Set HAMMER_HTTP_BIND=0.0.0.0 only if nothing # untrusted can reach the host. HAMMER_HTTP_PORT moves the host-side port. - # - # Clients only speak HTTPS and will not connect to this port. Terminate TLS - # at a reverse proxy in front of it, or configure sslCert and publish 443. - "${HAMMER_HTTP_BIND:-127.0.0.1}:${HAMMER_HTTP_PORT:-8080}:8080" - environment: - # Time zone for web-UI timestamps and log lines, as an IANA zone ID. Defaults - # to UTC; set TZ in your shell or a .env file next to this compose file to - # change it. `timezone` in config.toml overrides this. - TZ: ${TZ:-UTC} - # Uncomment alongside the postgres service below. # depends_on: # postgres: diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 28f482dab..691207c62 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -234,14 +234,6 @@ ViewModels/Components and renders them. that use them. They are the only stateful components that may reference their own tier, and only acyclically (see Foundation primitives). A foundation primitive must never reference a Repository or higher. -7. **One owner per persisted format.** Every on-disk file format is owned by exactly one Data - Source; only that file serializes or deserializes it. Code that cannot reach the datasource - instance (no per-project Koin scope yet, wrong lifecycle) does not fall back to raw - `fileSystem.writeToml`/`readToml` — it uses or adds a **scope-less helper in the datasource's - own file** (pattern: `loadStoredProjectData`/`saveStoredProjectData` in - `ProjectDataDatasource.kt`). A second inline writer forks the format and clobbers sibling - fields on write: two independent writers of `project_data.toml` once each erased the other's - field. Enforced by `PersistedFormatOwnershipTest` in `common/src/desktopTest`. ## DI conventions diff --git a/docs/HOW-TO-RELEASE.md b/docs/HOW-TO-RELEASE.md index 210e9659b..912651837 100644 --- a/docs/HOW-TO-RELEASE.md +++ b/docs/HOW-TO-RELEASE.md @@ -3,15 +3,10 @@ - Make sure your local repository is in a clean state, nothing outstanding - Change branch to `develop` - When `develop` is ready to release, run: `./gradlew prepareForRelease` - - Leave **Auto-publish the GitHub release** unchecked to publish by hand (see - [Auto-publishing](#auto-publishing)) - This will prepare your repo by doing the following: - Increment app version `app` in `libs.versions.toml` - Add new changelog in `fastlane\metadata\android\en-US\changelogs` called `n.txt` where `n` is the android version code - - Bake the release notes into the app at - `common/src/commonMain/composeResources/files/changelog.md` — this is what the in-app - "What's New" dialog shows, so never edit it by hand - Merge `develop` into `release` - Tag the latest commit to make the release from in the [semvar](https://semver.org) format of `v1.1.1` @@ -26,56 +21,6 @@ to [hammer.ink](https://hammer.ink), and notify the **Discord** channel of a new release - All done! -## Auto-publishing - -The release dialog's **Auto-publish the GitHub release** checkbox (off by default) does the -manual publish steps above for you. When it is checked `prepareForRelease` appends an -`Auto-Publish: true` trailer to the tag message; once every build job passes, `set-release-body` -strips the trailer from the release body and marks the release as the latest production release, -firing the same `publish` action. - -This needs a `RELEASE_PAT` repository secret: a fine-grained PAT scoped to this repo with -**Contents: read and write**. GitHub does not start workflow runs from events triggered by the -default `GITHUB_TOKEN`, so publishing with that token would leave every store untouched. The step -fails with a clear error when the secret is missing. - -## Changelog tabs - -The release dialog has four changelog tabs. Only **Full** has to be written; the rest -mirror it and are there for when a store needs something different. - -| Tab | Goes to | Limit | -| --- | --- | --- | -| **Full** | `CHANGELOG.md`, the GitHub release, the tag message, and the in-app What's New | none | -| **App stores** | Flathub, on releases to every store | none | -| **Google Play** | `fastlane/metadata/android/.../changelogs/.txt`, which F-Droid reads too | 500 | -| **Apple** | `fastlane/metadata/ios/en-US/` and `.../osx/en-US/release_notes.txt` | 4000 | - -Each tab follows the one above it until you type in it, after which it says -*Hand-edited* and offers **Re-sync**. So the usual release is one piece of writing on -**Full**; a tab is touched only when that store needs its own wording. - -**App stores** is **Full** with the entries tagged for a non-app audience removed -(`[Web]`, `Server:`, a whole `[Server operators]` section, and so on), because Apple -rejects release notes describing anything but the app and Google Play has an equivalent -policy. The tab reports what it took out, since the tag matching is a heuristic and a -silent removal is how an app-facing change goes missing from a listing. - -The two store tabs differ in more than length: Google Play's notes carry a link to the -full notes on GitHub, and Apple's must not, because App Store review reads that link as -offering the app outside the App Store and rejects the submission. - -Google Play's 500 characters are a hard stop: over the limit, the counter turns red and -**Commit Changes** is disabled. **Trim to fit** drops the auto-fitted text into the -editor as a starting point, so what ships is text someone chose rather than a sentence -cut off at a bullet boundary. - -Tabs for stores outside the current publish scope are disabled, and their notes are -dropped on commit. A partial release leaves every notes file it skips untouched: the -iOS and macOS files are written separately even though they share the Apple tab, and -Flathub, which is published by hand with `publishFlathub` rather than by the release -tag, only gets a release entry when every client store is targeted. - ## Partial (single-store) releases Use this when one store needs a hotfix and you don't want to ship the whole matrix. diff --git a/docs/HOW-TO-RUN-A-SERVER-DOCKER.md b/docs/HOW-TO-RUN-A-SERVER-DOCKER.md index 3066200ab..d2582464a 100644 --- a/docs/HOW-TO-RUN-A-SERVER-DOCKER.md +++ b/docs/HOW-TO-RUN-A-SERVER-DOCKER.md @@ -5,7 +5,7 @@ uses the in-process (embedded) PostgreSQL database, so no external services are required: just a volume for your data. This is the Docker-specific guide. For everything that is not Docker-specific -(allowed users, email, community, analytics, encryption at rest) see +(whitelisting, email, community, analytics, encryption at rest) see [HOW-TO-RUN-A-SERVER.md](HOW-TO-RUN-A-SERVER.md). Where the two disagree about networking, **this document wins for containers**. @@ -32,14 +32,8 @@ docker run -d --name hammer-server \ ghcr.io/darkrock-studios/hammer-editor/server:latest ``` -That gets the server running, but **a client cannot talk to it yet**. Hammer -clients only speak HTTPS, and the container serves plain HTTP, so put TLS in -front of it first: see [Networking](#networking) below. A client pointed at the -cleartext port fails its TLS handshake and reports that it could not make a -secure connection. - -Once TLS is in place, **download a client and create an account**. The first -account created becomes the admin account. +Then **download a client and create an account**. The first account created +becomes the admin account. ## Networking @@ -61,52 +55,6 @@ To change the host-side binding or port: HAMMER_HTTP_BIND=0.0.0.0 HAMMER_HTTP_PORT=8090 docker compose up -d ``` -### Reverse proxy: set `trustProxyForwarding` - -With a proxy in front, every request reaches the container from the proxy's address, so the -login rate limiter treats the whole server as one client and the login audit trail records one -address for everyone. Setting `trustProxyForwarding = true` in `config.toml` makes Hammer read -the real client from `X-Forwarded-For`. See -[Behind a proxy](HOW-TO-RUN-A-SERVER.md#behind-a-proxy-every-request-looks-like-it-came-from-the-proxy) -for the full picture, the warning that goes with it, and what to do when a CDN sits in front of -your proxy. - -That warning matters more in a container than anywhere else: the flag is only safe while the -proxy is the *only* route in. Publishing the container port to `0.0.0.0` (above) reopens a -direct path, and with `trustProxyForwarding` on, anything reaching it can forge a client address per -request and walk through the rate limiter. Keep the publish on `127.0.0.1`, or on a Docker -network only the proxy shares. - -### A client that will not connect - -If a client reports that it could not make a secure connection, it reached the -cleartext port and got no TLS. Add a reverse proxy or a certificate as above. - -The server log is misleading here. A client's TLS handshake is rejected by the -HTTP parser before any route runs, so nothing about it appears in the -application log. What you will see instead are `UnsupportedProtocolVersionException` -entries from your own browser or `curl` hitting `/api/...`, since only Hammer -clients send the `X-Hammer-Protocol-Version` header. Those are unrelated to the -client's failure. - -### A login that returns 401 after the account was created - -Passwords are 8 to 64 characters with no complexity rule and no forbidden characters, and the -server hashes what it receives without stripping or truncating anything, so a password that was -accepted at account creation will keep working. See -[Account passwords](HOW-TO-RUN-A-SERVER.md#account-passwords) for the full policy and for the -log lines that name why a login was rejected. - -Two container-specific causes are worth ruling out first: - -- **A stale volume.** If the account was created against a database that has since been - recreated (`docker compose down -v`, a changed volume mount), the account is simply gone and - every login is a legitimate 401. `Login rejected: no account for the submitted email` in the - log confirms it. -- **Rate limiting seen as a login failure.** The login limiter allows 10 requests per minute - keyed on the source address, and behind a reverse proxy that address is the proxy's, shared - by everyone. Repeated attempts return `429`, not `401`. - ### Do not set `bindHosts` [HOW-TO-RUN-A-SERVER.md](HOW-TO-RUN-A-SERVER.md#reverse-proxy-using-nginx) tells @@ -145,27 +93,6 @@ Paths inside `config.toml` are resolved differently depending on the setting: > with a confusing `UnexpectedTokenException` on line 1. In PowerShell use > `[System.IO.File]::WriteAllText($path, $text)`. -### Time zone - -The container runs in UTC unless told otherwise, so rendered timestamps and log lines are stamped -in UTC. `docker-compose.yml` passes `TZ` through, so set it in your shell or in a `.env` file next -to the compose file: - -``` -TZ=Europe/Paris -``` - -Or set it directly in `config.toml`, which takes precedence: - -```toml -timezone = "Europe/Paris" -``` - -Either way the value is an IANA zone ID; see the [full list](SERVER-TIMEZONES.md). The effective -zone is logged at startup as `Server time zone: ...`. Stored data is unaffected, since everything -is persisted as an absolute instant. See [Time zone](HOW-TO-RUN-A-SERVER.md#time-zone) for the -full rundown, including the one caveat when changing the zone on a server already in use. - ## TLS in the container If you want Hammer itself to terminate TLS, mount the certificate directory and diff --git a/docs/HOW-TO-RUN-A-SERVER.md b/docs/HOW-TO-RUN-A-SERVER.md index 41df1d0d2..50468e1fa 100644 --- a/docs/HOW-TO-RUN-A-SERVER.md +++ b/docs/HOW-TO-RUN-A-SERVER.md @@ -26,7 +26,7 @@ docker compose up -d ``` **See [HOW-TO-RUN-A-SERVER-DOCKER.md](HOW-TO-RUN-A-SERVER-DOCKER.md) for the full -Docker guide.** The feature sections below (allowed users, email, community, +Docker guide.** The feature sections below (whitelisting, email, community, analytics, encryption) apply to Docker too, since the server auto-loads `config.toml` from the mounted data directory. @@ -53,36 +53,9 @@ The Hammer server is a Java application that runs on Windows, Linux, and macOS. 4. Run the server (_see platform-specific instructions below_) 5. If everything worked, you should be able to access your server at your server's IP or at the host name you set in your config file and DNS configuration, such as: `http://example.com` -6. **Set up HTTPS before going any further.** Clients only speak `https` and will not connect to a - plain HTTP server, so it needs either its own certificate or a reverse proxy holding one. See - [Setting up SSL](#setting-up-ssl-required-for-direct-connections). -7. **IMPORTANT!** You must now download one of the clients and create an account on the server. The first account +6. **IMPORTANT!** You must now download one of the clients and create an account on the server. The first account created will be the admin account. -## Account passwords - -The server enforces exactly one password rule: **8 to 64 characters**. There is no complexity -requirement, no character is forbidden, and nothing is silently stripped or truncated — the -password is hashed with Argon2 exactly as it arrives, so any Unicode you can type (accents, -symbols, emoji) is fair game. A password outside that length range is rejected at account -creation with `400 Bad Request` and an explanatory message; it is never accepted and then -mysteriously unusable at login. - -If a login fails, the server log names the reason: - -``` -Login rejected: no account for the submitted email -Login rejected: password mismatch for user 1 -``` - -The response body carries a machine-readable `errorCode` (`invalid_credentials`, -`not_whitelisted`, `password_too_long`, …) alongside the translated message. Note that the -*response* deliberately cannot distinguish a wrong password from an unknown email — that -would let anyone enumerate your users — so the log above is the place to look. - -A login answering `403 Forbidden` with `not_whitelisted` means the credentials were fine and the -account simply isn't allowed in; see [Allowed Users](#allowed-users). - ## Network binding By default the server binds to all IPv4 interfaces (`0.0.0.0`), so it accepts connections from the @@ -98,53 +71,6 @@ bindHosts = ["127.0.0.1", "::1"] public name shown to users. Each address gets its own listener (and its own HTTPS listener when an SSL cert is configured). -## Time zone - -The server stamps timestamps in the host's time zone, which on most containers and fresh installs -is UTC. To use your local zone instead, set `timezone` to an IANA zone ID -([full list of accepted IDs](SERVER-TIMEZONES.md)): - -```toml -timezone = "Europe/Paris" -``` - -Two environment variables do the same thing, for setups where the config file is inconvenient: -`HAMMER_TIMEZONE`, and the standard `TZ`. `config.toml` wins over `HAMMER_TIMEZONE`, which wins -over `TZ`. - -```sh -HAMMER_TIMEZONE=Europe/Paris ./run.sh -``` - -The zone is applied at startup, and logged as `Server time zone: ...` so you can confirm it took. -An unknown ID in `timezone` or `HAMMER_TIMEZONE` aborts startup rather than quietly leaving every -timestamp in the wrong zone. `TZ` is treated more leniently, because the POSIX form some systems -use (`CET-1CEST,M3.5.0`) is a legitimate value the operating system has already acted on: a `TZ` -Hammer cannot read logs a warning and leaves the zone to the host. - -What it affects: - -- Dates and times on the web pages the server renders: the dashboard, admin screens, monitoring, - editorial reviews, and published story dates. -- Log line timestamps, both in the console output and the admin log viewer. - -What it does not affect: - -- Stored data. Everything is persisted as an absolute instant (UTC in the database), so changing - the zone re-renders existing timestamps rather than shifting any data. -- The desktop, Android, and iOS clients. Those render in each device's own zone. -- Maintenance job scheduling. Jobs run on fixed intervals from server start, not at a wall-clock - time of day, so no schedule moves with the zone. - -One caveat when changing the zone on a server that has already been running: date-only admin -fields are interpreted in whatever zone was in effect when they were saved. An Allowed Users -expiry entered as "expires Sep 1" is stored as the end of Sep 1 in the old zone, so afterwards the -edit form can show the neighboring date, and re-saving that row moves the expiry by a day. Nothing -expires early or late on its own; only re-saving an existing row does it. - -Note that `TZ` alone already works on Linux, because the JVM reads it. Hammer reads it back -explicitly so the same variable also works on Windows and macOS hosts, which ignore it. - ## Rich link previews (optional) By default, sharing an author or story link on social media shows a branded static preview card. @@ -238,22 +164,6 @@ caches disabled. Only publicly readable stories are ever written to the HTML cache, so a password-protected story's prose never lands on the cache volume. -## Account deletion retention - -Users can delete their own account from the web dashboard. A deleted account is locked out -immediately (no login, no sync, everything unpublished, pen name released), but its data is -retained on the server for a grace window so you can restore it from **Admin → Users** if the -user changes their mind. A daily job permanently deletes accounts once the window elapses. - -```toml -[accountDeletion] -# Defaults shown. Omit this whole block to accept them. -retentionDays = 30 # days before a deleted account is purged for good (1 to 3650) -``` - -The window is evaluated against each account's deletion time on every job run, so lowering -the value also purges accounts that are already past the new, shorter window. - ## Encryption at rest Content encryption at rest is **optional**: a fresh server stores in plaintext and @@ -412,28 +322,8 @@ The desktop client run with `--dev` trusts this self-signed cert, but **only for and hostname validation, so pointing a dev build at a real server is not silently insecure. This path never activates without `--dev`; a production server with no `sslCert` serves plain HTTP -only (for the reverse-proxy case). Mobile clients still won't trust the self-signed cert, so to -develop against the phone or watch apps, use a real certificate, a reverse proxy, or the plain -HTTP connector described below. - -#### Plain HTTP on a network you trust - -A self-hosted server on a LAN, a VPN, or a mesh network such as Tailscale often has no -certificate at all. Clients can talk to the plain HTTP connector (`port`, default 8080) in that -case, but only when the user opts in explicitly: **type the server address with an `http://` -scheme**, for example `http://192.168.1.50:8080`. A bare host or an `https://` address always -stays encrypted, and the setup screen warns while an `http://` address is entered. - -Everything travels unencrypted on that connection, including the password at sign-in and the -auth tokens on every later request, so only do this on a network where you trust every device. -Anything reachable from the open internet needs a real certificate. - -The Android and Wear OS apps permit cleartext through `network_security_config.xml`, shared by -both apps from `common/src/androidMain/res/xml/`. Debug builds of those apps additionally trust -user-installed CAs, which is useful with a proxy or a locally issued certificate. - -This is also the simplest way to develop against a device: run the server (it binds `0.0.0.0` by -default), then sign in on the phone or watch with `http://:8080`. +only (for the reverse-proxy case). Mobile clients still won't trust the self-signed cert, so +develop the mobile clients against a real certificate or a reverse proxy. #### Let's Encrypt @@ -547,43 +437,6 @@ bindHosts = ["127.0.0.1", "::1"] Make sure to update your DNS with your desired URL to be able to use LetsEncrypt and the like. -### Behind a proxy, every request looks like it came from the proxy - -If nothing proxies your server, skip this section: Hammer already sees each visitor's real -address, and nothing needs configuring. - -Behind a proxy it sees the proxy instead, identically for every visitor. That breaks three -things: the login rate limiter (10 attempts per minute) becomes one bucket shared by the whole -server rather than one per client, so a burst from anywhere locks everyone out; recorded login -IPs all read as the proxy; and public story reader counts collapse to a single visitor. - -Your proxy already sends the real values in `X-Forwarded-For` and `X-Forwarded-Proto` (both are -in the Nginx config below). Tell Hammer to trust them: - -```toml -# Default false. Only enable when clients cannot reach the server directly. -trustProxyForwarding = true -``` - -> [!WARNING] -> Only set this when the proxy is the *only* route to the server, which is what -> `bindHosts = ["127.0.0.1", "::1"]` above ensures. `X-Forwarded-For` is just a request header: -> anything that can reach Hammer directly can forge one, and with this on that means a fresh -> identity per request and a free pass through the login rate limiter. If your server is -> reachable both through the proxy and directly, leave it `false`. - -**One proxy only.** Hammer trusts the last `X-Forwarded-For` entry, which is the one your proxy -added. Put a CDN in front of Nginx (Cloudflare, Fastly) and that entry becomes the CDN's edge -node rather than the visitor, so have Nginx replace the header with the address the CDN reports: - -```nginx -# Cloudflare example. Keep set_real_ip_from restricted to the CDN's ranges, -# or anything can supply its own CF-Connecting-IP. -set_real_ip_from 173.245.48.0/20; # ...and the rest of Cloudflare's published ranges -real_ip_header CF-Connecting-IP; -proxy_set_header X-Forwarded-For $remote_addr; -``` - ### Base Nginx Config Create your base file. Make sure to change `hammer.example.com` to your domain! @@ -658,22 +511,17 @@ sudo nginx -t As long as that doesn't throw any errors, you can restart nginx. You should now be able to access your Hammer server web page at your URL! -## Allowed Users +## Whitelisting Users -Account creation is restricted to allowed email addresses. This is always on and cannot be -disabled; it is the nominal state of a Hammer server, since there are no moderation tools or -account verification, and a fully open server would fill with spam very quickly. +By default, the server is closed to account creation after the first account. -To allow someone to use your server, go to `/admin/allowed-users` on the website (logged in as -your admin account) and add their email address. They can then create their own account on the -`/signup` page, or from within the Hammer app. Entries can carry an optional expiry date, after -which the user's access is revoked automatically. +You can open it by going to `/admin` on the website, logging in as your admin account, and clicking +"**Disable Whitelist**". +Otherwise, you can add individual users to the whitelist using the admin page. -When upgrading a server that had explicitly **disabled** the old whitelist, every existing -account is added to the allowed users list automatically on first startup (with the reason -"Existing account"), so nobody is locked out by the upgrade. Servers that were already -enforcing the whitelist are left untouched: entries that were removed or expired stay -revoked. +_**Note:** Disabling the whitelist is **strongly discouraged**. There are currently no moderation +tools or even account +verification. I expect any fully open server would become filled with spam very quickly._ ## Enable Community diff --git a/docs/KEYBOARD-SHORTCUTS.md b/docs/KEYBOARD-SHORTCUTS.md deleted file mode 100644 index 00436f414..000000000 --- a/docs/KEYBOARD-SHORTCUTS.md +++ /dev/null @@ -1,66 +0,0 @@ -# Keyboard Shortcuts - -Desktop, plus the two project shortcuts on Android and iOS with a hardware keyboard. -`Ctrl` and `Cmd` are interchangeable everywhere below: `onKeyShortcut` -( -`composeUi/src/commonMain/kotlin/com/darkrockstudios/apps/hammer/common/compose/ShortcutModifiers.kt`) -treats `isCtrlPressed || isMetaPressed` as a single "ctrl" modifier, so these are not -macOS-specific `Cmd` bindings, they work with either key on every platform. - -Every binding matches its modifiers exactly, and none of them uses `Alt`. Both rules are -load bearing: Windows reports `AltGr` as `Ctrl+Alt`, so a loose or `Alt` based chord fires -while a Turkish, German, or Polish layout types the character on that key (issue #859). - -## Application - -These are matched in `desktop/.../WindowShortcuts.kt` and dispatched from each window's -`onKeyEvent`. - -| Shortcut | Action | Window | -|----------------|-----------------------|-------------------------------------------------| -| `Esc` | Navigate back | `ProjectEditorWindow.kt`, `ProjectSelectionWindow.kt` | -| `Ctrl+Q` | Quit application | `ProjectEditorWindow.kt`, `ProjectSelectionWindow.kt` | -| `Ctrl+W` | Close current project | `ProjectEditorWindow.kt` | -| `Ctrl+Shift+F` | Open global search | `ProjectEditorWindow.kt` | - -## Project (while a project is open) - -These two work on all three platforms, each through the host hook that does not depend on -what Compose has focused. Compose routes key events along the focus path, so a screen with -nothing focused never sees them, which is why none of these are `Modifier` shortcuts. - -| Platform | Hook | -|----------|---------------------------------------------------------------| -| Desktop | `ProjectEditorWindow.kt` window `onPreviewKeyEvent` | -| Android | `ProjectRootActivity.dispatchKeyEvent` | -| iOS | `ShortcutHostController.keyCommands` in `ComposeContainer.swift` | - -Android and iOS reach the shared action through `ProjectShortcutHost`, which -`ProjectRootScaffold` binds while the project UI is composed. The application shortcuts -above use the window's `onKeyEvent` instead and yield to a focused component that consumes -the key. Modifier shortcuts (the editor ones below) only fire when focus sits inside the -composable they are attached to. - -`F3` means F3 with nothing held, so `Ctrl+F3` and `Shift+F3` do not start a sync. - -| Shortcut | Action | -|----------------|----------------------------------------------| -| `Ctrl+Shift+S` | Save all dirty buffers (scenes, notes, etc.) | -| `F3` | Start project sync (server-linked only) | - -## Editors (scene, note, timeline event, story idea) - -| Shortcut | Action | Source | -|----------|-----------------------|-------------------------------------------------------------------------------------------------------------| -| `Ctrl+S` | Save the current item | `saveShortcutModifier` via `SceneEditorUi.kt`, `ViewNoteUi.kt`, `ViewTimeLineEventUi.kt`, `StoryIdeasUi.kt` | -| `Ctrl+F` | Open find bar | `findShortcutModifier` via `SceneEditorUi.kt`, `FocusModeUi.kt` | - -## Rich Text Formatting - -Available anywhere `MarkdownFormatBar.kt` is used (scene, note, and encyclopedia editors). - -| Shortcut | Action | -|----------------|----------------------| -| `Ctrl+B` | Toggle bold | -| `Ctrl+I` | Toggle italic | -| `Ctrl+Shift+X` | Toggle strikethrough | diff --git a/docs/SERVER-TIMEZONES.md b/docs/SERVER-TIMEZONES.md deleted file mode 100644 index 66522322b..000000000 --- a/docs/SERVER-TIMEZONES.md +++ /dev/null @@ -1,728 +0,0 @@ -# Server time zone IDs - -Every value the server's `timezone` setting, the `HAMMER_TIMEZONE` environment variable, and -`TZ` accept. See [Time zone](HOW-TO-RUN-A-SERVER.md#time-zone) for what the setting does and -which one wins when more than one is set. - -These are IANA (tz database) zone IDs, read from the JVM's own copy of the database, so the -same IDs work on every host regardless of what the operating system has installed. They are -case-sensitive: `Europe/Paris` is valid, `europe/paris` is not. - -The offset columns are sampled mid-January and mid-July. Where they differ, the zone observes -daylight saving and the server follows the shift on its own. - -Generated from the tz database shipped with JDK 21.0.9 (604 IDs). A JDK update can add or retire -entries; the authoritative list for a given install is always `ZoneId.getAvailableZoneIds()` on the -JDK the server runs on. - -## Contents - -- [Africa](#africa) -- [America](#america) -- [Antarctica](#antarctica) -- [Arctic](#arctic) -- [Asia](#asia) -- [Atlantic](#atlantic) -- [Australia](#australia) -- [Brazil](#brazil) -- [Canada](#canada) -- [Chile](#chile) -- [Europe](#europe) -- [Indian](#indian) -- [Mexico](#mexico) -- [Pacific](#pacific) -- [US](#us) -- [Legacy and fixed-offset IDs](#legacy-and-fixed-offset-ids) - -## Africa - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Africa/Abidjan` | UTC | UTC | -| `Africa/Accra` | UTC | UTC | -| `Africa/Addis_Ababa` | UTC+03:00 | UTC+03:00 | -| `Africa/Algiers` | UTC+01:00 | UTC+01:00 | -| `Africa/Asmara` | UTC+03:00 | UTC+03:00 | -| `Africa/Asmera` | UTC+03:00 | UTC+03:00 | -| `Africa/Bamako` | UTC | UTC | -| `Africa/Bangui` | UTC+01:00 | UTC+01:00 | -| `Africa/Banjul` | UTC | UTC | -| `Africa/Bissau` | UTC | UTC | -| `Africa/Blantyre` | UTC+02:00 | UTC+02:00 | -| `Africa/Brazzaville` | UTC+01:00 | UTC+01:00 | -| `Africa/Bujumbura` | UTC+02:00 | UTC+02:00 | -| `Africa/Cairo` | UTC+02:00 | UTC+03:00 | -| `Africa/Casablanca` | UTC+01:00 | UTC+01:00 | -| `Africa/Ceuta` | UTC+01:00 | UTC+02:00 | -| `Africa/Conakry` | UTC | UTC | -| `Africa/Dakar` | UTC | UTC | -| `Africa/Dar_es_Salaam` | UTC+03:00 | UTC+03:00 | -| `Africa/Djibouti` | UTC+03:00 | UTC+03:00 | -| `Africa/Douala` | UTC+01:00 | UTC+01:00 | -| `Africa/El_Aaiun` | UTC+01:00 | UTC+01:00 | -| `Africa/Freetown` | UTC | UTC | -| `Africa/Gaborone` | UTC+02:00 | UTC+02:00 | -| `Africa/Harare` | UTC+02:00 | UTC+02:00 | -| `Africa/Johannesburg` | UTC+02:00 | UTC+02:00 | -| `Africa/Juba` | UTC+02:00 | UTC+02:00 | -| `Africa/Kampala` | UTC+03:00 | UTC+03:00 | -| `Africa/Khartoum` | UTC+02:00 | UTC+02:00 | -| `Africa/Kigali` | UTC+02:00 | UTC+02:00 | -| `Africa/Kinshasa` | UTC+01:00 | UTC+01:00 | -| `Africa/Lagos` | UTC+01:00 | UTC+01:00 | -| `Africa/Libreville` | UTC+01:00 | UTC+01:00 | -| `Africa/Lome` | UTC | UTC | -| `Africa/Luanda` | UTC+01:00 | UTC+01:00 | -| `Africa/Lubumbashi` | UTC+02:00 | UTC+02:00 | -| `Africa/Lusaka` | UTC+02:00 | UTC+02:00 | -| `Africa/Malabo` | UTC+01:00 | UTC+01:00 | -| `Africa/Maputo` | UTC+02:00 | UTC+02:00 | -| `Africa/Maseru` | UTC+02:00 | UTC+02:00 | -| `Africa/Mbabane` | UTC+02:00 | UTC+02:00 | -| `Africa/Mogadishu` | UTC+03:00 | UTC+03:00 | -| `Africa/Monrovia` | UTC | UTC | -| `Africa/Nairobi` | UTC+03:00 | UTC+03:00 | -| `Africa/Ndjamena` | UTC+01:00 | UTC+01:00 | -| `Africa/Niamey` | UTC+01:00 | UTC+01:00 | -| `Africa/Nouakchott` | UTC | UTC | -| `Africa/Ouagadougou` | UTC | UTC | -| `Africa/Porto-Novo` | UTC+01:00 | UTC+01:00 | -| `Africa/Sao_Tome` | UTC | UTC | -| `Africa/Timbuktu` | UTC | UTC | -| `Africa/Tripoli` | UTC+02:00 | UTC+02:00 | -| `Africa/Tunis` | UTC+01:00 | UTC+01:00 | -| `Africa/Windhoek` | UTC+02:00 | UTC+02:00 | - -## America - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `America/Adak` | UTC-10:00 | UTC-09:00 | -| `America/Anchorage` | UTC-09:00 | UTC-08:00 | -| `America/Anguilla` | UTC-04:00 | UTC-04:00 | -| `America/Antigua` | UTC-04:00 | UTC-04:00 | -| `America/Araguaina` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Buenos_Aires` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Catamarca` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/ComodRivadavia` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Cordoba` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Jujuy` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/La_Rioja` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Mendoza` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Rio_Gallegos` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Salta` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/San_Juan` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/San_Luis` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Tucuman` | UTC-03:00 | UTC-03:00 | -| `America/Argentina/Ushuaia` | UTC-03:00 | UTC-03:00 | -| `America/Aruba` | UTC-04:00 | UTC-04:00 | -| `America/Asuncion` | UTC-03:00 | UTC-03:00 | -| `America/Atikokan` | UTC-05:00 | UTC-05:00 | -| `America/Atka` | UTC-10:00 | UTC-09:00 | -| `America/Bahia` | UTC-03:00 | UTC-03:00 | -| `America/Bahia_Banderas` | UTC-06:00 | UTC-06:00 | -| `America/Barbados` | UTC-04:00 | UTC-04:00 | -| `America/Belem` | UTC-03:00 | UTC-03:00 | -| `America/Belize` | UTC-06:00 | UTC-06:00 | -| `America/Blanc-Sablon` | UTC-04:00 | UTC-04:00 | -| `America/Boa_Vista` | UTC-04:00 | UTC-04:00 | -| `America/Bogota` | UTC-05:00 | UTC-05:00 | -| `America/Boise` | UTC-07:00 | UTC-06:00 | -| `America/Buenos_Aires` | UTC-03:00 | UTC-03:00 | -| `America/Cambridge_Bay` | UTC-07:00 | UTC-06:00 | -| `America/Campo_Grande` | UTC-04:00 | UTC-04:00 | -| `America/Cancun` | UTC-05:00 | UTC-05:00 | -| `America/Caracas` | UTC-04:00 | UTC-04:00 | -| `America/Catamarca` | UTC-03:00 | UTC-03:00 | -| `America/Cayenne` | UTC-03:00 | UTC-03:00 | -| `America/Cayman` | UTC-05:00 | UTC-05:00 | -| `America/Chicago` | UTC-06:00 | UTC-05:00 | -| `America/Chihuahua` | UTC-06:00 | UTC-06:00 | -| `America/Ciudad_Juarez` | UTC-07:00 | UTC-06:00 | -| `America/Coral_Harbour` | UTC-05:00 | UTC-05:00 | -| `America/Cordoba` | UTC-03:00 | UTC-03:00 | -| `America/Costa_Rica` | UTC-06:00 | UTC-06:00 | -| `America/Coyhaique` | UTC-03:00 | UTC-03:00 | -| `America/Creston` | UTC-07:00 | UTC-07:00 | -| `America/Cuiaba` | UTC-04:00 | UTC-04:00 | -| `America/Curacao` | UTC-04:00 | UTC-04:00 | -| `America/Danmarkshavn` | UTC | UTC | -| `America/Dawson` | UTC-07:00 | UTC-07:00 | -| `America/Dawson_Creek` | UTC-07:00 | UTC-07:00 | -| `America/Denver` | UTC-07:00 | UTC-06:00 | -| `America/Detroit` | UTC-05:00 | UTC-04:00 | -| `America/Dominica` | UTC-04:00 | UTC-04:00 | -| `America/Edmonton` | UTC-07:00 | UTC-06:00 | -| `America/Eirunepe` | UTC-05:00 | UTC-05:00 | -| `America/El_Salvador` | UTC-06:00 | UTC-06:00 | -| `America/Ensenada` | UTC-08:00 | UTC-07:00 | -| `America/Fort_Nelson` | UTC-07:00 | UTC-07:00 | -| `America/Fort_Wayne` | UTC-05:00 | UTC-04:00 | -| `America/Fortaleza` | UTC-03:00 | UTC-03:00 | -| `America/Glace_Bay` | UTC-04:00 | UTC-03:00 | -| `America/Godthab` | UTC-02:00 | UTC-01:00 | -| `America/Goose_Bay` | UTC-04:00 | UTC-03:00 | -| `America/Grand_Turk` | UTC-05:00 | UTC-04:00 | -| `America/Grenada` | UTC-04:00 | UTC-04:00 | -| `America/Guadeloupe` | UTC-04:00 | UTC-04:00 | -| `America/Guatemala` | UTC-06:00 | UTC-06:00 | -| `America/Guayaquil` | UTC-05:00 | UTC-05:00 | -| `America/Guyana` | UTC-04:00 | UTC-04:00 | -| `America/Halifax` | UTC-04:00 | UTC-03:00 | -| `America/Havana` | UTC-05:00 | UTC-04:00 | -| `America/Hermosillo` | UTC-07:00 | UTC-07:00 | -| `America/Indiana/Indianapolis` | UTC-05:00 | UTC-04:00 | -| `America/Indiana/Knox` | UTC-06:00 | UTC-05:00 | -| `America/Indiana/Marengo` | UTC-05:00 | UTC-04:00 | -| `America/Indiana/Petersburg` | UTC-05:00 | UTC-04:00 | -| `America/Indiana/Tell_City` | UTC-06:00 | UTC-05:00 | -| `America/Indiana/Vevay` | UTC-05:00 | UTC-04:00 | -| `America/Indiana/Vincennes` | UTC-05:00 | UTC-04:00 | -| `America/Indiana/Winamac` | UTC-05:00 | UTC-04:00 | -| `America/Indianapolis` | UTC-05:00 | UTC-04:00 | -| `America/Inuvik` | UTC-07:00 | UTC-06:00 | -| `America/Iqaluit` | UTC-05:00 | UTC-04:00 | -| `America/Jamaica` | UTC-05:00 | UTC-05:00 | -| `America/Jujuy` | UTC-03:00 | UTC-03:00 | -| `America/Juneau` | UTC-09:00 | UTC-08:00 | -| `America/Kentucky/Louisville` | UTC-05:00 | UTC-04:00 | -| `America/Kentucky/Monticello` | UTC-05:00 | UTC-04:00 | -| `America/Knox_IN` | UTC-06:00 | UTC-05:00 | -| `America/Kralendijk` | UTC-04:00 | UTC-04:00 | -| `America/La_Paz` | UTC-04:00 | UTC-04:00 | -| `America/Lima` | UTC-05:00 | UTC-05:00 | -| `America/Los_Angeles` | UTC-08:00 | UTC-07:00 | -| `America/Louisville` | UTC-05:00 | UTC-04:00 | -| `America/Lower_Princes` | UTC-04:00 | UTC-04:00 | -| `America/Maceio` | UTC-03:00 | UTC-03:00 | -| `America/Managua` | UTC-06:00 | UTC-06:00 | -| `America/Manaus` | UTC-04:00 | UTC-04:00 | -| `America/Marigot` | UTC-04:00 | UTC-04:00 | -| `America/Martinique` | UTC-04:00 | UTC-04:00 | -| `America/Matamoros` | UTC-06:00 | UTC-05:00 | -| `America/Mazatlan` | UTC-07:00 | UTC-07:00 | -| `America/Mendoza` | UTC-03:00 | UTC-03:00 | -| `America/Menominee` | UTC-06:00 | UTC-05:00 | -| `America/Merida` | UTC-06:00 | UTC-06:00 | -| `America/Metlakatla` | UTC-09:00 | UTC-08:00 | -| `America/Mexico_City` | UTC-06:00 | UTC-06:00 | -| `America/Miquelon` | UTC-03:00 | UTC-02:00 | -| `America/Moncton` | UTC-04:00 | UTC-03:00 | -| `America/Monterrey` | UTC-06:00 | UTC-06:00 | -| `America/Montevideo` | UTC-03:00 | UTC-03:00 | -| `America/Montreal` | UTC-05:00 | UTC-04:00 | -| `America/Montserrat` | UTC-04:00 | UTC-04:00 | -| `America/Nassau` | UTC-05:00 | UTC-04:00 | -| `America/New_York` | UTC-05:00 | UTC-04:00 | -| `America/Nipigon` | UTC-05:00 | UTC-04:00 | -| `America/Nome` | UTC-09:00 | UTC-08:00 | -| `America/Noronha` | UTC-02:00 | UTC-02:00 | -| `America/North_Dakota/Beulah` | UTC-06:00 | UTC-05:00 | -| `America/North_Dakota/Center` | UTC-06:00 | UTC-05:00 | -| `America/North_Dakota/New_Salem` | UTC-06:00 | UTC-05:00 | -| `America/Nuuk` | UTC-02:00 | UTC-01:00 | -| `America/Ojinaga` | UTC-06:00 | UTC-05:00 | -| `America/Panama` | UTC-05:00 | UTC-05:00 | -| `America/Pangnirtung` | UTC-05:00 | UTC-04:00 | -| `America/Paramaribo` | UTC-03:00 | UTC-03:00 | -| `America/Phoenix` | UTC-07:00 | UTC-07:00 | -| `America/Port-au-Prince` | UTC-05:00 | UTC-04:00 | -| `America/Port_of_Spain` | UTC-04:00 | UTC-04:00 | -| `America/Porto_Acre` | UTC-05:00 | UTC-05:00 | -| `America/Porto_Velho` | UTC-04:00 | UTC-04:00 | -| `America/Puerto_Rico` | UTC-04:00 | UTC-04:00 | -| `America/Punta_Arenas` | UTC-03:00 | UTC-03:00 | -| `America/Rainy_River` | UTC-06:00 | UTC-05:00 | -| `America/Rankin_Inlet` | UTC-06:00 | UTC-05:00 | -| `America/Recife` | UTC-03:00 | UTC-03:00 | -| `America/Regina` | UTC-06:00 | UTC-06:00 | -| `America/Resolute` | UTC-06:00 | UTC-05:00 | -| `America/Rio_Branco` | UTC-05:00 | UTC-05:00 | -| `America/Rosario` | UTC-03:00 | UTC-03:00 | -| `America/Santa_Isabel` | UTC-08:00 | UTC-07:00 | -| `America/Santarem` | UTC-03:00 | UTC-03:00 | -| `America/Santiago` | UTC-03:00 | UTC-04:00 | -| `America/Santo_Domingo` | UTC-04:00 | UTC-04:00 | -| `America/Sao_Paulo` | UTC-03:00 | UTC-03:00 | -| `America/Scoresbysund` | UTC-02:00 | UTC-01:00 | -| `America/Shiprock` | UTC-07:00 | UTC-06:00 | -| `America/Sitka` | UTC-09:00 | UTC-08:00 | -| `America/St_Barthelemy` | UTC-04:00 | UTC-04:00 | -| `America/St_Johns` | UTC-03:30 | UTC-02:30 | -| `America/St_Kitts` | UTC-04:00 | UTC-04:00 | -| `America/St_Lucia` | UTC-04:00 | UTC-04:00 | -| `America/St_Thomas` | UTC-04:00 | UTC-04:00 | -| `America/St_Vincent` | UTC-04:00 | UTC-04:00 | -| `America/Swift_Current` | UTC-06:00 | UTC-06:00 | -| `America/Tegucigalpa` | UTC-06:00 | UTC-06:00 | -| `America/Thule` | UTC-04:00 | UTC-03:00 | -| `America/Thunder_Bay` | UTC-05:00 | UTC-04:00 | -| `America/Tijuana` | UTC-08:00 | UTC-07:00 | -| `America/Toronto` | UTC-05:00 | UTC-04:00 | -| `America/Tortola` | UTC-04:00 | UTC-04:00 | -| `America/Vancouver` | UTC-08:00 | UTC-07:00 | -| `America/Virgin` | UTC-04:00 | UTC-04:00 | -| `America/Whitehorse` | UTC-07:00 | UTC-07:00 | -| `America/Winnipeg` | UTC-06:00 | UTC-05:00 | -| `America/Yakutat` | UTC-09:00 | UTC-08:00 | -| `America/Yellowknife` | UTC-07:00 | UTC-06:00 | - -## Antarctica - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Antarctica/Casey` | UTC+08:00 | UTC+08:00 | -| `Antarctica/Davis` | UTC+07:00 | UTC+07:00 | -| `Antarctica/DumontDUrville` | UTC+10:00 | UTC+10:00 | -| `Antarctica/Macquarie` | UTC+11:00 | UTC+10:00 | -| `Antarctica/Mawson` | UTC+05:00 | UTC+05:00 | -| `Antarctica/McMurdo` | UTC+13:00 | UTC+12:00 | -| `Antarctica/Palmer` | UTC-03:00 | UTC-03:00 | -| `Antarctica/Rothera` | UTC-03:00 | UTC-03:00 | -| `Antarctica/South_Pole` | UTC+13:00 | UTC+12:00 | -| `Antarctica/Syowa` | UTC+03:00 | UTC+03:00 | -| `Antarctica/Troll` | UTC | UTC+02:00 | -| `Antarctica/Vostok` | UTC+05:00 | UTC+05:00 | - -## Arctic - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Arctic/Longyearbyen` | UTC+01:00 | UTC+02:00 | - -## Asia - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Asia/Aden` | UTC+03:00 | UTC+03:00 | -| `Asia/Almaty` | UTC+05:00 | UTC+05:00 | -| `Asia/Amman` | UTC+03:00 | UTC+03:00 | -| `Asia/Anadyr` | UTC+12:00 | UTC+12:00 | -| `Asia/Aqtau` | UTC+05:00 | UTC+05:00 | -| `Asia/Aqtobe` | UTC+05:00 | UTC+05:00 | -| `Asia/Ashgabat` | UTC+05:00 | UTC+05:00 | -| `Asia/Ashkhabad` | UTC+05:00 | UTC+05:00 | -| `Asia/Atyrau` | UTC+05:00 | UTC+05:00 | -| `Asia/Baghdad` | UTC+03:00 | UTC+03:00 | -| `Asia/Bahrain` | UTC+03:00 | UTC+03:00 | -| `Asia/Baku` | UTC+04:00 | UTC+04:00 | -| `Asia/Bangkok` | UTC+07:00 | UTC+07:00 | -| `Asia/Barnaul` | UTC+07:00 | UTC+07:00 | -| `Asia/Beirut` | UTC+02:00 | UTC+03:00 | -| `Asia/Bishkek` | UTC+06:00 | UTC+06:00 | -| `Asia/Brunei` | UTC+08:00 | UTC+08:00 | -| `Asia/Calcutta` | UTC+05:30 | UTC+05:30 | -| `Asia/Chita` | UTC+09:00 | UTC+09:00 | -| `Asia/Choibalsan` | UTC+08:00 | UTC+08:00 | -| `Asia/Chongqing` | UTC+08:00 | UTC+08:00 | -| `Asia/Chungking` | UTC+08:00 | UTC+08:00 | -| `Asia/Colombo` | UTC+05:30 | UTC+05:30 | -| `Asia/Dacca` | UTC+06:00 | UTC+06:00 | -| `Asia/Damascus` | UTC+03:00 | UTC+03:00 | -| `Asia/Dhaka` | UTC+06:00 | UTC+06:00 | -| `Asia/Dili` | UTC+09:00 | UTC+09:00 | -| `Asia/Dubai` | UTC+04:00 | UTC+04:00 | -| `Asia/Dushanbe` | UTC+05:00 | UTC+05:00 | -| `Asia/Famagusta` | UTC+02:00 | UTC+03:00 | -| `Asia/Gaza` | UTC+02:00 | UTC+03:00 | -| `Asia/Harbin` | UTC+08:00 | UTC+08:00 | -| `Asia/Hebron` | UTC+02:00 | UTC+03:00 | -| `Asia/Ho_Chi_Minh` | UTC+07:00 | UTC+07:00 | -| `Asia/Hong_Kong` | UTC+08:00 | UTC+08:00 | -| `Asia/Hovd` | UTC+07:00 | UTC+07:00 | -| `Asia/Irkutsk` | UTC+08:00 | UTC+08:00 | -| `Asia/Istanbul` | UTC+03:00 | UTC+03:00 | -| `Asia/Jakarta` | UTC+07:00 | UTC+07:00 | -| `Asia/Jayapura` | UTC+09:00 | UTC+09:00 | -| `Asia/Jerusalem` | UTC+02:00 | UTC+03:00 | -| `Asia/Kabul` | UTC+04:30 | UTC+04:30 | -| `Asia/Kamchatka` | UTC+12:00 | UTC+12:00 | -| `Asia/Karachi` | UTC+05:00 | UTC+05:00 | -| `Asia/Kashgar` | UTC+06:00 | UTC+06:00 | -| `Asia/Kathmandu` | UTC+05:45 | UTC+05:45 | -| `Asia/Katmandu` | UTC+05:45 | UTC+05:45 | -| `Asia/Khandyga` | UTC+09:00 | UTC+09:00 | -| `Asia/Kolkata` | UTC+05:30 | UTC+05:30 | -| `Asia/Krasnoyarsk` | UTC+07:00 | UTC+07:00 | -| `Asia/Kuala_Lumpur` | UTC+08:00 | UTC+08:00 | -| `Asia/Kuching` | UTC+08:00 | UTC+08:00 | -| `Asia/Kuwait` | UTC+03:00 | UTC+03:00 | -| `Asia/Macao` | UTC+08:00 | UTC+08:00 | -| `Asia/Macau` | UTC+08:00 | UTC+08:00 | -| `Asia/Magadan` | UTC+11:00 | UTC+11:00 | -| `Asia/Makassar` | UTC+08:00 | UTC+08:00 | -| `Asia/Manila` | UTC+08:00 | UTC+08:00 | -| `Asia/Muscat` | UTC+04:00 | UTC+04:00 | -| `Asia/Nicosia` | UTC+02:00 | UTC+03:00 | -| `Asia/Novokuznetsk` | UTC+07:00 | UTC+07:00 | -| `Asia/Novosibirsk` | UTC+07:00 | UTC+07:00 | -| `Asia/Omsk` | UTC+06:00 | UTC+06:00 | -| `Asia/Oral` | UTC+05:00 | UTC+05:00 | -| `Asia/Phnom_Penh` | UTC+07:00 | UTC+07:00 | -| `Asia/Pontianak` | UTC+07:00 | UTC+07:00 | -| `Asia/Pyongyang` | UTC+09:00 | UTC+09:00 | -| `Asia/Qatar` | UTC+03:00 | UTC+03:00 | -| `Asia/Qostanay` | UTC+05:00 | UTC+05:00 | -| `Asia/Qyzylorda` | UTC+05:00 | UTC+05:00 | -| `Asia/Rangoon` | UTC+06:30 | UTC+06:30 | -| `Asia/Riyadh` | UTC+03:00 | UTC+03:00 | -| `Asia/Saigon` | UTC+07:00 | UTC+07:00 | -| `Asia/Sakhalin` | UTC+11:00 | UTC+11:00 | -| `Asia/Samarkand` | UTC+05:00 | UTC+05:00 | -| `Asia/Seoul` | UTC+09:00 | UTC+09:00 | -| `Asia/Shanghai` | UTC+08:00 | UTC+08:00 | -| `Asia/Singapore` | UTC+08:00 | UTC+08:00 | -| `Asia/Srednekolymsk` | UTC+11:00 | UTC+11:00 | -| `Asia/Taipei` | UTC+08:00 | UTC+08:00 | -| `Asia/Tashkent` | UTC+05:00 | UTC+05:00 | -| `Asia/Tbilisi` | UTC+04:00 | UTC+04:00 | -| `Asia/Tehran` | UTC+03:30 | UTC+03:30 | -| `Asia/Tel_Aviv` | UTC+02:00 | UTC+03:00 | -| `Asia/Thimbu` | UTC+06:00 | UTC+06:00 | -| `Asia/Thimphu` | UTC+06:00 | UTC+06:00 | -| `Asia/Tokyo` | UTC+09:00 | UTC+09:00 | -| `Asia/Tomsk` | UTC+07:00 | UTC+07:00 | -| `Asia/Ujung_Pandang` | UTC+08:00 | UTC+08:00 | -| `Asia/Ulaanbaatar` | UTC+08:00 | UTC+08:00 | -| `Asia/Ulan_Bator` | UTC+08:00 | UTC+08:00 | -| `Asia/Urumqi` | UTC+06:00 | UTC+06:00 | -| `Asia/Ust-Nera` | UTC+10:00 | UTC+10:00 | -| `Asia/Vientiane` | UTC+07:00 | UTC+07:00 | -| `Asia/Vladivostok` | UTC+10:00 | UTC+10:00 | -| `Asia/Yakutsk` | UTC+09:00 | UTC+09:00 | -| `Asia/Yangon` | UTC+06:30 | UTC+06:30 | -| `Asia/Yekaterinburg` | UTC+05:00 | UTC+05:00 | -| `Asia/Yerevan` | UTC+04:00 | UTC+04:00 | - -## Atlantic - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Atlantic/Azores` | UTC-01:00 | UTC | -| `Atlantic/Bermuda` | UTC-04:00 | UTC-03:00 | -| `Atlantic/Canary` | UTC | UTC+01:00 | -| `Atlantic/Cape_Verde` | UTC-01:00 | UTC-01:00 | -| `Atlantic/Faeroe` | UTC | UTC+01:00 | -| `Atlantic/Faroe` | UTC | UTC+01:00 | -| `Atlantic/Jan_Mayen` | UTC+01:00 | UTC+02:00 | -| `Atlantic/Madeira` | UTC | UTC+01:00 | -| `Atlantic/Reykjavik` | UTC | UTC | -| `Atlantic/South_Georgia` | UTC-02:00 | UTC-02:00 | -| `Atlantic/St_Helena` | UTC | UTC | -| `Atlantic/Stanley` | UTC-03:00 | UTC-03:00 | - -## Australia - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Australia/ACT` | UTC+11:00 | UTC+10:00 | -| `Australia/Adelaide` | UTC+10:30 | UTC+09:30 | -| `Australia/Brisbane` | UTC+10:00 | UTC+10:00 | -| `Australia/Broken_Hill` | UTC+10:30 | UTC+09:30 | -| `Australia/Canberra` | UTC+11:00 | UTC+10:00 | -| `Australia/Currie` | UTC+11:00 | UTC+10:00 | -| `Australia/Darwin` | UTC+09:30 | UTC+09:30 | -| `Australia/Eucla` | UTC+08:45 | UTC+08:45 | -| `Australia/Hobart` | UTC+11:00 | UTC+10:00 | -| `Australia/LHI` | UTC+11:00 | UTC+10:30 | -| `Australia/Lindeman` | UTC+10:00 | UTC+10:00 | -| `Australia/Lord_Howe` | UTC+11:00 | UTC+10:30 | -| `Australia/Melbourne` | UTC+11:00 | UTC+10:00 | -| `Australia/NSW` | UTC+11:00 | UTC+10:00 | -| `Australia/North` | UTC+09:30 | UTC+09:30 | -| `Australia/Perth` | UTC+08:00 | UTC+08:00 | -| `Australia/Queensland` | UTC+10:00 | UTC+10:00 | -| `Australia/South` | UTC+10:30 | UTC+09:30 | -| `Australia/Sydney` | UTC+11:00 | UTC+10:00 | -| `Australia/Tasmania` | UTC+11:00 | UTC+10:00 | -| `Australia/Victoria` | UTC+11:00 | UTC+10:00 | -| `Australia/West` | UTC+08:00 | UTC+08:00 | -| `Australia/Yancowinna` | UTC+10:30 | UTC+09:30 | - -## Brazil - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Brazil/Acre` | UTC-05:00 | UTC-05:00 | -| `Brazil/DeNoronha` | UTC-02:00 | UTC-02:00 | -| `Brazil/East` | UTC-03:00 | UTC-03:00 | -| `Brazil/West` | UTC-04:00 | UTC-04:00 | - -## Canada - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Canada/Atlantic` | UTC-04:00 | UTC-03:00 | -| `Canada/Central` | UTC-06:00 | UTC-05:00 | -| `Canada/Eastern` | UTC-05:00 | UTC-04:00 | -| `Canada/Mountain` | UTC-07:00 | UTC-06:00 | -| `Canada/Newfoundland` | UTC-03:30 | UTC-02:30 | -| `Canada/Pacific` | UTC-08:00 | UTC-07:00 | -| `Canada/Saskatchewan` | UTC-06:00 | UTC-06:00 | -| `Canada/Yukon` | UTC-07:00 | UTC-07:00 | - -## Chile - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Chile/Continental` | UTC-03:00 | UTC-04:00 | -| `Chile/EasterIsland` | UTC-05:00 | UTC-06:00 | - -## Europe - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Europe/Amsterdam` | UTC+01:00 | UTC+02:00 | -| `Europe/Andorra` | UTC+01:00 | UTC+02:00 | -| `Europe/Astrakhan` | UTC+04:00 | UTC+04:00 | -| `Europe/Athens` | UTC+02:00 | UTC+03:00 | -| `Europe/Belfast` | UTC | UTC+01:00 | -| `Europe/Belgrade` | UTC+01:00 | UTC+02:00 | -| `Europe/Berlin` | UTC+01:00 | UTC+02:00 | -| `Europe/Bratislava` | UTC+01:00 | UTC+02:00 | -| `Europe/Brussels` | UTC+01:00 | UTC+02:00 | -| `Europe/Bucharest` | UTC+02:00 | UTC+03:00 | -| `Europe/Budapest` | UTC+01:00 | UTC+02:00 | -| `Europe/Busingen` | UTC+01:00 | UTC+02:00 | -| `Europe/Chisinau` | UTC+02:00 | UTC+03:00 | -| `Europe/Copenhagen` | UTC+01:00 | UTC+02:00 | -| `Europe/Dublin` | UTC | UTC+01:00 | -| `Europe/Gibraltar` | UTC+01:00 | UTC+02:00 | -| `Europe/Guernsey` | UTC | UTC+01:00 | -| `Europe/Helsinki` | UTC+02:00 | UTC+03:00 | -| `Europe/Isle_of_Man` | UTC | UTC+01:00 | -| `Europe/Istanbul` | UTC+03:00 | UTC+03:00 | -| `Europe/Jersey` | UTC | UTC+01:00 | -| `Europe/Kaliningrad` | UTC+02:00 | UTC+02:00 | -| `Europe/Kiev` | UTC+02:00 | UTC+03:00 | -| `Europe/Kirov` | UTC+03:00 | UTC+03:00 | -| `Europe/Kyiv` | UTC+02:00 | UTC+03:00 | -| `Europe/Lisbon` | UTC | UTC+01:00 | -| `Europe/Ljubljana` | UTC+01:00 | UTC+02:00 | -| `Europe/London` | UTC | UTC+01:00 | -| `Europe/Luxembourg` | UTC+01:00 | UTC+02:00 | -| `Europe/Madrid` | UTC+01:00 | UTC+02:00 | -| `Europe/Malta` | UTC+01:00 | UTC+02:00 | -| `Europe/Mariehamn` | UTC+02:00 | UTC+03:00 | -| `Europe/Minsk` | UTC+03:00 | UTC+03:00 | -| `Europe/Monaco` | UTC+01:00 | UTC+02:00 | -| `Europe/Moscow` | UTC+03:00 | UTC+03:00 | -| `Europe/Nicosia` | UTC+02:00 | UTC+03:00 | -| `Europe/Oslo` | UTC+01:00 | UTC+02:00 | -| `Europe/Paris` | UTC+01:00 | UTC+02:00 | -| `Europe/Podgorica` | UTC+01:00 | UTC+02:00 | -| `Europe/Prague` | UTC+01:00 | UTC+02:00 | -| `Europe/Riga` | UTC+02:00 | UTC+03:00 | -| `Europe/Rome` | UTC+01:00 | UTC+02:00 | -| `Europe/Samara` | UTC+04:00 | UTC+04:00 | -| `Europe/San_Marino` | UTC+01:00 | UTC+02:00 | -| `Europe/Sarajevo` | UTC+01:00 | UTC+02:00 | -| `Europe/Saratov` | UTC+04:00 | UTC+04:00 | -| `Europe/Simferopol` | UTC+03:00 | UTC+03:00 | -| `Europe/Skopje` | UTC+01:00 | UTC+02:00 | -| `Europe/Sofia` | UTC+02:00 | UTC+03:00 | -| `Europe/Stockholm` | UTC+01:00 | UTC+02:00 | -| `Europe/Tallinn` | UTC+02:00 | UTC+03:00 | -| `Europe/Tirane` | UTC+01:00 | UTC+02:00 | -| `Europe/Tiraspol` | UTC+02:00 | UTC+03:00 | -| `Europe/Ulyanovsk` | UTC+04:00 | UTC+04:00 | -| `Europe/Uzhgorod` | UTC+02:00 | UTC+03:00 | -| `Europe/Vaduz` | UTC+01:00 | UTC+02:00 | -| `Europe/Vatican` | UTC+01:00 | UTC+02:00 | -| `Europe/Vienna` | UTC+01:00 | UTC+02:00 | -| `Europe/Vilnius` | UTC+02:00 | UTC+03:00 | -| `Europe/Volgograd` | UTC+03:00 | UTC+03:00 | -| `Europe/Warsaw` | UTC+01:00 | UTC+02:00 | -| `Europe/Zagreb` | UTC+01:00 | UTC+02:00 | -| `Europe/Zaporozhye` | UTC+02:00 | UTC+03:00 | -| `Europe/Zurich` | UTC+01:00 | UTC+02:00 | - -## Indian - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Indian/Antananarivo` | UTC+03:00 | UTC+03:00 | -| `Indian/Chagos` | UTC+06:00 | UTC+06:00 | -| `Indian/Christmas` | UTC+07:00 | UTC+07:00 | -| `Indian/Cocos` | UTC+06:30 | UTC+06:30 | -| `Indian/Comoro` | UTC+03:00 | UTC+03:00 | -| `Indian/Kerguelen` | UTC+05:00 | UTC+05:00 | -| `Indian/Mahe` | UTC+04:00 | UTC+04:00 | -| `Indian/Maldives` | UTC+05:00 | UTC+05:00 | -| `Indian/Mauritius` | UTC+04:00 | UTC+04:00 | -| `Indian/Mayotte` | UTC+03:00 | UTC+03:00 | -| `Indian/Reunion` | UTC+04:00 | UTC+04:00 | - -## Mexico - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Mexico/BajaNorte` | UTC-08:00 | UTC-07:00 | -| `Mexico/BajaSur` | UTC-07:00 | UTC-07:00 | -| `Mexico/General` | UTC-06:00 | UTC-06:00 | - -## Pacific - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `Pacific/Apia` | UTC+13:00 | UTC+13:00 | -| `Pacific/Auckland` | UTC+13:00 | UTC+12:00 | -| `Pacific/Bougainville` | UTC+11:00 | UTC+11:00 | -| `Pacific/Chatham` | UTC+13:45 | UTC+12:45 | -| `Pacific/Chuuk` | UTC+10:00 | UTC+10:00 | -| `Pacific/Easter` | UTC-05:00 | UTC-06:00 | -| `Pacific/Efate` | UTC+11:00 | UTC+11:00 | -| `Pacific/Enderbury` | UTC+13:00 | UTC+13:00 | -| `Pacific/Fakaofo` | UTC+13:00 | UTC+13:00 | -| `Pacific/Fiji` | UTC+12:00 | UTC+12:00 | -| `Pacific/Funafuti` | UTC+12:00 | UTC+12:00 | -| `Pacific/Galapagos` | UTC-06:00 | UTC-06:00 | -| `Pacific/Gambier` | UTC-09:00 | UTC-09:00 | -| `Pacific/Guadalcanal` | UTC+11:00 | UTC+11:00 | -| `Pacific/Guam` | UTC+10:00 | UTC+10:00 | -| `Pacific/Honolulu` | UTC-10:00 | UTC-10:00 | -| `Pacific/Johnston` | UTC-10:00 | UTC-10:00 | -| `Pacific/Kanton` | UTC+13:00 | UTC+13:00 | -| `Pacific/Kiritimati` | UTC+14:00 | UTC+14:00 | -| `Pacific/Kosrae` | UTC+11:00 | UTC+11:00 | -| `Pacific/Kwajalein` | UTC+12:00 | UTC+12:00 | -| `Pacific/Majuro` | UTC+12:00 | UTC+12:00 | -| `Pacific/Marquesas` | UTC-09:30 | UTC-09:30 | -| `Pacific/Midway` | UTC-11:00 | UTC-11:00 | -| `Pacific/Nauru` | UTC+12:00 | UTC+12:00 | -| `Pacific/Niue` | UTC-11:00 | UTC-11:00 | -| `Pacific/Norfolk` | UTC+12:00 | UTC+11:00 | -| `Pacific/Noumea` | UTC+11:00 | UTC+11:00 | -| `Pacific/Pago_Pago` | UTC-11:00 | UTC-11:00 | -| `Pacific/Palau` | UTC+09:00 | UTC+09:00 | -| `Pacific/Pitcairn` | UTC-08:00 | UTC-08:00 | -| `Pacific/Pohnpei` | UTC+11:00 | UTC+11:00 | -| `Pacific/Ponape` | UTC+11:00 | UTC+11:00 | -| `Pacific/Port_Moresby` | UTC+10:00 | UTC+10:00 | -| `Pacific/Rarotonga` | UTC-10:00 | UTC-10:00 | -| `Pacific/Saipan` | UTC+10:00 | UTC+10:00 | -| `Pacific/Samoa` | UTC-11:00 | UTC-11:00 | -| `Pacific/Tahiti` | UTC-10:00 | UTC-10:00 | -| `Pacific/Tarawa` | UTC+12:00 | UTC+12:00 | -| `Pacific/Tongatapu` | UTC+13:00 | UTC+13:00 | -| `Pacific/Truk` | UTC+10:00 | UTC+10:00 | -| `Pacific/Wake` | UTC+12:00 | UTC+12:00 | -| `Pacific/Wallis` | UTC+12:00 | UTC+12:00 | -| `Pacific/Yap` | UTC+10:00 | UTC+10:00 | - -## US - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `US/Alaska` | UTC-09:00 | UTC-08:00 | -| `US/Aleutian` | UTC-10:00 | UTC-09:00 | -| `US/Arizona` | UTC-07:00 | UTC-07:00 | -| `US/Central` | UTC-06:00 | UTC-05:00 | -| `US/East-Indiana` | UTC-05:00 | UTC-04:00 | -| `US/Eastern` | UTC-05:00 | UTC-04:00 | -| `US/Hawaii` | UTC-10:00 | UTC-10:00 | -| `US/Indiana-Starke` | UTC-06:00 | UTC-05:00 | -| `US/Michigan` | UTC-05:00 | UTC-04:00 | -| `US/Mountain` | UTC-07:00 | UTC-06:00 | -| `US/Pacific` | UTC-08:00 | UTC-07:00 | -| `US/Samoa` | UTC-11:00 | UTC-11:00 | - -## Legacy and fixed-offset IDs - -The tz database keeps these for backwards compatibility. Each is either an alias for a -`Region/City` zone or a fixed offset that never shifts, so prefer the `Region/City` form -above. `UTC` is the one worth using directly: it is the default, and the right choice when -you want timestamps to stay comparable across hosts. - -The `Etc/GMT+N` IDs have **inverted** signs, a tz database quirk: `Etc/GMT+5` is five hours -*behind* UTC. - -| Zone ID | Offset (January) | Offset (July) | -| --- | --- | --- | -| `CET` | UTC+01:00 | UTC+02:00 | -| `CST6CDT` | UTC-06:00 | UTC-05:00 | -| `Cuba` | UTC-05:00 | UTC-04:00 | -| `EET` | UTC+02:00 | UTC+03:00 | -| `EST5EDT` | UTC-05:00 | UTC-04:00 | -| `Egypt` | UTC+02:00 | UTC+03:00 | -| `Eire` | UTC | UTC+01:00 | -| `Etc/GMT` | UTC | UTC | -| `Etc/GMT+0` | UTC | UTC | -| `Etc/GMT+1` | UTC-01:00 | UTC-01:00 | -| `Etc/GMT+10` | UTC-10:00 | UTC-10:00 | -| `Etc/GMT+11` | UTC-11:00 | UTC-11:00 | -| `Etc/GMT+12` | UTC-12:00 | UTC-12:00 | -| `Etc/GMT+2` | UTC-02:00 | UTC-02:00 | -| `Etc/GMT+3` | UTC-03:00 | UTC-03:00 | -| `Etc/GMT+4` | UTC-04:00 | UTC-04:00 | -| `Etc/GMT+5` | UTC-05:00 | UTC-05:00 | -| `Etc/GMT+6` | UTC-06:00 | UTC-06:00 | -| `Etc/GMT+7` | UTC-07:00 | UTC-07:00 | -| `Etc/GMT+8` | UTC-08:00 | UTC-08:00 | -| `Etc/GMT+9` | UTC-09:00 | UTC-09:00 | -| `Etc/GMT-0` | UTC | UTC | -| `Etc/GMT-1` | UTC+01:00 | UTC+01:00 | -| `Etc/GMT-10` | UTC+10:00 | UTC+10:00 | -| `Etc/GMT-11` | UTC+11:00 | UTC+11:00 | -| `Etc/GMT-12` | UTC+12:00 | UTC+12:00 | -| `Etc/GMT-13` | UTC+13:00 | UTC+13:00 | -| `Etc/GMT-14` | UTC+14:00 | UTC+14:00 | -| `Etc/GMT-2` | UTC+02:00 | UTC+02:00 | -| `Etc/GMT-3` | UTC+03:00 | UTC+03:00 | -| `Etc/GMT-4` | UTC+04:00 | UTC+04:00 | -| `Etc/GMT-5` | UTC+05:00 | UTC+05:00 | -| `Etc/GMT-6` | UTC+06:00 | UTC+06:00 | -| `Etc/GMT-7` | UTC+07:00 | UTC+07:00 | -| `Etc/GMT-8` | UTC+08:00 | UTC+08:00 | -| `Etc/GMT-9` | UTC+09:00 | UTC+09:00 | -| `Etc/GMT0` | UTC | UTC | -| `Etc/Greenwich` | UTC | UTC | -| `Etc/UCT` | UTC | UTC | -| `Etc/UTC` | UTC | UTC | -| `Etc/Universal` | UTC | UTC | -| `Etc/Zulu` | UTC | UTC | -| `GB` | UTC | UTC+01:00 | -| `GB-Eire` | UTC | UTC+01:00 | -| `GMT` | UTC | UTC | -| `GMT0` | UTC | UTC | -| `Greenwich` | UTC | UTC | -| `Hongkong` | UTC+08:00 | UTC+08:00 | -| `Iceland` | UTC | UTC | -| `Iran` | UTC+03:30 | UTC+03:30 | -| `Israel` | UTC+02:00 | UTC+03:00 | -| `Jamaica` | UTC-05:00 | UTC-05:00 | -| `Japan` | UTC+09:00 | UTC+09:00 | -| `Kwajalein` | UTC+12:00 | UTC+12:00 | -| `Libya` | UTC+02:00 | UTC+02:00 | -| `MET` | UTC+01:00 | UTC+02:00 | -| `MST7MDT` | UTC-07:00 | UTC-06:00 | -| `NZ` | UTC+13:00 | UTC+12:00 | -| `NZ-CHAT` | UTC+13:45 | UTC+12:45 | -| `Navajo` | UTC-07:00 | UTC-06:00 | -| `PRC` | UTC+08:00 | UTC+08:00 | -| `PST8PDT` | UTC-08:00 | UTC-07:00 | -| `Poland` | UTC+01:00 | UTC+02:00 | -| `Portugal` | UTC | UTC+01:00 | -| `ROK` | UTC+09:00 | UTC+09:00 | -| `Singapore` | UTC+08:00 | UTC+08:00 | -| `SystemV/AST4` | UTC-04:00 | UTC-04:00 | -| `SystemV/AST4ADT` | UTC-04:00 | UTC-03:00 | -| `SystemV/CST6` | UTC-06:00 | UTC-06:00 | -| `SystemV/CST6CDT` | UTC-06:00 | UTC-05:00 | -| `SystemV/EST5` | UTC-05:00 | UTC-05:00 | -| `SystemV/EST5EDT` | UTC-05:00 | UTC-04:00 | -| `SystemV/HST10` | UTC-10:00 | UTC-10:00 | -| `SystemV/MST7` | UTC-07:00 | UTC-07:00 | -| `SystemV/MST7MDT` | UTC-07:00 | UTC-06:00 | -| `SystemV/PST8` | UTC-08:00 | UTC-08:00 | -| `SystemV/PST8PDT` | UTC-08:00 | UTC-07:00 | -| `SystemV/YST9` | UTC-09:00 | UTC-09:00 | -| `SystemV/YST9YDT` | UTC-09:00 | UTC-08:00 | -| `Turkey` | UTC+03:00 | UTC+03:00 | -| `UCT` | UTC | UTC | -| `UTC` | UTC | UTC | -| `Universal` | UTC | UTC | -| `W-SU` | UTC+03:00 | UTC+03:00 | -| `WET` | UTC | UTC+01:00 | -| `Zulu` | UTC | UTC | - diff --git a/docs/SYNCING-PROTOCOL.md b/docs/SYNCING-PROTOCOL.md index 5b0949a10..75fcad3bc 100644 --- a/docs/SYNCING-PROTOCOL.md +++ b/docs/SYNCING-PROTOCOL.md @@ -23,36 +23,6 @@ parity with each other. Additionally, it will find or create a `projectId` for the client's local projects. These are the key to being able to sync a local project with the server. -### Phase ordering - -The phases run **delete, then rename, then create**, and the order is load-bearing. A project name is -unique per account server-side, so a rename or a creation that takes the name of a project the same -session is about to delete is rejected until the delete has freed it. Renaming a project onto a name -another live project still holds answers `409 Conflict`. - -### Stale project IDs - -A local project caches the `projectId` it was assigned, so a client that last synced against a -different server (or one whose database has since been reset) holds IDs that server never issued. -Account sync therefore treats a cached ID the server neither lists in `begin_sync` nor reports in -`deletedProjects` as **dead**, and recreates the project as though it had no ID at all. - -Liveness is judged against the raw `begin_sync` response. A project the client has queued for -deletion is filtered out of the working copy of that list, but it is still known to the server, and -judging it against the filtered list would recreate what the user just deleted. A tombstoned ID is -likewise not dead: it means a real server-side delete, which propagates as a local deletion instead. - -Replacing an ID strands anything else queued against the old one, so the queues are withdrawn -rather than retried: - -- A **rename** queued against an ID the server does not know is dropped without being sent. The - server cannot rename an ID it never issued, so retrying only logs an error every session; - recreation already covers it, because the project is created under its current local name. A - rename queued against a **tombstoned** ID is dropped for the same reason: the delete phase has - already removed the project locally, and the server has nothing left to rename. -- A **creation** queued for a name with no local project is dropped. The project was deleted before - it ever reached the server, so creating it would push an empty project out to every device. - Any given user account may only have one sync in progress at a time. Attempting to start a sync when one is already in progress will result in a failure to begin the sync (`400 Bad Request`). @@ -83,21 +53,6 @@ sequenceDiagram Server -x Client: 400 Bad Request (sync ends here) end end - rect rgb(74, 0, 9) - loop Delete Projects - Client ->> Server: POST /api/projects/{userId}/delete - deactivate Client - activate Server - Note right of Client: bearer token
syncId
projectId - Server -->> Client: 200 OK (Delete successful) - deactivate Server - activate Client - alt Delete fails - Server -->> Client: 4XX Bad Request - end - end - end - rect rgb(11, 0, 74) loop Rename Projects Client ->> Server: POST /api/projects/{userId}/rename @@ -113,6 +68,21 @@ sequenceDiagram end end + rect rgb(74, 0, 9) + loop Delete Projects + Client ->> Server: POST /api/projects/{userId}/delete + deactivate Client + activate Server + Note right of Client: bearer token
syncId
projectId + Server -->> Client: 200 OK (Delete successful) + deactivate Server + activate Client + alt Delete fails + Server -->> Client: 4XX Bad Request + end + end + end + rect rgb(49, 0, 74) loop Create Projects Client ->> Server: POST /api/projects/{userId}/create @@ -149,32 +119,6 @@ live idea set — which lets the client skip the Story Ideas phase entirely when --- -## Pairing another install - -Auth tokens are stored per `(userId, installId)`, and a refresh replaces that install's row, so two -devices can never share one token pair. A signed-in device mints a session for another of the -user's devices (the Wear OS app, which cannot type a password comfortably) with: - -``` -POST /api/account/pair_install/{userId} - Authorization: Bearer - form: installId= - 201: Token for the new install -``` - -- The caller's own install is derived from its bearer token, never from the request, and naming it - is refused with `400`: minting over it would replace the caller's session. -- A blank or missing `installId` is `400`; a pending-deletion or disallowed account is refused the - same way a token refresh is. -- Any *other* install id is accepted, and because `setToken` upserts on `(userId, installId)` it - replaces whatever token that install held. Pairing the same watch twice therefore rotates its - session, and naming a third device's install id signs that device out. Only the account's own - authenticated caller can do this, and install ids are random UUIDs held on the device itself. -- It shares the login rate limit. The phone never stores a password, so this is the only way it can - sign a watch in. - ---- - ## Story Ideas Sync (account-level) Story ideas are account-level content: markdown blobs with tags that live at the projects root @@ -363,19 +307,6 @@ The install is identified server-side from the authenticated bearer token (never The client also fires `end_sync` even when its sync is cancelled, so sessions are normally released cleanly; reclaim is the safety net for the cases where that request can't be delivered. -#### Unknown project (`410 Gone`) - -A project endpoint called with a `projectId` the user doesn't own answers **`410 Gone`**, not `404`. -The distinction matters: `download_entity` maps a `404` to "entity deleted on the server" and, for -an entity it doesn't already hold, silently marks it deleted. A project-level `404` would therefore -make a client abandon undownloaded entities when a project vanishes mid-sync. - -`410` is terminal for that ID: retrying can never succeed. On receiving it from `begin_sync` the -client discards the cached `projectId`, which drops the project back to the never-synced state, and -the next sync recreates it on the server. Without that the project would fail every sync forever, -because the only other repair path (account sync, above) is not run when syncing a single project -from inside the project itself. - You may however have `syncID`s for multiple different projects simultaneously. These are Project level `syncID`s. Account syncing use separate Account level `syncID`s. There may only be one valid Account level `syncID` at a time, and if there is a valid Account `syncID`, then no Project level `syncID`s are allowed to be created. The Account level sync must finish before any Project level syncs may begin. @@ -618,17 +549,6 @@ sequenceDiagram Two further branches aren't diagrammed: if the server has no blob yet (`204`) and the local data is non-default, the client uploads with a null `originalHash` (the server accepts a baseline-less upload unchecked); and if the hashes already match, the phase is a no-op (re-recording `lastSyncedHash` if it was stale). -One field is exempt from the per-field resolver: `dictionaryWords` (the project's user spell-check -dictionary) is merged by union on both paths. When a `409` differs from the local copy *only* in that -field, the client merges and re-uploads without involving the user; when other fields also differ, the -resolver appears for those and the dictionary is still unioned. A word deleted on one device is therefore -resurrected if the other device conflicts before the deletion syncs; that is accepted for a word list. - -Sync writes never clobber a concurrent local edit: the client snapshots the blob when the phase -starts, and when it installs the server-agreed state it re-applies any field the user changed since -that snapshot (dictionary words as an add/remove delta). Those edits then differ from the recorded -`lastSyncedHash`, so the next sync uploads them. - Unlike writing-activity sync (which swallows errors and continues), a non-conflict failure on the project-data phase fails the whole sync — the data is user-authored and silent loss is unacceptable. Note: unlike the entity endpoints, the `project_data` and `writing_activity` endpoints are not gated on a `syncID` — they simply run inside the sync session window. diff --git a/docs/WEAR-OS.md b/docs/WEAR-OS.md deleted file mode 100644 index 4449c42cf..000000000 --- a/docs/WEAR-OS.md +++ /dev/null @@ -1,311 +0,0 @@ -# Hammer for Wear OS - -_Design doc. Status: phases 1 to 3 implemented on the `wear-app` branch (sync extraction, -pairing endpoint, watch app with pairing, sign-in, project subscriptions, and background sync). -Phase 4 (capture) is complete: the guards, the capture activity, the expedited sync, the tile and -the complication have all landed. Capture, the tile and the complication are smoke tested end to -end on a Wear OS emulator against a local server, not yet on a watch._ - -A standalone Wear OS client for capturing notes and ideas while away from a desk, and for -listening to scenes read aloud. It reuses the `common` data and sync layers unchanged and -presents a watch-native UI. The watch is a full, independent sync client: after a one-time -pairing it talks to the sync server on its own and never depends on the phone. - -## Goals - -- Pick a project and add a note to it in one or two taps, offline, with voice input. -- Capture a Story Idea (no project needed) just as quickly. -- Everything captured offline syncs on its own the next time the watch has a network. -- Listen to a scene read aloud through Bluetooth headphones, with position remembered. -- Reuse `common` for all data, sync, and domain logic. No second implementation of anything. - -## Non-goals - -- Editing scenes, encyclopedia entries, timelines, or anything beyond notes and ideas. -- Conflict resolution UI on the watch. A project that needs resolution is shown as such and - resolved on a phone or desktop. -- Phone-relay transport. The watch does not send notes through the phone app. -- iOS or non-Wear watches. - -## Architecture decision: independent sync client - -Two shapes were considered. - -**Remote control for the phone.** The watch writes notes as Wearable Data Layer items, and the -phone app receives them and runs the existing `AddNoteWorker`. Cheapest, but the watch is -useless without the phone app installed and reachable, and it can never grow a read-aloud -feature because no content lives on the wrist. - -**Independent sync client (chosen).** The watch runs `common`, holds its own copy of the -projects it cares about, and syncs directly with the server. The protocol already treats every -device symmetrically, and offline ID collisions from a third device are resolved by -`IdConflictResolutionOperation` exactly as they are for phone plus desktop today. The phone is -involved only during pairing, to hand the watch a session. - -## Module layout - -``` -wear/ Wear OS application module. Depends on :common only, never on :composeUi. -``` - -- `applicationId` is the phone app's (`com.darkrockstudios.apps.hammer.android`) so Google Play - lists it under the same app. Version codes must be unique across the listing, so the wear - module derives its `versionCode` from `getVersionCode(...)` plus a fixed offset. -- Manifest declares `android.hardware.type.watch` and - `com.google.android.wearable.standalone = true`. -- UI: Wear Compose Material 3 (`androidx.wear.compose:compose-material3`), Wear Tiles with - ProtoLayout, and the complication data source library. Pin versions in - `gradle/libs.versions.toml` at implementation time; the `jetpack-compose-m3` skill covers the - component vocabulary. -- `play-services-wearable` is needed only for the pairing handshake. -- Not published to F-Droid initially. - -## Koin graph - -The watch has its own `Application` that calls `startKoin` with `mainModule`, -`appModule(scope)`, and a `wearModule`. `mainModule` hard-includes the Android `platformModule`, -which also wires phone-only services (share service, backup manager, focus mode, platform -settings component). The module is not split: every one of those is a lazy binding resolved only -by `composeUi` screens the watch never shows, and `PlatformSpellCheckerFactory` constructs inertly -and degrades to no checkers. `wearModule` adds only watch pieces (Data Layer client, pairing use -case). The encrypted shared-prefs auth token store works unchanged on Wear. - -`FileLogger` and the global crash handler live in `common/src/androidMain` so both applications -share them. - -On the phone, everything that touches Google Play services (the pairing listener, dialog, -responder, and `wearPairingModule`) lives in `android/src/gms`, added to the source set only for -non-F-Droid builds. `src/nogms` supplies an empty `playServicesModules` list, and the F-Droid -manifest simply omits the pairing service and activity. - -Backups: `BackupOperation` runs before every project sync. Projects on the watch are small and -few, so keep the behaviour rather than special-casing it; revisit if storage becomes a problem. - -## Sync orchestration extraction (upstream refactor) - -Per-project sync is already usable outside the UI (`AddNoteWorker` proves it). The -"sync everything" flow is not: account sync, the change probe, parallel project syncs, ideas, -reauth, and idea-conflict callbacks live inside `ProjectsListComponent.syncProjects`, mixed with -dialog status updates. - -Move that orchestration into a `common` use case (working name `SyncAccountUseCase`) with: - -- an explicit set of projects to sync (the watch passes its subscribed projects; the phone and - desktop pass everything), -- progress and log callbacks, -- `onUnauthorized` and `onIdeaConflict` hooks, -- a result describing per-project outcomes. - -`ProjectsListComponent` becomes a thin caller that maps results onto its dialog state. This is -a pure refactor with no behaviour change and lands first, on its own. It also makes a -WorkManager background sync on the phone trivial later. - -## Pairing and authentication - -Server tokens are stored per `(userId, installId)`, and a refresh replaces the row for that -install. The watch therefore must own its own install ID and its own token; copying the phone's -would make the two devices race each other on refresh. The phone stores no password, so it -cannot log in on the watch's behalf. A new server endpoint is needed: - -``` -POST /api/account/{userId}/pair_install - Authorization: Bearer - form: installId= - 200: Token for the new install -``` - -It is `createToken(userId, installId)` behind bearer auth. A device that holds a session can -already read and write everything, so minting a sibling session grants no new power. Rate limit -it and log it like login. - -Handshake, all over the Wearable Data Layer (app-private, carried on the encrypted Bluetooth -link): - -1. Watch generates its install ID via `GlobalSettingsStore.ensureInstallId()` and sends a - `pair_request` message carrying it. -2. Phone shows a confirmation, calls `pair_install`, and replies with a `pair_response` - message containing the `ServerSettings` payload (url, ssl, email, userId, bearer, refresh) - for the watch's install. -3. Watch stores the settings through the normal `GlobalSettingsStore` path and runs its first - account sync. - -Use `MessageClient`, not persisted `DataItem`s, so the token is never left lying in the Data -Layer store. If the watch is unreachable the phone simply reports that and the user retries. - -Client side, add `AccountUseCase.pairInstall(installId)` and the matching `ServerAccountApi` -call. The watch keeps a manual sign-in screen (server URL, email, password via `RemoteInput`) -as a fallback for a watch with no Hammer phone app. - -Sign out on the watch wipes local settings and projects; the server token expires on its own. -The existing audit finding that refresh tokens never expire applies to watch tokens too and is -tracked separately. - -### Local network access - -Android 17 blocks an app from reaching local network addresses until it holds -`ACCESS_LOCAL_NETWORK`, and a self-hosted server is usually on the LAN. A blocked connection does not -fail fast; it times out as a generic connection error, so the permission is settled before -connecting rather than diagnosed after. The watch asks only when the server needs it: the address is -resolved and checked against the private, loopback, link-local, IPv6 unique local, and carrier-grade -NAT ranges (the last covers mesh VPNs such as Tailscale). A name that will not resolve is judged by -how it looks (`.local`, `.lan`, `.home`, `.internal`, a single label). A server like hammer.ink never -triggers the prompt. - -- **Manual sign in** checks before the login request, since the login is the first thing that - touches the server. -- **Pairing** hands the watch its settings and lands on the projects screen, which holds its - app-open sync until the permission is answered. A refusal leaves the sync held with an - explanation and an Allow button. - -## Projects on the watch - -Account sync creates a local directory for every server project, with metadata and a server -project ID but no entities. Syncing content is opt-in per project: - -- The watch keeps its subscribed projects in a wear-owned DataStore (`WearPrefsDatasource`, the - only writer), keyed by server `ProjectId` so a rename does not drop a subscription. It is not a - `GlobalSettings` field because that file is shared by every platform. -- Only subscribed projects are passed to the sync use case. The change probe keeps repeat - syncs to a single request when nothing changed. -- A subscribed project's first sync pulls every entity, one request each. That is acceptable for - a novel and is shown with progress. - -**Notes can only be added to a subscribed, synced project.** An unsynced project has an empty -`IdAllocator`, so a note created there would take ID 1 and collide on every sync. Unsubscribed -projects appear in the picker greyed out with a "sync to enable" action. Ideas have no such -restriction because they are UUID keyed. - -## Capture flow - -- **Tile**: shows the last project captured to as a button, a "Note" button, a "Story idea" - button, and the count of unsynced items. Tapping the project opens capture on its picker, which - is the only way to change where a note goes without going into the app. The project button lives - in the main slot because the title slot does not receive taps. A tile launch action carrying an - `AndroidBooleanExtra` is silently dropped along with the whole action, so flags travel as - strings. Tiles cannot take input; the buttons launch the activity through a - `LaunchAction`, which is why `CaptureActivity` is exported. Built with ProtoLayout Material 3. -- **Complication**: SHORT_TEXT and MONOCHROMATIC_IMAGE, showing the unsynced count (or "Note" - when there is nothing waiting) and tapping through to capture. -- Both are cached by the system and re-read only on their own slow cadence, so anything that - changes the pending count calls `CaptureSurfaceUpdater`: a capture, and every finished sync. - Without it the watch face keeps showing a stale count. -- **Activity**: opens into `RemoteInput` (voice first, keyboard fallback) as soon as it knows a - capture has somewhere to go, never before: prompting first would take a whole dictated note and - then throw it away on the "no project" screen. The project defaults to the last one captured to - and is changed from a list, never a required step. - Confirm saves through `NotesRepository.createNote` inside `temporaryProjectTask`, exactly - like `AddNoteWorker`, then enqueues a sync. Saving runs in the app scope, so a capture still - lands if the watch drops the activity mid-save. -- The `RemoteInput` keyboard opens with shift engaged and offers no way to turn that off, so the - sign-in server and email are folded to lowercase. A password cannot be normalised, so a capital - there is the user's to fix. -- **Ideas**: the same flow through `IdeasRepository`, no project step. -- Show the pending count after save so the user knows the note exists locally even though it - has not synced. - -## Protecting captures that have not synced - -Everything the watch writes is offline-first, so two flows can destroy writing that never reached -the server. Both are guarded before the capture UI exists, because once capture ships the loss is -silent. - -- **Unsubscribing** syncs the project first, while it is still in the sync filter, then deletes - its content only if the sync journal reports nothing outstanding. If anything remains the - project keeps both its content and its subscription: an unsubscribed project is filtered out of - every later sync, so dropping the subscription would strand the writing rather than free it. - A count that cannot be read is treated as outstanding, so a failure can never authorise a - delete. -- **Signing out** counts the subscribed projects' pending entities plus ideas with no server - baseline, and asks for confirmation before wiping. An unreadable count still warns. - -`loadPendingEntityCount` is the source of truth for a project. It reads the journal file without a -project scope, because opening one initialises the scene tree, every scene's content, metadata and -the timeline, which is far too much work to learn how many entities are outstanding. A journal that -cannot be read throws rather than reporting zero: callers use the count to decide whether local -writing is safe to discard, and an unreadable journal is not evidence that it is. The watch reaches -it through `UnsyncedContentSource`, an interface, so the components can be tested with fakes. - -## Background sync - -WorkManager, mirroring the widget worker: - -- A one-time expedited request with a network constraint after every capture, enqueued with - `APPEND_OR_REPLACE`. `REPLACE` cancels work that is already running, so a second capture would - abort the first one's sync partway through the protocol. `SyncCoordinator` reports `Busy` rather - than `Skipped` when another sync holds the lock, so work that needs its own captures uploaded - asks again instead of reporting success. -- The pending count is gathered after the save is confirmed, not before. Nothing that can still - fail belongs between writing the user's words and telling them the words are safe. -- A periodic request (charging plus unmetered network) for all subscribed projects. -- A manual "Sync now" in the app. - -## Read aloud - -Phase-gated behind the rest, but designed in now because it depends on synced content. - -- A foreground service owning a `TextToSpeech` instance and a `MediaSession`, so headphone - controls and the system media UI work. Register an Ongoing Activity so the watch face shows - the session. -- Text pipeline: scene markdown to plain speech text. Add a `base` helper next to - `ProseHtml` that walks the same intellij-markdown tree the PDF renderer uses and emits plain - paragraphs, dropping formatting markers and turning headings and scene breaks into pauses. -- Chunk by paragraph, staying under `TextToSpeech.getMaxSpeechInputLength()`, and queue with - utterance IDs so progress is trackable. Persist the last utterance per scene so playback - resumes where it stopped. -- Controls: play/pause, next/previous scene in outline order, speed. -- Output device: check `AudioManager.getDevices(GET_DEVICES_OUTPUTS)` for a Bluetooth - headset before starting, pause on disconnect, and offer the media output switcher on Wear OS - 5 and later. Allow the watch speaker only when the platform reports one. -- Offline: Wear OS ships an on-device TTS engine with seven preloaded languages; other - languages download on Wi-Fi while charging. Voice quality is the on-device tier. Use the - project's language setting to pick the TTS locale. - -## Packaging and release - -- `versionName` comes from `libs.versions.toml` like every other target. `versionCode` is the - phone's plus 1,000,000,000 (`getWearVersionCode`), because every bundle in a Play listing needs - a unique code. -- The watch app is a second bundle in the phone's listing, released on Play's Wear OS form - factor tracks. Through the API those are `wear:qa` (internal testing), `wear:beta` and - `wear:production`. They exist only once Wear OS is added in the Play Console under Advanced - settings > Form factors; until then every upload to them fails. -- The Android lanes in `fastlane/Fastfile` build both bundles and upload the watch's after the - phone's, so a Wear OS failure never holds back a phone release. `internal`, `beta` and - `release` map to `wear:qa`, `wear:beta` and `wear:production`. `alpha` skips the watch: a - form factor has no default closed testing track, only custom-named ones. -- The watch upload sends release notes only. The listing is shared, and the phone upload already - sends its text and images, including any `images/wearScreenshots`. -- `prepareForRelease` writes the Play release notes under both version codes. -- `build.yml` builds and unit-tests the wear module. - -## Testing - -- `common` desktop tests for the extracted sync use case, driven with the existing fake - filesystem and in-memory datasources. -- Server route tests for `pair_install` (note that `frontend()` and account DI additions ripple - into the existing route-test fixtures). -- Compose previews for every watch screen, rendered and checked. -- Wear emulator smoke run through the `android-cli` skill. -- End to end: capture a note on the watch offline, come online, confirm it appears on desktop - after sync, and that a colliding note created offline on desktop is re-IDed rather than lost. - -## Phases - -1. **Sync use case extraction** in `common`. No behaviour change. Standalone PR. -2. **Pairing endpoint** on the server plus the client API and use case. Standalone PR. -3. **Wear module skeleton**: Koin split, pairing flow, manual sign-in fallback, project list - with subscribe and sync, sync status. -4. **Capture** (done): guards for unsynced captures, then the activity with `RemoteInput`, note - and idea flows, tile, complication, WorkManager sync. -5. **Read aloud**: markdown to speech helper in `base`, playback service, controls. -6. **Release pipeline** (done): fastlane lanes, release notes, version code offset. - -Phases 1 and 2 improve the phone and desktop clients on their own and should land even if the -watch slips. - -## Open questions - -- Does dictation work offline on the target watch? Voice capture is the point of the feature and - the emulator cannot answer this; it needs the real hardware. -- Whether backups on the watch stay on or get a no-op datasource once real usage shows the - storage cost. diff --git a/docs/WEB-DESIGN-SYSTEM.md b/docs/WEB-DESIGN-SYSTEM.md index f5396d4e7..481c49c96 100644 --- a/docs/WEB-DESIGN-SYSTEM.md +++ b/docs/WEB-DESIGN-SYSTEM.md @@ -513,47 +513,6 @@ h3 { } ``` -### Story Prose - -`.story-content` (in `story.css`) styles the sanitized HTML that `MarkdownService` produces from an -author's scenes. It is the one place where the page renders text the site did not write, so every -element markdown can emit has a rule: - -| Element | Treatment | -|--------------|---------------------------------------------------------------------------------| -| `p` | One authored line: 2em first-line indent, justified, no margin between siblings | -| `h1` | The story title, in Kingthings at 2rem | -| `h2` | Chapter heading: centered, with a dashed rule above it and 4rem of air, dropped on the first one | -| `h3` / `h4` | Kingthings, stepping down in size, 2.5rem above | -| `h5` / `h6` | Uppercase, letter-spaced and secondary-colored rather than larger | -| `ul` / `ol` | 3.5em indent so markers sit inside the prose indent, 0.75em between items, accent markers | -| `table` | Centered, hairline-ruled, scrolls inside itself; header row in Kingthings on a tint | -| `hr` | Centered short rule with an amber diamond, 3rem of air above and below | -| `blockquote` | Tinted panel, amber left rule, italic, with `em` flipped upright inside | -| `pre` | Tinted box that wraps rather than overflows the column | -| `code` | Courier; a tinted pill when it sits inline in a paragraph or list item | -| `a` | Accent-colored, underlined with a softened amber rule | - -`br` needs no rule: it is the break `MarkdownService` emits for each blank line between two -paragraphs, and it inherits the prose line height. - -Prose is laid out as the author typed it, which is what they see in the editor: every newline in a -paragraph starts a new line and every blank line is a blank line. Paragraph siblings carry no -margin, so consecutive lines sit directly under one another and each takes the first-line indent. -Headings, lists, quotes and rules keep their own spacing; blank lines next to them add nothing, and -a list keeps markdown's own layout rather than the author's line breaks. - -An element the sanitizer drops keeps its text, so anything the parser can emit needs either a rule -here or a deliberate exclusion. Images and task-list checkboxes are excluded: a remote image on a -public page is a tracking pixel, and a checkbox is a form control. - -The prose element declares the story's language (`lang` on `.story-content`) on both the author's -page and the public reader page, so the browser hyphenates by the story's rules rather than the -reader's UI locale. - -Below 600px the column is too narrow to justify without opening rivers, so paragraphs go ragged -right and hyphenation is off. - --- ## Shared Animations @@ -798,12 +757,6 @@ For displaying when lists have no content. **Variants:** `.toast-success`, `.toast-warning`, `.toast-error`, `.toast-info` -Send toasts with the `respondToast` / `respondHtmlWithToast` / `respondTemplateWithToast` helpers -rather than hand-writing the markup. An endpoint that rejects a request should answer with its real -error status: the helpers mark error responses with `X-Hammer-Swap-Error`, which is what makes htmx -swap a body it would otherwise discard, and toast-only errors also reswap to `none` so the request's -target keeps its content. A raw `call.respond(HttpStatusCode.BadRequest, ...)` gets no toast. - --- ## Form Components @@ -921,8 +874,8 @@ While the shared components cover most use cases, some pages have additional spe - **home.css** - Marketing page sticky notes, feature grid, download cards - **dashboard.css** - Pen name section, danger zone, account info -- **admin.css** - Sidebar navigation, allowed users management (CSS class names still use the legacy `whitelist-` prefix) -- **login.css** - Login header styling, error shake animation, allowed-users notices +- **admin.css** - Sidebar navigation, whitelist management +- **login.css** - Login header styling, error shake animation, whitelist notices - **author.css** - Author header with avatar, story count - **story.css** - Story content formatting, publish toggle, access list - **error.css** - Colored sticky-note error cards with animations diff --git a/fastlane/Appfile b/fastlane/Appfile index 57d7804d2..bc23e7a8b 100644 --- a/fastlane/Appfile +++ b/fastlane/Appfile @@ -8,9 +8,3 @@ for_platform :mac do apple_id("adamwbrown@gmail.com") team_id("8P3G3HT4J5") end - -for_platform :ios do - app_identifier("com.darkrockstudios.apps.hammer") - apple_id("adamwbrown@gmail.com") - team_id("8P3G3HT4J5") -end diff --git a/fastlane/Fastfile b/fastlane/Fastfile index 4291160a8..99bb0f9f7 100644 --- a/fastlane/Fastfile +++ b/fastlane/Fastfile @@ -15,21 +15,6 @@ default_platform(:android) -# The release bundle a Gradle module builds. Named rather than taken from the gradle -# action's lane context, which only remembers the last of several bundles. -def play_bundle(module_name) - path = File.expand_path("../#{module_name}/build/outputs/bundle/release/#{module_name}-release.aab", __dir__) - UI.user_error!("No release bundle at #{path}") unless File.exist?(path) - path -end - -# R8 mapping for a module's release bundle, so Play can deobfuscate crash reports. -def play_mapping(module_name) - path = File.expand_path("../#{module_name}/build/outputs/mapping/release/mapping.txt", __dir__) - UI.user_error!("No R8 mapping at #{path}") unless File.exist?(path) - path -end - # Returns an App Store Connect API key hash for use in mac lanes. # The .p8 is gitignored in desktop/secrets/. private_lane :appstore_api_key do @@ -86,29 +71,6 @@ rescue => e false end -# App Store Connect validation failures: the version's contents or state are -# rejected outright, so the same call will fail identically forever. Retrying -# these only buries the real cause — the first 3.9.7 iOS submit spent all six -# attempts and five minutes restating "App screenshot missing". Matched on -# message text rather than exception class because Spaceship raises -# UnexpectedResponse for transient faults too, so the class cannot tell them -# apart. Keep this list narrow: anything not matched here still gets retried, -# which is the safe direction to be wrong in. -PERMANENT_DELIVER_ERRORS = [ - /is not in valid state/i, - /cannot be reviewed/i, - /screenshot missing/i, - /required but was not provided/i, -].freeze - -# Matches against the whole message, not just the first line: App Store Connect -# puts the summary on line 1 ("...is not in valid state") and the actual reasons -# on the lines below it ("App screenshot missing (APP_IPHONE_65)"). -def permanent_deliver_error?(error) - message = error.message.to_s - PERMANENT_DELIVER_ERRORS.any? { |pattern| message.match?(pattern) } -end - # Run deliver with a bounded retry. Right after upload the build is processed in # TestFlight but can lag propagating to the App Store version API, so deliver # crashes with "Could not find build". That crash happens during build lookup — @@ -128,14 +90,6 @@ def deliver_with_retry(params, attempts: 6, wait_seconds: 60) UI.success("App Store version #{params[:app_version]} is already submitted for review — deliver's error was a false negative.") return end - if permanent_deliver_error?(e) - # Print the whole message — the summary line names the version, but the - # lines under it are the ones that say what is actually wrong. - UI.error("App Store Connect rejected the submission. This will not clear on its own, so not retrying:") - UI.error(e.message.to_s) - raise - end - raise if try >= attempts UI.important("deliver attempt #{try}/#{attempts} failed: #{e.message.to_s.lines.first&.strip}") UI.important("Build may still be propagating to App Store Connect; retrying in #{wait_seconds}s…") @@ -255,37 +209,12 @@ platform :ios do lane :ios_submit do |options| params = { api_key: appstore_api_key, - app_identifier: "com.darkrockstudios.apps.hammer", + app_identifier: "com.darkrockstudios.apps.hammer.ios", platform: "ios", app_version: app_marketing_version, skip_binary_upload: true, - # Screenshots must be uploaded, unlike the :mac lane. iOS moved onto the - # macOS app record for Universal Purchase, and that record's iOS platform - # started with no screenshots at all — nothing carried over from the old - # standalone iOS listing. App Store Connect refuses to submit a version - # with no iPhone screenshots, and the failure lands after the binary is - # already uploaded. Uploading every release also keeps the store in sync - # with fastlane/metadata/ios. - skip_screenshots: false, + skip_screenshots: true, metadata_path: "fastlane/metadata/ios", - # screenshots_path is a separate option from metadata_path and defaults to - # ./fastlane/screenshots. deliver globs //*.png FLAT — it - # does not descend into per-device folders (only appleTV/iMessage are - # special-cased), and it derives the device from the image's pixel size, - # not from any folder name. The screenshots therefore live flat in - # fastlane/screenshots/ios//. Get this wrong and deliver silently - # uploads nothing, logs "Successfully uploaded all screenshots", and the - # submit fails with "App screenshot missing (APP_IPHONE_65)". - # - # Filenames matter too: 2732x2048 is ambiguous between the 2nd- and - # 3rd-gen iPad Pro, and deliver picks the 2nd gen if the path contains - # "app_ipad_pro_129" or both "12.9" and "2nd generation". Ours avoid - # those, so they resolve to APP_IPAD_PRO_3GEN_129, which is what App - # Store Connect asks for. - screenshots_path: "fastlane/screenshots/ios", - # deliver_with_retry can invoke deliver several times; without this each - # attempt stacks another copy of every screenshot onto the version. - overwrite_screenshots: true, submit_for_review: true, automatic_release: true, run_precheck_before_submit: false, @@ -304,7 +233,7 @@ platform :ios do if build_number.nil? || build_number.empty? latest = latest_testflight_build_number( api_key: api_key, - app_identifier: "com.darkrockstudios.apps.hammer", + app_identifier: "com.darkrockstudios.apps.hammer.ios", platform: "ios", initial_build_number: 0, ) @@ -333,7 +262,7 @@ platform :ios do teamID: "8P3G3HT4J5", signingStyle: "manual", provisioningProfiles: { - "com.darkrockstudios.apps.hammer" => "Hammer AppStore iOS", + "com.darkrockstudios.apps.hammer.ios" => "Hammer AppStore iOS", }, }, clean: true, @@ -347,7 +276,7 @@ platform :ios do # cutting off a legitimately slow processing run at a tighter deadline. upload_to_testflight( api_key: api_key, - app_identifier: "com.darkrockstudios.apps.hammer", + app_identifier: "com.darkrockstudios.apps.hammer.ios", app_platform: "ios", ipa: lane_context[SharedValues::IPA_OUTPUT_PATH], skip_waiting_for_build_processing: !options[:wait], @@ -368,56 +297,39 @@ platform :android do desc "Submit a new Build to Google Play Internal" lane :internal do - play_build - upload_to_play_store(track: 'internal', aab: play_bundle("android"), mapping: play_mapping("android")) - upload_wear_bundle(track: 'wear:qa') + gradle( + task: ":android:bundleRelease", + gradle_path: "./gradlew" + ) + upload_to_play_store(track: 'internal') end desc "Submit a new Alpha Build to Google Play Close" lane :alpha do - play_build - upload_to_play_store(track: 'alpha', aab: play_bundle("android"), mapping: play_mapping("android")) - # Wear OS has no default closed testing track; closed tracks on a form factor are - # custom-named in the Play Console, so the watch app skips this lane. + gradle( + task: ":android:bundleRelease", + gradle_path: "./gradlew" + ) + upload_to_play_store(track: 'alpha') end desc "Submit a new Beta Build to Google Play Open" lane :beta do - play_build - upload_to_play_store(track: 'beta', aab: play_bundle("android"), mapping: play_mapping("android")) - upload_wear_bundle(track: 'wear:beta') + gradle( + task: ":android:bundleRelease", + gradle_path: "./gradlew" + ) + upload_to_play_store(track: 'beta') end desc "Deploy a new version to the Google Play" lane :release do - play_build(clean: true) - upload_to_play_store( - root_url: "https://androidpublisher.googleapis.com/", - aab: play_bundle("android"), - mapping: play_mapping("android") - ) - upload_wear_bundle(track: 'wear:production') - end - - private_lane :play_build do |options| gradle( - task: "#{options[:clean] ? 'clean ' : ''}:android:bundleRelease :wear:bundleRelease", - gradle_path: "./gradlew", - properties: { "channel" => "google-play" } + task: "clean bundleRelease", + gradle_path: "./gradlew" ) - end - - # The watch app is a second bundle in the same listing, on Play's Wear OS form factor - # tracks. Those only exist once Wear OS is added under Advanced settings > Form factors. - # It uploads after the phone so a Wear OS failure never holds back a phone release. The - # listing is shared and the phone upload already sent it, so only the release notes go. - private_lane :upload_wear_bundle do |options| upload_to_play_store( root_url: "https://androidpublisher.googleapis.com/", - track: options[:track], - aab: play_bundle("wear"), - mapping: play_mapping("wear"), - skip_upload_metadata: true, skip_upload_images: true, skip_upload_screenshots: true ) diff --git a/fastlane/metadata/android/de-DE/full_description.txt b/fastlane/metadata/android/de-DE/full_description.txt index 54742f5fb..86866e0b7 100644 --- a/fastlane/metadata/android/de-DE/full_description.txt +++ b/fastlane/metadata/android/de-DE/full_description.txt @@ -18,8 +18,4 @@ Deine Daten können zwischen Geräten synchronisiert werden, sodass du von über Synchronisierung: optional oder selbstbetrieben -Synchronisierung ist vollständig optional, du kannst den Client installieren und auf einem Gerät verwenden, oder du kannst den Server installieren und deine Daten zwischen den Geräten synchronisieren. - -Wear OS companion - -Capture notes and story ideas from your wrist with the Wear OS app, then pick them up on your other devices. Dictate or type a quick note and file it under a project. Add the Capture tile to start a note or story idea in a single tap, or put the Hammer complication on your watch face to open a new note. The watch app syncs through your Hammer sync server. \ No newline at end of file +Synchronisierung ist vollständig optional, du kannst den Client installieren und auf einem Gerät verwenden, oder du kannst den Server installieren und deine Daten zwischen den Geräten synchronisieren. \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/1310010000.txt b/fastlane/metadata/android/en-US/changelogs/1310010000.txt deleted file mode 100644 index ab9e09d8d..000000000 --- a/fastlane/metadata/android/en-US/changelogs/1310010000.txt +++ /dev/null @@ -1,15 +0,0 @@ -[New] -- A per-project spelling dictionary, so invented words aren't flagged -- Encyclopedia and draft names accept punctuation and non-Latin letters - -[Improved] -- A failed login says why, instead of a generic error -- Translations updated for six languages - -[Fixed] -- Credential fields no longer capitalize what you type -- Spelling suggestions could stick on "Loading" -- Sync no longer fails on an unknown field - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.10.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/1310020000.txt b/fastlane/metadata/android/en-US/changelogs/1310020000.txt deleted file mode 100644 index bd032c596..000000000 --- a/fastlane/metadata/android/en-US/changelogs/1310020000.txt +++ /dev/null @@ -1,4 +0,0 @@ -- Fix Android Wear release - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.10.1+google-play \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/1311010000.txt b/fastlane/metadata/android/en-US/changelogs/1311010000.txt deleted file mode 100644 index babcca355..000000000 --- a/fastlane/metadata/android/en-US/changelogs/1311010000.txt +++ /dev/null @@ -1,10 +0,0 @@ -New -- Web: readers can leave kudos on published stories -Improve -- Word counts skip Markdown markers like rules and bullets -Fix -- Editor: numpad keys, keyboard input, spelling underline and cursor fixes -- Wear OS: phone pairing works in release builds - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.11.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/1312010000.txt b/fastlane/metadata/android/en-US/changelogs/1312010000.txt deleted file mode 100644 index 4811653ff..000000000 --- a/fastlane/metadata/android/en-US/changelogs/1312010000.txt +++ /dev/null @@ -1,15 +0,0 @@ -New -- Reader Mode: read your story as prose, a chapter at a time -- Export options: chapter numbering, font, blank lines -- OLED black theme -- Turkish translation -- Text editor 3.0 - -Fixes -- Unsaved scene edits could be lost when the app closed in the background -- Restoring a backup could make the project disappear -- Discarded scenes were still saved and uploaded by sync -- PDF export cut off lines at page breaks - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.12.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/308010000.txt b/fastlane/metadata/android/en-US/changelogs/308010000.txt deleted file mode 100644 index 82765fc1e..000000000 --- a/fastlane/metadata/android/en-US/changelogs/308010000.txt +++ /dev/null @@ -1,9 +0,0 @@ -https://hammer.ink/blog/news/hammer-3-8-0 -New: -- Set the language a project is written in, and have spell check follow it -- Text editor: faster typing and relayout, word-wise undo with a much deeper history, and rich copy and paste that preserves formatting between apps -- Large Markdown imports are dramatically faster -- Search matches the rendered prose, resolving Markdown escapes and formatting… - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.8.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/308020000.txt b/fastlane/metadata/android/en-US/changelogs/308020000.txt deleted file mode 100644 index ae4c1b0d2..000000000 --- a/fastlane/metadata/android/en-US/changelogs/308020000.txt +++ /dev/null @@ -1,9 +0,0 @@ -Improvements -- text editor no longer drops block structure (horizontal rules, images, code fences) when a scene loads -- font size changes no longer flatten list and blockquote indents -- typed text after a size change could lose the paragraph's body style -- F3 and Ctrl+Alt+S sync shortcuts work from anywhere in the project window -- tag suggestion chips could add the typed prefix instead of the selected tag… - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.8.1 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/308030000.txt b/fastlane/metadata/android/en-US/changelogs/308030000.txt deleted file mode 100644 index dcb46be1e..000000000 --- a/fastlane/metadata/android/en-US/changelogs/308030000.txt +++ /dev/null @@ -1,6 +0,0 @@ -- About: Dark Rock Studios attribution screen improved, check it out! -- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian -Fixes - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.8.2 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309010000.txt b/fastlane/metadata/android/en-US/changelogs/309010000.txt deleted file mode 100644 index 62307f7a6..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309010000.txt +++ /dev/null @@ -1,14 +0,0 @@ -New -- Export just the scenes you pick, in any format -- Encyclopedia names feed spell check, so invented names aren't flagged -- Scenes connect to every kind of Encyclopedia entry -- Drag the editor's edge to set its width -Improved -- Exports lay prose out exactly as you wrote it -- Scenes accept typing right away -- Clearer scene tree nesting -Fixed -- Folders with exactly ten items could show blank scenes… - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309020000.txt b/fastlane/metadata/android/en-US/changelogs/309020000.txt deleted file mode 100644 index fff8d2d5c..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309020000.txt +++ /dev/null @@ -1,5 +0,0 @@ -- Fix sharing scene order -- Fix PDF export crash - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.1 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309030000.txt b/fastlane/metadata/android/en-US/changelogs/309030000.txt deleted file mode 100644 index a5151e7bc..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309030000.txt +++ /dev/null @@ -1,4 +0,0 @@ -Bug fixes and performance improvements - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.2 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309040000.txt b/fastlane/metadata/android/en-US/changelogs/309040000.txt deleted file mode 100644 index fd50224fa..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309040000.txt +++ /dev/null @@ -1,4 +0,0 @@ -Bug fixes - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.3+mac-app-store \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309050000.txt b/fastlane/metadata/android/en-US/changelogs/309050000.txt deleted file mode 100644 index 2066d92ac..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309050000.txt +++ /dev/null @@ -1,4 +0,0 @@ -Fix widgets not doing anything - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.4+google-play+fdroid \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309060000.txt b/fastlane/metadata/android/en-US/changelogs/309060000.txt deleted file mode 100644 index 951422e9f..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309060000.txt +++ /dev/null @@ -1,4 +0,0 @@ -Release fix - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.5+mac-app-store \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309070000.txt b/fastlane/metadata/android/en-US/changelogs/309070000.txt deleted file mode 100644 index 88a73cb90..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309070000.txt +++ /dev/null @@ -1,4 +0,0 @@ -Release fix - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.6+ios-app-store \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309080000.txt b/fastlane/metadata/android/en-US/changelogs/309080000.txt deleted file mode 100644 index a3ba12ac8..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309080000.txt +++ /dev/null @@ -1,4 +0,0 @@ -iOS Release fix - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.7+ios-app-store \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/309090000.txt b/fastlane/metadata/android/en-US/changelogs/309090000.txt deleted file mode 100644 index eb2e8d05e..000000000 --- a/fastlane/metadata/android/en-US/changelogs/309090000.txt +++ /dev/null @@ -1,4 +0,0 @@ -iOS Release fix - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.9.8+ios-app-store \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/310010000.txt b/fastlane/metadata/android/en-US/changelogs/310010000.txt deleted file mode 100644 index ab9e09d8d..000000000 --- a/fastlane/metadata/android/en-US/changelogs/310010000.txt +++ /dev/null @@ -1,15 +0,0 @@ -[New] -- A per-project spelling dictionary, so invented words aren't flagged -- Encyclopedia and draft names accept punctuation and non-Latin letters - -[Improved] -- A failed login says why, instead of a generic error -- Translations updated for six languages - -[Fixed] -- Credential fields no longer capitalize what you type -- Spelling suggestions could stick on "Loading" -- Sync no longer fails on an unknown field - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.10.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/310020000.txt b/fastlane/metadata/android/en-US/changelogs/310020000.txt deleted file mode 100644 index bd032c596..000000000 --- a/fastlane/metadata/android/en-US/changelogs/310020000.txt +++ /dev/null @@ -1,4 +0,0 @@ -- Fix Android Wear release - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.10.1+google-play \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/311010000.txt b/fastlane/metadata/android/en-US/changelogs/311010000.txt deleted file mode 100644 index babcca355..000000000 --- a/fastlane/metadata/android/en-US/changelogs/311010000.txt +++ /dev/null @@ -1,10 +0,0 @@ -New -- Web: readers can leave kudos on published stories -Improve -- Word counts skip Markdown markers like rules and bullets -Fix -- Editor: numpad keys, keyboard input, spelling underline and cursor fixes -- Wear OS: phone pairing works in release builds - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.11.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/312010000.txt b/fastlane/metadata/android/en-US/changelogs/312010000.txt deleted file mode 100644 index 4811653ff..000000000 --- a/fastlane/metadata/android/en-US/changelogs/312010000.txt +++ /dev/null @@ -1,15 +0,0 @@ -New -- Reader Mode: read your story as prose, a chapter at a time -- Export options: chapter numbering, font, blank lines -- OLED black theme -- Turkish translation -- Text editor 3.0 - -Fixes -- Unsaved scene edits could be lost when the app closed in the background -- Restoring a backup could make the project disappear -- Discarded scenes were still saved and uploaded by sync -- PDF export cut off lines at page breaks - -Full changelog: -https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.12.0 \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/full_description.txt b/fastlane/metadata/android/en-US/full_description.txt index 6644fb336..331f7a35f 100644 --- a/fastlane/metadata/android/en-US/full_description.txt +++ b/fastlane/metadata/android/en-US/full_description.txt @@ -18,8 +18,4 @@ Your data can be synchronized between devices allowing you to work on your story Optional and Self hosted Syncing -Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. - -Wear OS companion - -Capture notes and story ideas from your wrist with the Wear OS app, then pick them up on your other devices. Dictate or type a quick note and file it under a project. Add the Capture tile to start a note or story idea in a single tap, or put the Hammer complication on your watch face to open a new note. The watch app syncs through your Hammer sync server. \ No newline at end of file +Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/images/wearScreenshots/1_projects.png b/fastlane/metadata/android/en-US/images/wearScreenshots/1_projects.png deleted file mode 100644 index f5f6f7fa7..000000000 Binary files a/fastlane/metadata/android/en-US/images/wearScreenshots/1_projects.png and /dev/null differ diff --git a/fastlane/metadata/android/en-US/images/wearScreenshots/2_new_note.png b/fastlane/metadata/android/en-US/images/wearScreenshots/2_new_note.png deleted file mode 100644 index 6e9578971..000000000 Binary files a/fastlane/metadata/android/en-US/images/wearScreenshots/2_new_note.png and /dev/null differ diff --git a/fastlane/metadata/android/en-US/images/wearScreenshots/3_story_idea.png b/fastlane/metadata/android/en-US/images/wearScreenshots/3_story_idea.png deleted file mode 100644 index 0d255277d..000000000 Binary files a/fastlane/metadata/android/en-US/images/wearScreenshots/3_story_idea.png and /dev/null differ diff --git a/fastlane/metadata/android/en-US/images/wearScreenshots/4_capture_tile.png b/fastlane/metadata/android/en-US/images/wearScreenshots/4_capture_tile.png deleted file mode 100644 index a985da4bc..000000000 Binary files a/fastlane/metadata/android/en-US/images/wearScreenshots/4_capture_tile.png and /dev/null differ diff --git a/fastlane/metadata/android/en-US/images/wearScreenshots/5_project_picker.png b/fastlane/metadata/android/en-US/images/wearScreenshots/5_project_picker.png deleted file mode 100644 index c00cee017..000000000 Binary files a/fastlane/metadata/android/en-US/images/wearScreenshots/5_project_picker.png and /dev/null differ diff --git a/fastlane/metadata/android/es-ES/full_description.txt b/fastlane/metadata/android/es-ES/full_description.txt index 344bcddc9..331f7a35f 100644 --- a/fastlane/metadata/android/es-ES/full_description.txt +++ b/fastlane/metadata/android/es-ES/full_description.txt @@ -1,6 +1,6 @@ Please join our Discord to report issues! https://discord.gg/GTmgjZcupk -Multiplataforma +Multi-platform This app is where ever you are. Your phone, tablet, desktop, laptop, this program can be installed and run, not simply a website-in-a-box, but instead using native client side technologies to provide the best experience possible. @@ -8,7 +8,7 @@ Offline first I was frustrated with most of the story writing software I was finding as they were using web technologies (aka: Web Page in a box) which always seems to run into problems while being used offline for long periods of time. Hammer is designed from the ground up to be entirely local, no internet connection required, ever. -Datos transparentes +Transparent Data Your data is yours. It's not stored in the cloud, or some opaque database. It is stored in simple, human readable files, just using files and folders to define the project structure. You can open your OSes file browser and take a look for your self. If this program went away today you would be able to easily interact with your data. @@ -18,8 +18,4 @@ Your data can be synchronized between devices allowing you to work on your story Optional and Self hosted Syncing -Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. - -Wear OS companion - -Capture notes and story ideas from your wrist with the Wear OS app, then pick them up on your other devices. Dictate or type a quick note and file it under a project. Add the Capture tile to start a note or story idea in a single tap, or put the Hammer complication on your watch face to open a new note. The watch app syncs through your Hammer sync server. \ No newline at end of file +Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. \ No newline at end of file diff --git a/fastlane/metadata/android/es-ES/short_description.txt b/fastlane/metadata/android/es-ES/short_description.txt index eff42488a..39875ab6f 100644 --- a/fastlane/metadata/android/es-ES/short_description.txt +++ b/fastlane/metadata/android/es-ES/short_description.txt @@ -1 +1 @@ -Una herramienta sencilla para crear historias. \ No newline at end of file +A simple tool for building stories. \ No newline at end of file diff --git a/fastlane/metadata/android/fr-FR/full_description.txt b/fastlane/metadata/android/fr-FR/full_description.txt index 7594d7d5d..331f7a35f 100644 --- a/fastlane/metadata/android/fr-FR/full_description.txt +++ b/fastlane/metadata/android/fr-FR/full_description.txt @@ -1,25 +1,21 @@ -Rejoignez notre serveur Discord pour signaler les bugs ! https://discord.gg/GTmgjZcupk +Please join our Discord to report issues! https://discord.gg/GTmgjZcupk -Multiplateforme +Multi-platform -Cette application est utilisable peu importe l'endroit où vous vous trouvez. Votre smartphone, tablette, ordinateur de bureau et ordinateur portable sera en mesure de pouvoir installer et utiliser ce programme, ce n'est pas une application web de poche, mais une véritable application client afin de fournir la meilleure expérience possible. +This app is where ever you are. Your phone, tablet, desktop, laptop, this program can be installed and run, not simply a website-in-a-box, but instead using native client side technologies to provide the best experience possible. -Hors ligne avant tout +Offline first -J'ai été frustré par la plupart des logiciels de rédaction d'histoire que je trouvais puisqu'ils utilisaient tous des technologies web (ex : page web déguisé en application) qui semblent toujours rencontrer des problèmes lorsqu'ils sont utilisés hors ligne trop longtemps. Hammer a été conçu dans le but d'être entièrement fonctionnel en local, sans aucune connexion internet nécessaire, pour toujours. +I was frustrated with most of the story writing software I was finding as they were using web technologies (aka: Web Page in a box) which always seems to run into problems while being used offline for long periods of time. Hammer is designed from the ground up to be entirely local, no internet connection required, ever. -Transparence des données +Transparent Data -Vos données vous appartiennent. Ils ne sont pas stockés dans le cloud, ou dans une obscure base de données. Tout est stocké dans des fichiers humainement lisibles, utilisant uniquement des fichiers et des dossiers pour définir la structure du projet. Vous pouvez donc y jeter un œil par vous-même en naviguant dans vos fichiers. Si ce programme disparaissait aujourd'hui, vous serez en mesure d'interagir facilement avec vos données. +Your data is yours. It's not stored in the cloud, or some opaque database. It is stored in simple, human readable files, just using files and folders to define the project structure. You can open your OSes file browser and take a look for your self. If this program went away today you would be able to easily interact with your data. -Synchronisation intelligente entre vos appareils +Intelligent Syncing between devices -Vos données peuvent être synchronisées entre plusieurs appareils vous permettant de poursuivre l'écriture de votre histoire là où vous le souhaitez, sans avoir la crainte qu'une édition faite sur l'un de vos appareils n'en écrase une faite sur un autre. +Your data can be synchronized between devices allowing you to work on your story from anywhere, and have no fear of a change on one device, overwriting a change on another device. -Synchronisation optionnelle et auto-hébergée +Optional and Self hosted Syncing -La synchronisation est entièrement optionnelle, vous pouvez installer le client et l'utiliser sur votre appareil sans aucune action supplémentaire, ou vous pouvez installer un serveur pour la synchronisation entre vos appareils. - -Wear OS compagnon - -Capturer des notes et des idées pour vos histoires depuis votre poignet sur l'application Wear OS, puis récupérez-les sur vos autres appareils. Dictez ou écrivez une note rapide et assignez-la à l'un de vos projets Ajoutez la tuile « Capture » pour commencer une note ou une idée d'histoire d'une simple pression, ou placez la complication « Hammer » sur votre cadran pour ouvrir une nouvelle note. L'application sur votre montre se synchronise à travers votre serveur de synchronisation Hammer. \ No newline at end of file +Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. \ No newline at end of file diff --git a/fastlane/metadata/android/fr-FR/short_description.txt b/fastlane/metadata/android/fr-FR/short_description.txt index b1e12f28d..39875ab6f 100644 --- a/fastlane/metadata/android/fr-FR/short_description.txt +++ b/fastlane/metadata/android/fr-FR/short_description.txt @@ -1 +1 @@ -Un outil pour créer des histoires. \ No newline at end of file +A simple tool for building stories. \ No newline at end of file diff --git a/fastlane/metadata/android/it-IT/full_description.txt b/fastlane/metadata/android/it-IT/full_description.txt index bb0d990f0..331f7a35f 100644 --- a/fastlane/metadata/android/it-IT/full_description.txt +++ b/fastlane/metadata/android/it-IT/full_description.txt @@ -1,25 +1,21 @@ -Unisciti al nostro Discord per segnalare eventuali problemi! https://discord.gg/GTmgjZcupk +Please join our Discord to report issues! https://discord.gg/GTmgjZcupk -Multipiattaforma +Multi-platform -Questa app ti segue ovunque tu sia. Che tu usi telefono, tablet, desktop o portatile, il programma può essere installato ed eseguito; non si tratta di una semplice "pagina web in un contenitore", bensì di un'applicazione che sfrutta tecnologie native lato client per offrire la migliore esperienza possibile. +This app is where ever you are. Your phone, tablet, desktop, laptop, this program can be installed and run, not simply a website-in-a-box, but instead using native client side technologies to provide the best experience possible. -Approccio "Offline-first" +Offline first -Ero insoddisfatto della maggior parte dei software di scrittura creativa in circolazione, poiché basati su tecnologie web (ovvero "pagine web in un contenitore") che tendevano a dare problemi durante l'uso offline prolungato. Hammer è stato progettato fin dalle fondamenta per funzionare interamente in locale: non richiede mai una connessione a Internet. +I was frustrated with most of the story writing software I was finding as they were using web technologies (aka: Web Page in a box) which always seems to run into problems while being used offline for long periods of time. Hammer is designed from the ground up to be entirely local, no internet connection required, ever. -Dati trasparenti +Transparent Data -I tuoi dati sono tuoi. Non vengono archiviati nel cloud o in database opachi. Vengono salvati in file semplici e leggibili dall'utente, utilizzando una struttura di file e cartelle per organizzare il progetto. Puoi controllare tu stesso la struttura tramite il file manager del tuo sistema operativo. Anche se il programma dovesse sparire oggi, potresti comunque accedere facilmente ai tuoi dati. +Your data is yours. It's not stored in the cloud, or some opaque database. It is stored in simple, human readable files, just using files and folders to define the project structure. You can open your OSes file browser and take a look for your self. If this program went away today you would be able to easily interact with your data. -Sincronizzazione intelligente tra dispositivi +Intelligent Syncing between devices -I dati possono essere sincronizzati tra i vari dispositivi, permettendoti di lavorare alla tua storia ovunque ti trovi, senza il timore che una modifica su un dispositivo sovrascriva quella effettuata su un altro. +Your data can be synchronized between devices allowing you to work on your story from anywhere, and have no fear of a change on one device, overwriting a change on another device. -Sincronizzazione opzionale e self-hosted +Optional and Self hosted Syncing -La sincronizzazione è del tutto facoltativa: puoi installare il client e usarlo su un singolo dispositivo, oppure installare il server per sincronizzare i dati tra più dispositivi. - -Companion per Wear OS - -Cattura appunti e idee per la storia direttamente dal polso con l'app per Wear OS, per poi riprenderli sugli altri dispositivi. Dettare o digitare una nota veloce e associarla a un progetto è semplicissimo. Aggiungi il riquadro (tile) "Capture" per avviare una nota o un'idea con un solo tocco, oppure inserisci la complicazione Hammer sul quadrante dell'orologio per aprire subito una nuova nota. L'app per smartwatch si sincronizza tramite il tuo server Hammer dedicato. \ No newline at end of file +Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. \ No newline at end of file diff --git a/fastlane/metadata/android/it-IT/short_description.txt b/fastlane/metadata/android/it-IT/short_description.txt index bc989424e..39875ab6f 100644 --- a/fastlane/metadata/android/it-IT/short_description.txt +++ b/fastlane/metadata/android/it-IT/short_description.txt @@ -1 +1 @@ -Uno strumento semplice per costruire storie. \ No newline at end of file +A simple tool for building stories. \ No newline at end of file diff --git a/fastlane/metadata/android/pt-BR/full_description.txt b/fastlane/metadata/android/pt-BR/full_description.txt index c29c65067..f3cef1b81 100644 --- a/fastlane/metadata/android/pt-BR/full_description.txt +++ b/fastlane/metadata/android/pt-BR/full_description.txt @@ -18,8 +18,4 @@ Seus dados podem ser sincronizados entre aparelhos, permitindo que você trabalh Sincronização Opcional e Auto-hospedada -Você pode instalar o cliente e usá-lo em um dispositivo, ou instalar o servidor e sincronizar seus dados com outros dispositivos. - -Wear OS companion - -Capture notes and story ideas from your wrist with the Wear OS app, then pick them up on your other devices. Dictate or type a quick note and file it under a project. Add the Capture tile to start a note or story idea in a single tap, or put the Hammer complication on your watch face to open a new note. The watch app syncs through your Hammer sync server. \ No newline at end of file +Você pode instalar o cliente e usá-lo em um dispositivo, ou instalar o servidor e sincronizar seus dados com outros dispositivos. \ No newline at end of file diff --git a/fastlane/metadata/android/tr-TR/full_description.txt b/fastlane/metadata/android/tr-TR/full_description.txt deleted file mode 100644 index e62b215b4..000000000 --- a/fastlane/metadata/android/tr-TR/full_description.txt +++ /dev/null @@ -1,25 +0,0 @@ -Sorunları bildirmek için lütfen Discord sunucumuza katılın! https://discord.gg/GTmgjZcupk - -Çoklu Platform Desteği - -Bu uygulama, siz neredeyseniz orada. Telefonunuz, tabletiniz, masaüstü bilgisayarınız, dizüstü bilgisayarınız fark etmez, bu programı yükleyebilir ve çalıştırabilirsiniz. Üstelik bu uygulama kutuya konmuş bir web sitesinden ibaret değil, size mümkün olan en iyi deneyimi sunmak için yerel, istemci taraflı teknolojiler kullanılarak tasarlandı. - -Önce Çevrimdışı - -Bulabildiğim hikâye yazma yazılımlarının çoğu canımı sıkıyordu çünkü hepsinin web teknolojilerini kullandığını (başka bir deyişle kutuya konmuş birer web sitesinden ibaret olduklarını) gördüm. Bu programlar uzun süreli çevrimdışı kullanımda her zaman sorun çıkarıyorlardı. Hammer, sıfırdan tamamen yerel olarak çalışacak, asla internet bağlantısı gerektirmeyecek şekilde tasarlandı. - -Şeffaf Veriler - -Verileriniz size aittir. Yazdıklarınız bulutta veya göremediğiniz bir veri tabanında saklanmaz. Veriler basit, insanlar tarafından kolayca okunabilecek ve sadece proje yapısını tanımlamak için kullanılan dosya ve klasörler kullanılarak saklanır. İşletim sisteminizin dosya yöneticisini açarak dosyalarınızı bizzat görebilirsiniz. Bu program bugün yok olsa bile verilerinizle kolaylıkla etkileşime girmeye devam edebilirsiniz. - -Cihazlarınız arasında Akıllı Senkronizasyon - -Verileriniz cihazlar arasında senkronize edilebilir, böylece nerede olursanız olun hikâyeleriniz üzerinde çalışabilirsiniz. Cihazların birinde yaptığınız bir değişikliğin başka bir cihazda yaptığınız başka bir değişikilği silmesinden endişe etmenize gerek yoktur. - -İsteğe Bağlı, Kendi Sunucunuzda Barındırabileceğiniz Senkronizasyon - -Senkronizasyon tamamen isteğe bağlıdır. İsterseniz istemciyi tek bir cihaza kurup kullanabilir veya sunucuya yükleyip verilerinizi cihazlar arasında senkronize edebilirsiniz. - -Wear OS Yardımcınız - -Wear OS uygulamasıyla notlarınızı ve hikâye fikirlerinizi kaydedin, ardından bunlara diğer cihazlarınızdan erişin. İster klavyenizi ister sesle yazma özelliğini kullanarak hızlıca bir not alın ve bir projeye ekleyin. Yakala kartını ekleyerek tek dokunuşla bir not veya hikâye fikri başlatabilir, Hammer komplikasyonunu saat yüzünüze yerleştirerek yeni bir not açmak için kullanabilirsiniz. Saat uygulaması, verileri Hammer senkronizasyon sunucunuz üzerinden senkronize eder. \ No newline at end of file diff --git a/fastlane/metadata/android/tr-TR/short_description.txt b/fastlane/metadata/android/tr-TR/short_description.txt deleted file mode 100644 index b943c1e3f..000000000 --- a/fastlane/metadata/android/tr-TR/short_description.txt +++ /dev/null @@ -1 +0,0 @@ -Yazacağınız hikâyeler için basit bir araç. \ No newline at end of file diff --git a/fastlane/metadata/android/tr-TR/title.txt b/fastlane/metadata/android/tr-TR/title.txt deleted file mode 100644 index 4690fe86c..000000000 --- a/fastlane/metadata/android/tr-TR/title.txt +++ /dev/null @@ -1 +0,0 @@ -Hammer \ No newline at end of file diff --git a/fastlane/metadata/android/uk/full_description.txt b/fastlane/metadata/android/uk/full_description.txt index 99ec483b0..331f7a35f 100644 --- a/fastlane/metadata/android/uk/full_description.txt +++ b/fastlane/metadata/android/uk/full_description.txt @@ -1,6 +1,6 @@ Please join our Discord to report issues! https://discord.gg/GTmgjZcupk -Багатоплатформність +Multi-platform This app is where ever you are. Your phone, tablet, desktop, laptop, this program can be installed and run, not simply a website-in-a-box, but instead using native client side technologies to provide the best experience possible. @@ -8,7 +8,7 @@ Offline first I was frustrated with most of the story writing software I was finding as they were using web technologies (aka: Web Page in a box) which always seems to run into problems while being used offline for long periods of time. Hammer is designed from the ground up to be entirely local, no internet connection required, ever. -Прозорі дані +Transparent Data Your data is yours. It's not stored in the cloud, or some opaque database. It is stored in simple, human readable files, just using files and folders to define the project structure. You can open your OSes file browser and take a look for your self. If this program went away today you would be able to easily interact with your data. @@ -18,8 +18,4 @@ Your data can be synchronized between devices allowing you to work on your story Optional and Self hosted Syncing -Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. - -Wear OS companion - -Capture notes and story ideas from your wrist with the Wear OS app, then pick them up on your other devices. Dictate or type a quick note and file it under a project. Add the Capture tile to start a note or story idea in a single tap, or put the Hammer complication on your watch face to open a new note. The watch app syncs through your Hammer sync server. \ No newline at end of file +Syncing is entirely optional, you can install the client and use it on one device, or you can install the server and sync your data between devices. \ No newline at end of file diff --git a/fastlane/metadata/android/uk/short_description.txt b/fastlane/metadata/android/uk/short_description.txt index 861f56616..39875ab6f 100644 --- a/fastlane/metadata/android/uk/short_description.txt +++ b/fastlane/metadata/android/uk/short_description.txt @@ -1 +1 @@ -Простий інструмент для створення історій. \ No newline at end of file +A simple tool for building stories. \ No newline at end of file diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_00.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_00.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_00.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_00.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_01.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_01.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_01.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_01.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_02.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_02.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_02.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_02.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_03.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_03.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_03.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_03.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_04.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_04.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_04.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_04.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_05.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_05.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_05.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_05.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_06.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_06.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_06.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_06.png diff --git a/fastlane/screenshots/ios/en-US/ipad_pro_3gen_07.png b/fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_07.png similarity index 100% rename from fastlane/screenshots/ios/en-US/ipad_pro_3gen_07.png rename to fastlane/metadata/ios/en-US/APP_IPAD_PRO_3GEN_129/ss_07.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_00.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_00.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_00.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_00.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_01.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_01.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_01.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_01.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_02.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_02.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_02.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_02.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_03.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_03.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_03.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_03.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_04.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_04.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_04.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_04.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_05.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_05.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_05.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_05.png diff --git a/fastlane/screenshots/ios/en-US/iphone_65_06.png b/fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_06.png similarity index 100% rename from fastlane/screenshots/ios/en-US/iphone_65_06.png rename to fastlane/metadata/ios/en-US/APP_IPHONE_65/ss_06.png diff --git a/fastlane/metadata/ios/en-US/name.txt b/fastlane/metadata/ios/en-US/name.txt index 3305b8911..c056464f1 100644 --- a/fastlane/metadata/ios/en-US/name.txt +++ b/fastlane/metadata/ios/en-US/name.txt @@ -1 +1 @@ -Hammer Editor +Hammer-Editor diff --git a/fastlane/metadata/ios/en-US/release_notes.txt b/fastlane/metadata/ios/en-US/release_notes.txt index 16b50bd25..5dcbeb3d0 100644 --- a/fastlane/metadata/ios/en-US/release_notes.txt +++ b/fastlane/metadata/ios/en-US/release_notes.txt @@ -1,13 +1,6 @@ -New -- Reader Mode: read your story as prose, a chapter at a time -- Export options: chapter numbering, font, blank lines -- OLED black theme -- Turkish translation -- Text editor 3.0: Huge improvements in input and performance +[Improve] +- Translations updated for German, Spanish, French, Italian, +Portuguese (Brazil), and Ukrainian -Fixes -- Unsaved scene edits could be lost when the app closed in the background -- Restoring a backup could make the project disappear -- Discarded scenes were still saved and uploaded by sync -- PDF export cut off lines at page breaks -- Crash on launch when the saved login could not be read \ No newline at end of file +Full changelog: +https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.7.2 \ No newline at end of file diff --git a/fastlane/metadata/osx/en-US/release_notes.txt b/fastlane/metadata/osx/en-US/release_notes.txt index 16b50bd25..5dcbeb3d0 100644 --- a/fastlane/metadata/osx/en-US/release_notes.txt +++ b/fastlane/metadata/osx/en-US/release_notes.txt @@ -1,13 +1,6 @@ -New -- Reader Mode: read your story as prose, a chapter at a time -- Export options: chapter numbering, font, blank lines -- OLED black theme -- Turkish translation -- Text editor 3.0: Huge improvements in input and performance +[Improve] +- Translations updated for German, Spanish, French, Italian, +Portuguese (Brazil), and Ukrainian -Fixes -- Unsaved scene edits could be lost when the app closed in the background -- Restoring a backup could make the project disappear -- Discarded scenes were still saved and uploaded by sync -- PDF export cut off lines at page breaks -- Crash on launch when the saved login could not be read \ No newline at end of file +Full changelog: +https://github.com/Darkrock-Studios/hammer-editor/releases/tag/v3.7.2 \ No newline at end of file diff --git a/flatpak/studio.darkrock.hammer.metainfo.xml b/flatpak/studio.darkrock.hammer.metainfo.xml index 7fd210d07..3b318b5f0 100644 --- a/flatpak/studio.darkrock.hammer.metainfo.xml +++ b/flatpak/studio.darkrock.hammer.metainfo.xml @@ -32,159 +32,6 @@ - - -

New features

-

- Reader Mode: read your story as prose, one chapter at a time, instead of through the scene editor. Open it from the Read button under the scene list, the book icon in the scene editor, or the editor menu. The scene list becomes a table of contents, and the reader has its own font size

-

- Export: three new options in the Export Story dialog. Number chapter titles, pick a font (Word, RTF and EPUB), and choose whether to keep blank lines between paragraphs

-

- Android and iOS: an OLED theme, the dark theme on a pure black background

-

- Desktop (Windows and Linux installs from GitHub): Hammer tells you when a newer release is out and can update itself from the project list or the About screen. macOS DMG installs are told and sent to the release page. Automatic checks can be turned off in Settings

-

- Text editor 3.0: Huge improvements in input and performance

-

- Text editor: change the text size with Ctrl/Cmd and Plus, Minus or 0, or from the format bar's overflow menu

-

- Text editor: Delete in the right-click menu

-

- Turkish translation

-

- Syncing with unsaved work now asks Save, Discard or Cancel first, where before it silently saved every unsaved scene

-

- Open notes, timeline events, encyclopedia entries and the scene title, outline and notes refresh when a sync or conflict resolution changes them. An edit in progress keeps its draft

-

- The Backup Manager lists backups of projects that are no longer on disk, so a deleted project can be restored

-

- Exports no longer number chapter titles unless you turn the new option on. Word, RTF, PDF and Markdown used to number them always

-

- Text editor: the heading button writes real Markdown headings, and Hammer's shortcuts land on the same keys on non-QWERTY layouts

-

- Android: a launch splash screen on every supported version

-

- Translations and dependencies updated

-

Fixes

-

- Android: unsaved scene edits could be lost when the app was closed in the background. They now come back as unsaved scenes the next time the project opens [#983]

-

- Export: unsaved scene edits were left out of the exported file [#983]

-

- Restoring a backup from the Backup Manager made the project disappear from the project list

-

- Choosing Discard on close with automatic sync on still saved and uploaded the discarded scenes

-

- PDF export: long paragraphs ran off the bottom of the page or left large blank gaps

-

- Android: a crash on launch when the saved login could not be decrypted, for example after restoring the device from a backup. You are asked to sign in again

-

- iOS: a crash when tapping into a text editor

-

- Server URL, number, tag and word-list fields no longer autocorrect or capitalize, which put a space after each "." in a server URL

-

- Encyclopedia references no longer match a name inside a longer word with accented or non-Latin letters ("Ana" in "Anaïs")

-
-
- - -

New features

-

- Word counts no longer count standalone Markdown markers such as horizontal rules, heading marks, bullets and blockquote markers as words. The server now counts the same way, so both give the same number

-

- Android and Wear OS builds are now shrunk and obfuscated with R8

-

- Translations and dependencies updated

-

Fixes

-

- Text editor: numpad navigation keys and numpad Enter now work

-

- Text editor: keyboard (IME) edits are applied right away, and the keyboard is told about each one only once

-

- Text editor: spelling underlines stay on the right words while you keep typing

-

- Text editor: the formatting you picked for new text is kept after unrelated updates

-

- Text editor: fixed crashes and misplaced carets when drawing the cursor or moving it during a layout change

-
-
- - -

[New]

-

- A per-project spelling dictionary, so invented words aren't flagged

-

- Encyclopedia and draft names accept punctuation and non-Latin letters

-

[Improved]

-

- A failed login says why, instead of a generic error

-

- Translations updated for six languages

-

[Fixed]

-

- Credential fields no longer capitalize what you type

-

- Spelling suggestions could stick on "Loading"

-

- Sync no longer fails on an unknown field

-
-
- - -

iOS Release fix

-
-
- - -

iOS Release fix

-
-
- - -

Release fix

-
-
- - -

Release fix

-
-
- - -

Fix widgets not doing anything

-
-
- - -

Bug fixes

-
-
- - -

Bug fixes and performance improvements

-
-
- - -

- Fix sharing scene order

-

- Fix PDF export crash

-
-
- - -

New

-

- Export just the scenes you pick, in any format

-

- Encyclopedia names feed spell check, so invented names aren't flagged

-

- Scenes connect to every kind of Encyclopedia entry

-

- Drag the editor's edge to set its width

-

Improved

-

- Exports lay prose out exactly as you wrote it

-

- Scenes accept typing right away

-

- Clearer scene tree nesting

-

Fixed

-

- Folders with exactly ten items could show blank scenes

-

- Signing in no longer risks deleting local projects

-

- Unsaved edits survive rotation

-
-
- - -

- About: Dark Rock Studios attribution screen improved, check it out!

-

- Translations updated for German, Spanish, French, Italian, Portuguese (Brazil), and Ukrainian

-

Fixes

-
-
- - -

Improvements

-

- text editor no longer drops block structure (horizontal rules, images, code fences) when a scene loads

-

- font size changes no longer flatten list and blockquote indents

-

- typed text after a size change could lose the paragraph's body style

-

- F3 and Ctrl+Alt+S sync shortcuts work from anywhere in the project window

-

- tag suggestion chips could add the typed prefix instead of the selected tag

-

- Sync: projects with a stale cached server id could get stuck failing "410 Gone" instead of recreating

-
-
- - -

https://hammer.ink/blog/news/hammer-3-8-0

-

New:

-

- Set the language a project is written in, and have spell check follow it

-

- Text editor: faster typing and relayout, word-wise undo with a much deeper history, and rich copy and paste that preserves formatting between apps

-

- Large Markdown imports are dramatically faster

-

- Search matches the rendered prose, resolving Markdown escapes and formatting

-

- Tag search matches accented and non-latin characters, and searches entry names as well as bodies

-

- Chapter detection on Markdown import understands Setext-style and bold titles

-

- Visible scrollbars on scrolling screens, and scroll-away footers float over their lists

-

Fixes:

-

- importing a very large story no longer freezes the app

-

- scene drag could grab the wrong row

-

- literal `**` and `_` left around emphasis imported from RTF

-

- a number of text editor crashes around undo, paste, and joined paragraphs

-

- Scene drag and drop stays accurate while the list autoscrolls

-
-

[Improve]

diff --git a/flatpak/studio.darkrock.hammer.yaml b/flatpak/studio.darkrock.hammer.yaml index 0aadb0eef..82c994dfd 100644 --- a/flatpak/studio.darkrock.hammer.yaml +++ b/flatpak/studio.darkrock.hammer.yaml @@ -24,15 +24,15 @@ modules: build-args: - --share=network build-commands: - # Extract the JDK, setup environment, and build with Gradle + # Extract JBR, setup environment, and build with Gradle # All in one command block so environment variables persist - | - tar -xzf jdk.tar.gz - export JAVA_HOME=$PWD/jdk-21.0.12+8 + tar -xzf jbr.tar.gz + export JAVA_HOME=$PWD/jbrsdk_jcef-21.0.9-linux-x64-b1163.86 export PATH=$JAVA_HOME/bin:$PATH java -version chmod +x gradlew - ./gradlew :desktop:createDistributable -Pchannel=flathub -Pformat=flatpak -x test --no-daemon + ./gradlew :desktop:createDistributable -x test --no-daemon # Install the app (outputBaseDir is set to 'installers' in build.gradle.kts) - mkdir -p /app/lib/hammer - cp -r desktop/build/installers/main/app/hammer/* /app/lib/hammer/ @@ -54,6 +54,6 @@ modules: - type: dir path: .. - type: file - url: https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.12%2B8/OpenJDK21U-jdk_x64_linux_hotspot_21.0.12_8.tar.gz - sha256: e4446ff06a276155697597cc0f1b15da004ff083f4964a35271ecee567177370 - dest-filename: jdk.tar.gz + url: https://cache-redirector.jetbrains.com/intellij-jbr/jbrsdk_jcef-21.0.9-linux-x64-b1163.86.tar.gz + sha256: 81d780fbea669d67a40a65a678ad0710d224c31439472d2d8933109c95cacf57 + dest-filename: jbr.tar.gz diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 767a363af..604f6e2eb 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,17 +1,17 @@ [versions] # App Versions -app = "3.12.0" +app = "3.7.2" data_version = "1.0" # Kotlin flatlaf = "3.7.2" jvm = "21" kache = "2.1.1" -kotlin = "2.4.20" +kotlin = "2.4.10" serialization = "1.11.0" # Android -android_gradle_plugin = "9.4.1" +android_gradle_plugin = "9.1.1" android_sdk_compile = "37" android_sdk_target = "37" android_sdk_min = "28" @@ -21,99 +21,92 @@ activity-compose = "1.13.0" androidx-runner = "1.7.0" androidx-datastore = "1.2.1" androidx-window = "1.5.1" -appcompat = "1.8.0" +appcompat = "1.7.1" appdirs = "1.5.0" cache4k = "0.14.0" core = "1.7.0" -coreKtx = "1.19.1" +coreKtx = "1.19.0" cryptohash = "1.0.2" androidx-security-crypto = "1.1.0" -glance = "1.2.0" +glance = "1.2.0-rc01" androix-junit = "1.3.0" -junit = "6.1.3" +junit = "6.1.2" asm = "9.10.1" clikt = "5.1.0" kotlinx_atomicfu = "0.33.0" -kotlinx_collections_immutable = "0.5.2" -markdown = "0.7.16" +kotlinx_collections_immutable = "0.5.1" +markdown = "0.7.7" rtfParserKmp = "0.2.2" epub4kmp = "0.3.0" -pdfkmp = "1.3.0" -xmlutil = "1.0.2.1" +pdfkmp = "1.2.0" +xmlutil = "1.0.1" poi = "5.5.1" kotlinx_html = "0.12.0" material = "1.14.0" orchestrator = "1.6.1" cryptography = "0.6.0" -kmpZip = "1.0.0" +kmpZip = "0.12.2" coroutines = "1.11.0" datetime = "0.8.0" napier = "2.7.1" -jetbrains_compose = "1.12.1" +jetbrains_compose = "1.11.1" compose_compiler_report_generator = "1.5.0" -jetbrains_kover = "0.9.11" +jetbrains_kover = "0.9.9" moko_permissions = "0.20.1" decompose = "3.5.0" essenty = "2.5.0" # This should match whatever decompose is referncing internally -filekit = "0.16.0" +filekit = "0.14.2" koalaplot-core = "0.11.2" -coil = "3.6.3" +coil = "3.5.0" kmpalette = "3.1.0" koin_bom = "4.2.2" -koin_plugin = "1.2.1" +koin_plugin = "1.0.2" -ktor = "3.6.0" -ktor_plugin = "3.6.0" +ktor = "3.5.1" +ktor_plugin = "3.5.1" ktor_i18n = "2.0.0" -okio = "3.18.2" -slf4jSimple = "2.0.20" +okio = "3.17.0" +slf4jSimple = "2.0.18" +splashify = "1.0.0-alpha1" turbine = "1.2.1" -work-runtime-ktx = "2.12.0" -wear_compose = "1.7.0" -wear_input = "1.2.0" -wear_tiles = "1.6.2" -wear_protolayout = "1.4.2" -wear_complications = "1.3.0" -concurrent_futures = "1.3.0" -play_services_wearable = "20.0.1" -lifecycle_process = "2.11.0" -core_splashscreen = "1.2.0" +work-runtime-ktx = "2.11.2" +multiplatform_window_size = "0.5.0" mockk = "1.14.11" tomlkt = "0.5.0" krypto = "4.0.10" -owasp_html_sanitizer = "20260924.2" +argon2_jvm = "2.12" +owasp_html_sanitizer = "20260313.1" -sqldelight = "2.4.0" +sqldelight = "2.3.2" postgresql_jdbc = "42.7.13" hikaricp = "7.1.0" embedded_postgres = "2.2.2" -embedded_postgres_binaries = "18.6.0" +embedded_postgres_binaries = "18.4.0" testcontainers = "2.0.5" -buildconfig = "6.1.2" +buildconfig = "6.0.10" resources = "1.1.0" -aboutlibraries = "15.2.0" -logback_classic = "1.6.5" +aboutlibraries = "15.0.4" +logback_classic = "1.5.38" multiplatform_settings = "1.3.0" korge-core = "6.0.0" -bouncycastle = "1.86" +bouncycastle = "1.85" kotlinx-io-okio = "0.9.1" -compose-texteditor = "3.1.0" -kotlin-multiplatform-diff = "1.4.0" -platform-spellcheckerkt = "1.4.0" -nucleus = "2.5.18" -colorpicker-compose = "1.3.0" -material-kolor = "5.0.1" -cairn = "0.4.0" +compose-texteditor = "2.3.1" +kotlin-multiplatform-diff = "1.3.0" +platform-spellcheckerkt = "1.3.1" +nucleus = "1.15.7" +colorpicker-compose = "1.2.0" +material-kolor = "5.0.0" [libraries] activity-compose = { module = "androidx.activity:activity-compose", version.ref = "activity-compose" } @@ -121,7 +114,6 @@ androidx-core-ktx = { module = "androidx.core:core-ktx", version.ref = "coreKtx" appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" } appdirs = { module = "net.harawata:appdirs", version.ref = "appdirs" } cache4k = { module = "io.github.reactivecircus.cache4k:cache4k", version.ref = "cache4k" } -cairn = { module = "com.darkrockstudios:cairn", version.ref = "cairn" } core = { module = "androidx.test:core", version.ref = "core" } core-ktx = { module = "androidx.test:core-ktx", version.ref = "core" } cryptohash = { module = "com.appmattus.crypto:cryptohash", version.ref = "cryptohash" } @@ -195,6 +187,7 @@ xmlutil_core = { module = "io.github.pdvrieze.xmlutil:core", version.ref = "xmlu poi_ooxml = { module = "org.apache.poi:poi-ooxml", version.ref = "poi" } pdfkmp = { module = "io.github.conamobiledev:pdfkmp", version.ref = "pdfkmp" } kotlinx_html = { module = "org.jetbrains.kotlinx:kotlinx-html", version.ref = "kotlinx_html" } +multiplatform_window_size = { group = "dev.chrisbanes.material3", name = "material3-window-size-class-multiplatform", version.ref = "multiplatform_window_size" } material = { module = "com.google.android.material:material", version.ref = "material" } filekit_dialogs_compose = { module = "io.github.vinceglb:filekit-dialogs-compose", version.ref = "filekit" } napier = { group = "io.github.aakira", name = "napier", version.ref = "napier" } @@ -235,6 +228,7 @@ koin_sl4j = { group = "io.insert-koin", name = "koin-logger-slf4j" } koin_ktor = { group = "io.insert-koin", name = "koin-ktor" } koin_compose = { group = "io.insert-koin", name = "koin-compose" } +splashify = { module = "io.github.sudarshanmhasrup.splashify:splashify", version.ref = "splashify" } tomlkt = { group = "net.peanuuutz.tomlkt", name = "tomlkt", version.ref = "tomlkt" } ktor_client_core = { group = "io.ktor", name = "ktor-client-core", version.ref = "ktor" } @@ -268,7 +262,6 @@ ktor_server_mustache = { group = "io.ktor", name = "ktor-server-mustache", versi ktor_server_html_builder = { group = "io.ktor", name = "ktor-server-html-builder", version.ref = "ktor" } ktor_server_status_pages = { group = "io.ktor", name = "ktor-server-status-pages", version.ref = "ktor" } ktor_server_hsts = { group = "io.ktor", name = "ktor-server-hsts", version.ref = "ktor" } -ktor_server_forwarded_header = { group = "io.ktor", name = "ktor-server-forwarded-header", version.ref = "ktor" } # HTMX for Ktor ktor_htmx = { group = "io.ktor", name = "ktor-htmx", version.ref = "ktor" } @@ -286,26 +279,11 @@ okio_fakefilesystem = { group = "com.squareup.okio", name = "okio-fakefilesystem slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4jSimple" } turbine = { module = "app.cash.turbine:turbine", version.ref = "turbine" } work-runtime-ktx = { module = "androidx.work:work-runtime-ktx", version.ref = "work-runtime-ktx" } -wear_compose_material3 = { module = "androidx.wear.compose:compose-material3", version.ref = "wear_compose" } -wear_compose_foundation = { module = "androidx.wear.compose:compose-foundation", version.ref = "wear_compose" } -wear_compose_ui_tooling = { module = "androidx.wear.compose:compose-ui-tooling", version.ref = "wear_compose" } -wear_input = { module = "androidx.wear:wear-input", version.ref = "wear_input" } -wear_tiles = { module = "androidx.wear.tiles:tiles", version.ref = "wear_tiles" } -wear_tiles_tooling = { module = "androidx.wear.tiles:tiles-tooling", version.ref = "wear_tiles" } -wear_tiles_tooling_preview = { module = "androidx.wear.tiles:tiles-tooling-preview", version.ref = "wear_tiles" } -wear_protolayout = { module = "androidx.wear.protolayout:protolayout", version.ref = "wear_protolayout" } -wear_protolayout_material3 = { module = "androidx.wear.protolayout:protolayout-material3", version.ref = "wear_protolayout" } -wear_protolayout_expression = { module = "androidx.wear.protolayout:protolayout-expression", version.ref = "wear_protolayout" } -wear_complications_datasource = { module = "androidx.wear.watchface:watchface-complications-data-source-ktx", version.ref = "wear_complications" } -concurrent_futures = { module = "androidx.concurrent:concurrent-futures-ktx", version.ref = "concurrent_futures" } -play_services_wearable = { module = "com.google.android.gms:play-services-wearable", version.ref = "play_services_wearable" } -core_splashscreen = { module = "androidx.core:core-splashscreen", version.ref = "core_splashscreen" } -coroutines_play_services = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-play-services", version.ref = "coroutines" } -lifecycle_process = { module = "androidx.lifecycle:lifecycle-process", version.ref = "lifecycle_process" } korlibs_krypto = { group = "com.soywiz.korlibs.krypto", name = "krypto", version.ref = "krypto" } korlibs_korio = { group = "com.soywiz.korlibs.korio", name = "korio", version.ref = "krypto" } +argon2_jvm = { group = "de.mkammerer", name = "argon2-jvm", version.ref = "argon2_jvm" } owasp-html-sanitizer = { group = "com.googlecode.owasp-java-html-sanitizer", name = "owasp-java-html-sanitizer", version.ref = "owasp_html_sanitizer" } sqldelight_driver = { group = "app.cash.sqldelight", name = "sqlite-driver", version.ref = "sqldelight" } @@ -344,23 +322,19 @@ moko-permissions-storage = { group = "dev.icerock.moko", name = "permissions-sto moko-permissions-compose = { group = "dev.icerock.moko", name = "permissions-compose", version.ref = "moko_permissions" } compose-texteditor = { group = "com.darkrockstudios", name = "composetexteditor", version.ref = "compose-texteditor" } -compose-texteditor-markdown = { group = "com.darkrockstudios", name = "composetexteditor-markdown", version.ref = "compose-texteditor" } compose-texteditor-find = { group = "com.darkrockstudios", name = "composetexteditor-find", version.ref = "compose-texteditor" } compose-texteditor-spellcheck = { group = "com.darkrockstudios", name = "composetexteditor-spellcheck", version.ref = "compose-texteditor" } platform-spellcheckerkt = { module = "com.darkrockstudios:platform-spellcheckerkt", version.ref = "platform-spellcheckerkt" } bouncycastle-bcpkix = { group = "org.bouncycastle", name = "bcpkix-jdk18on", version.ref = "bouncycastle" } -bouncycastle-bcprov = { group = "org.bouncycastle", name = "bcprov-jdk18on", version.ref = "bouncycastle" } -nucleus_darkmode_detector = { module = "dev.nucleusframework:nucleus.darkmode-detector", version.ref = "nucleus" } -nucleus_application = { module = "dev.nucleusframework:nucleus.nucleus-application", version.ref = "nucleus" } -nucleus_decorated_window_tao = { module = "dev.nucleusframework:nucleus.decorated-window-tao", version.ref = "nucleus" } -nucleus_decorated_window_material3 = { module = "dev.nucleusframework:nucleus.decorated-window-material3", version.ref = "nucleus" } -nucleus_launcher_windows = { module = "dev.nucleusframework:nucleus.launcher-windows", version.ref = "nucleus" } -nucleus_launcher_linux = { module = "dev.nucleusframework:nucleus.launcher-linux", version.ref = "nucleus" } -nucleus_launcher_macos = { module = "dev.nucleusframework:nucleus.launcher-macos", version.ref = "nucleus" } -nucleus_updater_runtime = { module = "dev.nucleusframework:nucleus.updater-runtime", version.ref = "nucleus" } +nucleus_darkmode_detector = { module = "io.github.kdroidfilter:nucleus.darkmode-detector", version.ref = "nucleus" } +nucleus_decorated_window_jbr = { module = "io.github.kdroidfilter:nucleus.decorated-window-jbr", version.ref = "nucleus" } +nucleus_decorated_window_material3 = { module = "io.github.kdroidfilter:nucleus.decorated-window-material3", version.ref = "nucleus" } +nucleus_launcher_windows = { module = "io.github.kdroidfilter:nucleus.launcher-windows", version.ref = "nucleus" } +nucleus_launcher_linux = { module = "io.github.kdroidfilter:nucleus.launcher-linux", version.ref = "nucleus" } +nucleus_launcher_macos = { module = "io.github.kdroidfilter:nucleus.launcher-macos", version.ref = "nucleus" } [plugins] kotlin_multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" } diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index e95e47fb7..ff31567bb 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.1-bin.zip networkTimeout=30000 retries=3 retryBackOffMs=1000 diff --git a/integrationTests/build.gradle.kts b/integrationTests/build.gradle.kts index fded92d52..70b5ee418 100644 --- a/integrationTests/build.gradle.kts +++ b/integrationTests/build.gradle.kts @@ -39,6 +39,7 @@ kotlin { implementation("org.jetbrains.compose.components:components-resources:${libs.versions.jetbrains.compose.get()}") implementation(libs.okio) implementation(libs.ktor.client.java) + implementation(libs.kotlinx.datetime) implementation(libs.serialization.json) implementation(project.dependencies.platform(libs.koin.bom)) diff --git a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/HeadlessClient.kt b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/HeadlessClient.kt index af07064da..ce9d40b5f 100644 --- a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/HeadlessClient.kt +++ b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/HeadlessClient.kt @@ -82,12 +82,7 @@ class HeadlessClient private constructor( val projectsRepository: ProjectsRepository = koin.get() val globalSettings: GlobalSettingsStore = koin.get() - // A second device opening an existing server project must keep the never-synced - // ProjectData baseline; only a genuinely new project gets the language seed. - val createResult = projectsRepository.createProject( - projectName, - seedDefaultLanguage = serverProjectId == null, - ) + val createResult = projectsRepository.createProject(projectName) check(isSuccess(createResult)) { "Failed to create local project: $createResult" } val projectDef: ProjectDef = createResult.data diff --git a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/RoundTripTestBase.kt b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/RoundTripTestBase.kt index 2a94c7b4c..dc60bc6cf 100644 --- a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/RoundTripTestBase.kt +++ b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/RoundTripTestBase.kt @@ -40,7 +40,6 @@ import org.koin.core.module.Module import org.koin.core.qualifier.named import org.koin.dsl.module import org.koin.test.KoinTest -import kotlin.time.Clock import org.koin.test.get import java.util.concurrent.Executors import kotlin.coroutines.CoroutineContext @@ -89,14 +88,16 @@ abstract class RoundTripTestBase : EndToEndTest(), KoinTest { projectsRoot = "/client/projects".toPath() fileSystem.createDirectories(projectsRoot) + // Match the existing e2e tests' fixture: whitelist disabled, so any + // authenticated user can sync (instead of being rejected with 401). + database().execute( + "INSERT INTO server_config VALUES ('whitelist_enabled', 'false', to_timestamp(1704067200));" + ) + doStartServer() account = TestAccount(email = "test@test.com", password = "password123!@#") E2eTestData.createAccount(account, database()) - // The allowed users list is always enforced; the synced account must be on it - // or every bearer request is rejected with 401. - database().serverDatabase.whiteListQueries - .addToWhiteList(account.email, Clock.System.now(), "Round-trip test", null) authToken = E2eTestData.createAuthToken( userId = userId, installId = installId, diff --git a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/EntityTypeResyncMatrixTest.kt b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/EntityTypeResyncMatrixTest.kt index 6586e6f42..b84b0744b 100644 --- a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/EntityTypeResyncMatrixTest.kt +++ b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/EntityTypeResyncMatrixTest.kt @@ -86,7 +86,6 @@ class EntityTypeResyncMatrixTest : RoundTripTestBase() { name = "Hero", text = "a very brave hero", tags = setOf("hero", "legend"), - excludeFromDictionary = false, ) assertTrue(client.syncNoConflict(), "resync should succeed") assertNotEquals(before, serverEntityHash(project, container.entry.id), "edit must reach the server") diff --git a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/MixedSyncFuzzTest.kt b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/MixedSyncFuzzTest.kt index 9b67f313f..9103e06cf 100644 --- a/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/MixedSyncFuzzTest.kt +++ b/integrationTests/src/jvmTest/kotlin/com/darkrockstudios/apps/hammer/integration/scenarios/MixedSyncFuzzTest.kt @@ -95,13 +95,7 @@ class MixedSyncFuzzTest : RoundTripTestBase() { eventState[id] = updated } 9 -> entries.randomOrNull(rng)?.let { id -> - encyclopedia.updateEntry( - encyclopedia.getEntryDef(id), - "Entry $i", - "about edit $i", - randomTags(rng), - excludeFromDictionary = false, - ) + encyclopedia.updateEntry(encyclopedia.getEntryDef(id), "Entry $i", "about edit $i", randomTags(rng)) } 10 -> scenes.randomOrNull(rng)?.let { id -> diff --git a/ios/ios.xcodeproj/project.pbxproj b/ios/ios.xcodeproj/project.pbxproj index 843029ae5..a5ff45f8d 100644 --- a/ios/ios.xcodeproj/project.pbxproj +++ b/ios/ios.xcodeproj/project.pbxproj @@ -281,7 +281,7 @@ ); runOnlyForDeploymentPostprocessing = 0; shellPath = /bin/sh; - shellScript = "cd \"$SRCROOT/..\"\n# Only a Release build is the one that reaches the App Store; a local Debug build stays 'dev'.\nif [ \"$CONFIGURATION\" = \"Release\" ]; then\n CHANNEL_ARG=-Pchannel=ios-app-store\nelse\n CHANNEL_ARG=\nfi\n./gradlew :composeUi:embedAndSignAppleFrameworkForXcode $CHANNEL_ARG\n"; + shellScript = "cd \"$SRCROOT/..\"\n./gradlew :composeUi:embedAndSignAppleFrameworkForXcode\n"; }; /* End PBXShellScriptBuildPhase section */ @@ -492,7 +492,7 @@ "-framework", Hammer, ); - PRODUCT_BUNDLE_IDENTIFIER = com.darkrockstudios.apps.hammer; + PRODUCT_BUNDLE_IDENTIFIER = com.darkrockstudios.apps.hammer.ios; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; "PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "Hammer AppStore iOS"; @@ -525,7 +525,7 @@ "-framework", Hammer, ); - PRODUCT_BUNDLE_IDENTIFIER = com.darkrockstudios.apps.hammer; + PRODUCT_BUNDLE_IDENTIFIER = com.darkrockstudios.apps.hammer.ios; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; "PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "Hammer AppStore iOS"; diff --git a/ios/ios/ComposeContainer.swift b/ios/ios/ComposeContainer.swift index 3abc4ccc8..72a13352d 100644 --- a/ios/ios/ComposeContainer.swift +++ b/ios/ios/ComposeContainer.swift @@ -13,64 +13,9 @@ struct ComposeContainer: UIViewControllerRepresentable { let root: IosRoot func makeUIViewController(context: Context) -> UIViewController { - let shortcutHost = ProjectShortcutHost() - let compose = MainViewControllerKt.MainViewController(root: root, shortcutHost: shortcutHost) - return ShortcutHostController(shortcutHost: shortcutHost, content: compose) + MainViewControllerKt.MainViewController(root: root) } func updateUIViewController(_ uiViewController: UIViewController, context: Context) { } } - -/// Compose routes key events along the focus path, so a screen with nothing focused never sees -/// them. UIKit key commands travel the responder chain instead and always reach this controller. -final class ShortcutHostController: UIViewController { - - /// UIKit reports function keys as these private-use characters (NSF3FunctionKey). - private static let f3Input = String(UnicodeScalar(0xF706)!) - - private let shortcutHost: ProjectShortcutHost - private let content: UIViewController - - init(shortcutHost: ProjectShortcutHost, content: UIViewController) { - self.shortcutHost = shortcutHost - self.content = content - super.init(nibName: nil, bundle: nil) - } - - required init?(coder: NSCoder) { - fatalError("init(coder:) is not used") - } - - override func viewDidLoad() { - super.viewDidLoad() - - addChild(content) - content.view.frame = view.bounds - content.view.autoresizingMask = [.flexibleWidth, .flexibleHeight] - view.addSubview(content.view) - content.didMove(toParent: self) - } - - override var childForStatusBarStyle: UIViewController? { content } - - override var childForStatusBarHidden: UIViewController? { content } - - override var canBecomeFirstResponder: Bool { true } - - override var keyCommands: [UIKeyCommand]? { - [ - UIKeyCommand(input: Self.f3Input, modifierFlags: [], action: #selector(startSync)), - UIKeyCommand(input: "s", modifierFlags: [.command, .shift], action: #selector(saveAll)), - UIKeyCommand(input: "s", modifierFlags: [.control, .shift], action: #selector(saveAll)), - ] - } - - @objc private func startSync() { - _ = shortcutHost.startProjectSync() - } - - @objc private func saveAll() { - _ = shortcutHost.saveAllBuffers() - } -} diff --git a/ios/ios/Info.plist b/ios/ios/Info.plist index e9cdd6ff1..d936c1f31 100644 --- a/ios/ios/Info.plist +++ b/ios/ios/Info.plist @@ -19,7 +19,7 @@ CFBundlePackageType $(PRODUCT_BUNDLE_PACKAGE_TYPE) CFBundleShortVersionString - 3.12.0 + 3.7.2 CFBundleVersion 1 ITSAppUsesNonExemptEncryption diff --git a/ios/iosUITests/HammerUITest.swift b/ios/iosUITests/HammerUITest.swift index a8f42c680..06b110ac5 100644 --- a/ios/iosUITests/HammerUITest.swift +++ b/ios/iosUITests/HammerUITest.swift @@ -164,40 +164,21 @@ class HammerUITest: XCTestCase { /// The save button lives in the top bar, and right after the edit that surfaces it its /// accessibility frame can be briefly *stale* — reported up under the status bar (a dead pixel) /// before the layout settles. A blind coordinate tap there does nothing, and repeatedly tapping - /// that dead spot can even scroll/navigate the app away. So never tap the stale frame: tap only - /// once the button has *settled*. - /// - /// `isHittable` is the fast settled-signal and the preferred path (a hit-tested `tap()` - /// re-resolves the real position). But under simulator/CI load it can never flip true within the - /// timeout, which would leave a purely-`isHittable`-gated loop waiting out the whole budget - /// without ever tapping. So fall back to a coordinate `tapCenter` once the frame is demonstrably - /// settled by geometry — fully below the status bar (ruling out the dead-pixel position) and - /// stable across two samples. Re-tap until it's gone, which also covers a dropped tap or a late - /// IME keystroke re-dirtying the buffer right after a save. + /// that dead spot can even scroll/navigate the app away. So only tap when the button is actually + /// hittable (settled), using a hit-tested `tap()` that re-resolves its real position; otherwise + /// wait for it to settle. Re-tap until it's gone, which also covers a dropped tap or a late IME + /// keystroke re-dirtying the buffer right after a save. func tapUntilGone(_ tag: String, timeout: TimeInterval = HammerUITest.defaultTimeout, file: StaticString = #file, line: UInt = #line) { let el = waitFor(tag, timeout: timeout, file: file, line: line) let deadline = Date().addingTimeInterval(timeout) - var lastFrame = CGRect.null repeat { if !el.exists { return } if el.isHittable { el.tap() if poll({ !el.exists }, timeout: 3) { return } } else { - // Geometry fallback for when `isHittable` never settles under load. A settled top-bar - // button sits fully below the status bar and holds a stable frame; the transient - // dead-pixel frame reads under the status bar and is discarded here. - let frame = el.frame - let statusBarMaxY = app.statusBars.firstMatch.frame.maxY - let settled = frame.height > 0 && frame.minY >= statusBarMaxY && frame == lastFrame - lastFrame = frame - if settled { - tapCenter(el) - if poll({ !el.exists }, timeout: 3) { return } - } else { - _ = poll({ el.isHittable || !el.exists }, timeout: 0.5) - } + _ = poll({ el.isHittable || !el.exists }, timeout: 1) } } while Date() < deadline XCTFail("Element still present after \(timeout)s: \(tag)", file: file, line: line) diff --git a/msix/AppxManifest.xml b/msix/AppxManifest.xml index b0e85fb79..6b7e2bf01 100644 --- a/msix/AppxManifest.xml +++ b/msix/AppxManifest.xml @@ -11,7 +11,7 @@ Version="2.0.0.0" /> - Hammer: Story Editor + Hammer Editor Dark Rock Studios Assets\StoreLogo.png A simple tool for building stories. diff --git a/proguard-common.pro b/proguard-common.pro deleted file mode 100644 index 94a43e5ab..000000000 --- a/proguard-common.pro +++ /dev/null @@ -1,59 +0,0 @@ -# Line numbers for retraced stack traces; the mapping file is uploaded to Play by fastlane. --keepattributes SourceFile,LineNumberTable --renamesourcefileattribute SourceFile - -# Keep exception class names and their constructors for proper stack traces --keep class * extends java.lang.Exception { *; } --keep class * extends java.lang.RuntimeException { *; } --keep class * extends java.lang.Throwable { *; } - -# Keep `Companion` object fields of serializable classes. -# This avoids serializer lookup through `getDeclaredClasses` as done for named companion objects. --if @kotlinx.serialization.Serializable class ** --keepclassmembers class <1> { - static <1>$Companion Companion; -} - -# Keep `serializer()` on companion objects (both default and named) of serializable classes. --if @kotlinx.serialization.Serializable class ** { - static **$* *; -} --keepclassmembers class <2>$<3> { - kotlinx.serialization.KSerializer serializer(...); -} - -# Keep `INSTANCE.serializer()` of serializable objects. --if @kotlinx.serialization.Serializable class ** { - public static ** INSTANCE; -} --keepclassmembers class <1> { - public static <1> INSTANCE; - kotlinx.serialization.KSerializer serializer(...); -} - -# @Serializable and @Polymorphic are used at runtime for polymorphic serialization. --keepattributes RuntimeVisibleAnnotations,AnnotationDefault - -# Serializer for classes with named companion objects are retrieved using `getDeclaredClasses`. -# If you have any, uncomment and replace classes with those containing named companion objects. -#-keepattributes InnerClasses # Needed for `getDeclaredClasses`. -#-if @kotlinx.serialization.Serializable class -#com.example.myapplication.HasNamedCompanion, # <-- List serializable classes with named companions. -#com.example.myapplication.HasNamedCompanion2 -#{ -# static **$* *; -#} -#-keepnames class <1>$$serializer { # -keepnames suffices; class is kept when serializer() is kept. -# static <1>$$serializer INSTANCE; -#} - -# Animal Sniffer compileOnly dependency to ensure APIs are compatible with older versions of Java. --dontwarn org.codehaus.mojo.animal_sniffer.* - -# Logging --keep class io.github.aakira.napier.** { *; } --dontwarn org.slf4j.** --assumenosideeffects class org.slf4j.Logger { - public void trace(...); - public void debug(...); -} diff --git a/server/build.gradle.kts b/server/build.gradle.kts index dedb5d275..66c12ad79 100644 --- a/server/build.gradle.kts +++ b/server/build.gradle.kts @@ -45,7 +45,7 @@ sqldelight { packageName.set("com.darkrockstudios.apps.hammer.database") dialect(libs.sqldelight.postgresql.dialect.get().toString()) srcDirs("src/main/sqldelight") - version = 8 + version = 7 schemaOutputDirectory.set(project.file("build/generated/sqldelight")) } // Read-only legacy database — used ONLY by the one-time SQLite-to-Postgres migrator. @@ -80,15 +80,13 @@ dependencies { implementation(libs.coroutines.core) implementation(libs.coroutines.jdk8) implementation(libs.serialization.jvm) + implementation(libs.kotlinx.datetime) implementation(libs.clikt) implementation(libs.bundles.ktor.server) implementation(libs.ktor.server.hsts) - implementation(libs.ktor.server.forwarded.header) implementation(libs.ktor.network.tlscertificates) implementation(libs.bouncycastle.bcpkix) - // Argon2 password hashing; also pulled in transitively by bcpkix, declared for the direct use. - implementation(libs.bouncycastle.bcprov) implementation(libs.jakarta.mail) // Logback is the active SLF4J binding (replaces slf4j-simple) so logback.xml's @@ -136,6 +134,7 @@ dependencies { // implementation(libs.cryptography.core) // implementation(libs.cryptography.provider.jdk) implementation(libs.kache) + implementation(libs.argon2.jvm) testImplementation(libs.bundles.ktor.client) testImplementation(libs.ktor.serialization.kotlinx.json) @@ -170,6 +169,7 @@ dependencies { testFixturesApi(libs.bundles.junit.jupiter) testFixturesApi(libs.coroutines.core) testFixturesApi(libs.serialization.json) + testFixturesApi(libs.kotlinx.datetime) testFixturesApi(project.dependencies.platform(libs.koin.bom)) testFixturesApi(libs.koin.core) testFixturesApi(libs.embedded.postgres) diff --git a/server/src/jsTest/review-form-logic.test.js b/server/src/jsTest/review-form-logic.test.js index d4def199f..0be396f73 100644 --- a/server/src/jsTest/review-form-logic.test.js +++ b/server/src/jsTest/review-form-logic.test.js @@ -36,13 +36,3 @@ test('canSendReview requires at least one scene and an emailish address', () => assert.equal(logic.canSendReview(2, 'not-an-email'), false); // no '@' assert.equal(logic.canSendReview(2, ''), false); // empty email }); - -test('canCreateShare allows an unlimited share regardless of selection', () => { - assert.equal(logic.canCreateShare(false, 0), true); - assert.equal(logic.canCreateShare(false, 3), true); -}); - -test('canCreateShare requires a selection once limiting is enabled', () => { - assert.equal(logic.canCreateShare(true, 0), false); - assert.equal(logic.canCreateShare(true, 1), true); -}); diff --git a/server/src/jsTest/review-logic.test.js b/server/src/jsTest/review-logic.test.js index df187232c..ae6caa71e 100644 --- a/server/src/jsTest/review-logic.test.js +++ b/server/src/jsTest/review-logic.test.js @@ -133,43 +133,6 @@ test('parseInlineMarkdown supports nesting and leaves unmatched or intraword mar assert.equal(unclosed.map((r) => r.text).join(''), 'an *unclosed marker'); }); -test('parseInlineMarkdown renders strikethrough without markers', () => { - const text = 'He was ~~dead~~ alive.'; - const runs = logic.parseInlineMarkdown(text); - assert.deepEqual(runs.map((r) => [r.text, r.srcStart, r.strike]), [ - ['He was ', 0, false], - ['dead', 9, true], - [' alive.', 15, false], - ]); - for (const r of runs) { - assert.equal(text.slice(r.srcStart, r.srcStart + r.text.length), r.text); - } -}); - -test('parseInlineMarkdown nests strikethrough with other emphasis', () => { - const runs = logic.parseInlineMarkdown('*hello ~~there~~ now*'); - assert.deepEqual(runs.map((r) => [r.text, r.italic, r.strike]), [ - ['hello ', true, false], - ['there', true, true], - [' now', true, false], - ]); -}); - -test('parseInlineMarkdown leaves a lone or unmatched tilde literal', () => { - const lone = logic.parseInlineMarkdown('about ~5 minutes'); - assert.equal(lone.length, 1); - assert.equal(lone[0].strike, false); - assert.equal(lone[0].text, 'about ~5 minutes'); - - const unclosed = logic.parseInlineMarkdown('an ~~unclosed marker'); - assert.equal(unclosed.map((r) => r.text).join(''), 'an ~~unclosed marker'); - assert.equal(unclosed.some((r) => r.strike), false); - - const escaped = logic.parseInlineMarkdown('not \\~\\~struck\\~\\~ here'); - assert.equal(escaped.map((r) => r.text).join(''), 'not ~~struck~~ here'); - assert.equal(escaped.some((r) => r.strike), false); -}); - test('parseInlineMarkdown unescapes backslash-escaped punctuation, keeping source offsets', () => { const text = 'Down the Rabbit\\-Hole \\(here\\) What\\!'; const runs = logic.parseInlineMarkdown(text); diff --git a/server/src/jsTest/toast-logic.test.js b/server/src/jsTest/toast-logic.test.js deleted file mode 100644 index b9ff7d073..000000000 --- a/server/src/jsTest/toast-logic.test.js +++ /dev/null @@ -1,29 +0,0 @@ -const { test } = require('node:test'); -const assert = require('node:assert/strict'); -const logic = require('../main/resources/assets/js/toast-logic.js'); - -test('marked error responses are swapped so their toast survives', () => { - assert.equal(logic.shouldSwapErrorResponse(400, 'true'), true); - assert.equal(logic.shouldSwapErrorResponse(422, 'true'), true); - assert.equal(logic.shouldSwapErrorResponse(500, 'true'), true); -}); - -test('unmarked error responses keep htmx default handling', () => { - // A bare 400 would swap an empty body over the target; a 404 would swap a whole error page. - assert.equal(logic.shouldSwapErrorResponse(400, null), false); - assert.equal(logic.shouldSwapErrorResponse(404, null), false); - assert.equal(logic.shouldSwapErrorResponse(401, undefined), false); - assert.equal(logic.shouldSwapErrorResponse(403, 'false'), false); - assert.equal(logic.shouldSwapErrorResponse(400, ''), false); -}); - -test('successful responses are left to htmx even if marked', () => { - assert.equal(logic.shouldSwapErrorResponse(200, 'true'), false); - assert.equal(logic.shouldSwapErrorResponse(204, 'true'), false); - assert.equal(logic.shouldSwapErrorResponse(302, 'true'), false); - assert.equal(logic.shouldSwapErrorResponse(399, 'true'), false); -}); - -test('the header name matches what the server sends', () => { - assert.equal(logic.SWAP_ERROR_HEADER, 'X-Hammer-Swap-Error'); -}); diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/Application.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/Application.kt index dcf092205..e721a2646 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/Application.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/Application.kt @@ -1,21 +1,17 @@ package com.darkrockstudios.apps.hammer -import com.darkrockstudios.apps.hammer.account.configureAccountDeletionJob import com.darkrockstudios.apps.hammer.account.configureTokenMaintenanceJob import com.darkrockstudios.apps.hammer.admin.configureWhitelistExpiryJob import com.darkrockstudios.apps.hammer.base.http.createTokenBase64 import com.darkrockstudios.apps.hammer.base.http.readToml import com.darkrockstudios.apps.hammer.database.Database -import com.darkrockstudios.apps.hammer.datamigrator.DataMigrator import com.darkrockstudios.apps.hammer.dependencyinjection.mainModule import com.darkrockstudios.apps.hammer.encryption.EncryptionBootstrap import com.darkrockstudios.apps.hammer.frontend.configureFrontEnd import com.darkrockstudios.apps.hammer.monitoring.configureApiMetrics import com.darkrockstudios.apps.hammer.monitoring.configureMonitoringJob import com.darkrockstudios.apps.hammer.monitoring.configureRouteTemplateCapture -import com.darkrockstudios.apps.hammer.plugin.ServerPlugin -import com.darkrockstudios.apps.hammer.plugin.installedPlugins -import com.darkrockstudios.apps.hammer.plugin.launchPluginTasks +import com.darkrockstudios.apps.hammer.patreon.configurePatreonPolling import com.darkrockstudios.apps.hammer.plugins.SetupModePlugin import com.darkrockstudios.apps.hammer.plugins.configureDependencyInjection import com.darkrockstudios.apps.hammer.plugins.configureHTTP @@ -27,12 +23,10 @@ import com.darkrockstudios.apps.hammer.plugins.configureSerialization import com.darkrockstudios.apps.hammer.secret.KeyringCodec import com.darkrockstudios.apps.hammer.utilities.DevSelfSignedCert import com.darkrockstudios.apps.hammer.utilities.DiskCache -import com.darkrockstudios.apps.hammer.utilities.applyServerTimeZone import com.darkrockstudios.apps.hammer.utilities.cacheDirectory import com.darkrockstudios.apps.hammer.utilities.configureDiskCachePruneJob import com.darkrockstudios.apps.hammer.utilities.getRootDataDirectory import com.darkrockstudios.apps.hammer.utilities.loadPemAsKeyStore -import com.darkrockstudios.apps.hammer.utilities.resolveServerTimeZone import com.github.ajalt.clikt.core.CliktCommand import com.github.ajalt.clikt.core.main import com.github.ajalt.clikt.core.subcommands @@ -95,10 +89,6 @@ class HammerServerCommand : CliktCommand(name = "Hammer Server") { val logLevel = parseLogLevel(logLevelArg) val config: ServerConfig = resolveServerConfig(configPath) - val timeZone = resolveServerTimeZone(config.timezone) - applyServerTimeZone(timeZone) - configLogger.info("Server time zone: $timeZone") - config.storage.validate() config.analytics.validate() @@ -215,7 +205,6 @@ internal fun resolveServerConfig( validateConfigFiles(resolved, fileSystem) validateCacheDirectory(resolved.cache, fileSystem) resolved.extraLinks.forEach { it.validate() } - resolved.accountDeletion.validate() return resolved } @@ -416,15 +405,10 @@ fun Application.appMain( config: ServerConfig, addInModule: Module? = null, logLevel: Level? = null, - plugins: List = installedPlugins(), ) { - configureDependencyInjection(config, addInModule, plugins) + configureDependencyInjection(config, addInModule) val encryptionBootstrap: EncryptionBootstrap by inject() runBlocking { encryptionBootstrap.run() } - // Must complete before any route is installed: routes enforce the allowed - // users list, and the backfill is what guarantees existing accounts are on it. - val dataMigrator: DataMigrator by inject() - runBlocking { dataMigrator.runMigrations() } configureSerialization() configureMonitoring(logLevel) configureApiMetrics() @@ -435,11 +419,10 @@ fun Application.appMain( install(SetupModePlugin) configureRouting(config) configureFrontEnd() - launchPluginTasks() + configurePatreonPolling(config) configureMonitoringJob() configureTokenMaintenanceJob() configureWhitelistExpiryJob() - configureAccountDeletionJob() configureDiskCachePruneJob() } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/ServerConfig.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/ServerConfig.kt index 3ab1711ea..a645106f5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/ServerConfig.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/ServerConfig.kt @@ -8,8 +8,6 @@ import kotlinx.serialization.Transient import java.net.URI import java.net.URISyntaxException import java.util.Locale -import kotlin.time.Duration -import kotlin.time.Duration.Companion.days @Serializable data class ServerConfig( @@ -29,18 +27,6 @@ data class ServerConfig( * links are derived from each request's Host header. */ val publicUrl: String? = null, - /** - * Trust the `X-Forwarded-*` headers for each request's client address and scheme. Only safe - * when the proxy is the only route in, since anything reaching the server directly can forge - * them. Assumes a single proxy: the address comes from the last `X-Forwarded-For` entry. - */ - val trustProxyForwarding: Boolean = false, - /** - * IANA zone ID (e.g. "Europe/Paris") that server-rendered timestamps and log lines are stamped - * in. Absent, the `HAMMER_TIMEZONE` environment variable is used, then `TZ`, then the host's own - * zone. An unknown ID aborts startup. - */ - val timezone: String? = null, val additionalSitemaps: List = emptyList(), /** * Generate per-page social share images (OpenGraph) on the fly for author and story pages. @@ -50,6 +36,7 @@ data class ServerConfig( */ val richLinkPreviews: Boolean = false, val sslCert: SslCertConfig? = null, + val patreonEnabled: Boolean? = null, /** * Path to a plaintext file whose contents are presented as a Terms of Service that * users must accept before an account is created. Null/absent disables the requirement. @@ -67,7 +54,6 @@ data class ServerConfig( val emailProvider: String? = null, val communityEnabled: Boolean = false, val extraLinks: List = emptyList(), - val accountDeletion: AccountDeletionConfig = AccountDeletionConfig(), val storage: StorageConfig = StorageConfig(), val cache: CacheConfig = CacheConfig(), val analytics: AnalyticsConfig = AnalyticsConfig(), @@ -340,32 +326,6 @@ data class StorageConfig( } } -/** - * Self-service account deletion. A deleted account is soft-deleted first: locked out of - * login and sync, unpublished, pen name released, but its data is retained so an operator - * can restore it. A daily job permanently deletes accounts soft-deleted longer than - * [retentionDays]. The window is evaluated against each account's deletion time on every - * job run, so lowering it also hard-deletes accounts already past the new window. - */ -@Serializable -data class AccountDeletionConfig( - /** Days a soft-deleted account is retained before permanent deletion. */ - val retentionDays: Int = 30, -) { - @Transient - val retention: Duration = retentionDays.days - - fun validate() { - require(retentionDays in 1..MAX_RETENTION_DAYS) { - "accountDeletion.retentionDays must be between 1 and $MAX_RETENTION_DAYS, was $retentionDays" - } - } - - private companion object { - const val MAX_RETENTION_DAYS = 3650 - } -} - /** * The regenerable disk caches: rendered story HTML and OpenGraph share cards. Nothing here is * durable data — losing the whole directory costs a re-render, so it belongs on whatever volume diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJob.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJob.kt deleted file mode 100644 index b5a339d33..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJob.kt +++ /dev/null @@ -1,44 +0,0 @@ -package com.darkrockstudios.apps.hammer.account - -import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.scheduling.RecurringTask -import kotlinx.coroutines.CancellationException -import org.slf4j.Logger -import kotlin.time.Clock -import kotlin.time.Duration.Companion.hours - -/** - * Hard-deletes accounts whose soft-delete retention window has elapsed. - * Enforcement lives in the auth gates: a soft-deleted account is already locked - * out, so this job only performs the final purge and its cadence never affects - * correctness. - */ -class AccountDeletionJob( - private val accountDeletionService: AccountDeletionService, - private val serverConfig: ServerConfig, - private val clock: Clock, - logger: Logger, -) : RecurringTask("Account deletion job", logger) { - - override suspend fun tick() { - val cutoff = clock.now() - serverConfig.accountDeletion.retention - val dueAccounts = accountDeletionService.findAccountsPastRetention(cutoff) - for (account in dueAccounts) { - try { - accountDeletionService.hardDelete(account.id) - logger.info("Account past retention hard-deleted: ${account.id}") - } catch (e: CancellationException) { - throw e - // One account failing must not starve the rest of the batch. - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - logger.error("Hard delete failed for account ${account.id}", e) - } - } - } - - override suspend fun nextDelay() = CHECK_INTERVAL - - companion object { - private val CHECK_INTERVAL = 24.hours - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionService.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionService.kt deleted file mode 100644 index a6a3b19ff..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionService.kt +++ /dev/null @@ -1,108 +0,0 @@ -package com.darkrockstudios.apps.hammer.account - -import com.darkrockstudios.apps.hammer.Account -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository -import com.darkrockstudios.apps.hammer.database.UserDataPurgeDao -import com.darkrockstudios.apps.hammer.project.ProjectSyncKey -import com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession -import com.darkrockstudios.apps.hammer.projects.ProjectsSynchronizationSession -import com.darkrockstudios.apps.hammer.syncsessionmanager.SyncSessionManager -import com.darkrockstudios.apps.hammer.utilities.Msg -import com.darkrockstudios.apps.hammer.utilities.SResult -import kotlin.time.Clock -import kotlin.time.Instant - -/** - * User-initiated account deletion. Deletion is two-phase: [softDelete] locks the - * account out immediately while its data is retained for a configurable window - * ([com.darkrockstudios.apps.hammer.AccountDeletionConfig.retentionDays]) so an - * operator can [restore] it; [AccountDeletionJob] calls [hardDelete] for accounts - * past the window. - */ -class AccountDeletionService( - private val accountsRepository: AccountsRepository, - private val penNameService: PenNameService, - private val whiteListRepository: WhiteListRepository, - private val userDataPurgeDao: UserDataPurgeDao, - private val projectsSyncManager: SyncSessionManager, - private val projectSyncManager: SyncSessionManager, - private val clock: Clock, -) { - /** - * Flags the account as deleted and locks it out everywhere: auth tokens are - * revoked, live sync sessions terminated, every published and privately shared - * story unpublished, and the pen name released for others to claim. The - * account row and story data are retained until [hardDelete]. - * - * Admin accounts can never be deleted; an admin must have their admin status - * removed first. The markDeleted query enforces the same rule at the data - * layer, so no other caller can flag an admin either. - */ - suspend fun softDelete(userId: Long): SResult { - val account = accountsRepository.getAccountOrNull(userId) - ?: return SResult.failure("Account not found", Msg.r("api_error_unknown")) - - if (account.is_admin) { - return SResult.failure( - "Admin accounts cannot be deleted", - Msg.r("account_delete_error_admin") - ) - } - - // Flag first so every auth gate closes before anything else happens. - // The destructive steps only run once the flag is confirmed set: the - // markDeleted query refuses admin rows, so a zero-row update must not - // strip a still-active account. - accountsRepository.markDeleted(userId, clock.now()) - val flagged = accountsRepository.getAccountOrNull(userId)?.deleted_at != null - if (!flagged) { - return SResult.failure( - "Account could not be flagged for deletion", - Msg.r("account_delete_error_generic") - ) - } - - // An already-flagged account runs these again on purpose: each step is - // idempotent, so a retry heals a previously interrupted attempt. - accountsRepository.forceLogout(account.email) - projectsSyncManager.terminateSession(userId) - projectSyncManager.terminateSessions { it.userId == userId } - penNameService.releasePenName(userId) - accountsRepository.updateCommunityMember(userId, false) - - return SResult.success(Unit) - } - - /** - * Un-flags a soft-deleted account so it can log in and sync again. The pen - * name and publish state are NOT restored: the pen name was released and may - * have been claimed by another account since. Returns false when no such - * account exists. - */ - suspend fun restore(userId: Long): Boolean { - accountsRepository.getAccountOrNull(userId) ?: return false - accountsRepository.restoreDeleted(userId) - return true - } - - /** Accounts soft-deleted before [cutoff], due for permanent deletion. */ - suspend fun findAccountsPastRetention(cutoff: Instant): List { - return accountsRepository.getSoftDeletedBefore(cutoff) - } - - /** - * Permanently deletes the account and every row it owns, and removes its - * email from the whitelist. A no-op when the account is missing or no longer - * soft-deleted; the purge transaction re-checks deleted_at under a row lock, - * so a restore racing the retention job always wins. Disk caches of rendered - * story HTML and OG images are left to DiskCachePruneJob; serving is - * DB-gated, so nothing stale stays reachable. - */ - suspend fun hardDelete(userId: Long) { - val account = accountsRepository.getAccountOrNull(userId) ?: return - if (account.deleted_at == null) return - if (userDataPurgeDao.purgeUserData(userId)) { - whiteListRepository.removeFromWhiteList(account.email) - } - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutes.kt index 4c7818509..09ce679c5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutes.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutes.kt @@ -1,9 +1,9 @@ package com.darkrockstudios.apps.hammer.account -import com.darkrockstudios.apps.hammer.base.http.ApiErrorCode import com.darkrockstudios.apps.hammer.base.http.HTTP_STATUS_TERMS_OF_SERVICE import com.darkrockstudios.apps.hammer.base.http.HttpResponseError import com.darkrockstudios.apps.hammer.base.http.INVALID_USER_ID +import com.darkrockstudios.apps.hammer.monitoring.MonitoringState import com.darkrockstudios.apps.hammer.monitoring.SecurityRepository import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT import com.darkrockstudios.apps.hammer.plugins.ServerUserIdPrincipal @@ -12,7 +12,6 @@ import com.darkrockstudios.apps.hammer.utilities.isSuccess import com.github.aymanizz.ktori18n.R import com.github.aymanizz.ktori18n.t import io.ktor.http.* -import io.ktor.http.auth.HttpAuthHeader import io.ktor.server.auth.* import io.ktor.server.plugins.* import io.ktor.server.plugins.ratelimit.* @@ -26,9 +25,6 @@ fun Route.accountRoutes() { rateLimit(RateLimitName(LOGIN_RATE_LIMIT)) { createAccount() login() - authenticate(USER_AUTH) { - pairInstall() - } } refreshToken() authenticate(USER_AUTH) { @@ -63,10 +59,9 @@ private fun Route.createAccount() { is CreateAccountResult.Failure -> { val response = HttpResponseError( error = "Failed to create account", - displayMessage = result.failure.displayMessageText(call, R("api_error_unknown")), - errorCode = createErrorCode(result.failure.exception), + displayMessage = result.failure.displayMessageText(call, R("api_error_unknown")) ) - call.respond(status = createErrorStatus(result.failure.exception), response) + call.respond(status = HttpStatusCode.Conflict, response) } } } @@ -75,6 +70,7 @@ private fun Route.createAccount() { private fun Route.login() { val accountsComponent: AccountsComponent = get() val securityRepository: SecurityRepository = get() + val monitoringState: MonitoringState = get() post("/login") { val formParameters = call.receiveParameters() @@ -83,48 +79,26 @@ private fun Route.login() { val installId = formParameters["installId"].toString() val result = accountsComponent.login(email = email, password = password, installId = installId) + val success = isSuccess(result) - securityRepository.recordLoginAttempt( - email = email, - ipAddress = call.request.origin.remoteAddress, - success = isSuccess(result), - ) + if (monitoringState.loginTrackingEnabled) { + val ip = if (monitoringState.storeLoginIp) call.request.origin.remoteAddress else null + securityRepository.recordLoginAttempt(email = email, ipAddress = ip, success = success) + } if (isSuccess(result)) { val authToken = result.data call.respond(authToken) } else { - // A rejected whitelist isn't a credential problem, and answering 401 made it - // indistinguishable from a wrong password in both the logs and the client. - val notWhitelisted = result.exception is NotWhitelisted val response = HttpResponseError( error = "Failed to authenticate", - displayMessage = result.displayMessageText(call, R("api_error_unknown")), - errorCode = if (notWhitelisted) ApiErrorCode.NOT_WHITELISTED - else ApiErrorCode.INVALID_CREDENTIALS, + displayMessage = result.displayMessageText(call, R("api_error_unknown")) ) - val status = if (notWhitelisted) HttpStatusCode.Forbidden else HttpStatusCode.Unauthorized - call.respond(status = status, message = response) + call.respond(status = HttpStatusCode.Unauthorized, response) } } } -private fun createErrorStatus(cause: Throwable?): HttpStatusCode = when (cause) { - is AccountAlreadyExists, is AccountPendingDeletion -> HttpStatusCode.Conflict - is InvalidEmail, is InvalidPassword -> HttpStatusCode.BadRequest - is NotWhitelisted -> HttpStatusCode.Forbidden - else -> HttpStatusCode.Conflict -} - -private fun createErrorCode(cause: Throwable?): String? = when (cause) { - is AccountAlreadyExists -> ApiErrorCode.ACCOUNT_EXISTS - is AccountPendingDeletion -> ApiErrorCode.ACCOUNT_PENDING_DELETION - is InvalidEmail -> ApiErrorCode.INVALID_EMAIL - is InvalidPassword -> InvalidPassword.getCode(cause.result) - is NotWhitelisted -> ApiErrorCode.NOT_WHITELISTED - else -> null -} - private fun Route.refreshToken() { val accountsComponent: AccountsComponent = get() @@ -145,65 +119,7 @@ private fun Route.refreshToken() { status = HttpStatusCode.Unauthorized, HttpResponseError( error = "Unauthorized", - displayMessage = result.displayMessageText(call, R("api_accounts_tokenrefresh_error")), - errorCode = ApiErrorCode.TOKEN_INVALID, - ) - ) - } - } -} - -private fun Route.pairInstall() { - val accountsComponent: AccountsComponent = get() - val accountsRepository: AccountsRepository = get() - - post("/pair_install/{userId}") { - val principal = call.principal()!! - val newInstallId = call.receiveParameters()["installId"] - - // Derived from the authenticated token (not client-asserted). Parsed the way Ktor itself - // parses it, because the auth scheme is case insensitive. - val callerInstallId = (call.request.parseAuthorizationHeader() as? HttpAuthHeader.Single) - ?.blob - ?.takeIf { it.isNotBlank() } - ?.let { accountsRepository.getInstallId(it) } - - if (newInstallId == null || callerInstallId == null) { - call.respond( - status = HttpStatusCode.BadRequest, - HttpResponseError( - error = "Missing install id", - displayMessage = call.t(R("api_accounts_pair_error_invalidinstall")), - ) - ) - return@post - } - - val result = accountsComponent.pairInstall( - userId = principal.id, - callerInstallId = callerInstallId, - newInstallId = newInstallId, - ) - if (isSuccess(result)) { - call.application.environment.log.info("Paired a new install for user ${principal.id}") - call.respond(HttpStatusCode.Created, result.data) - } else { - val status = when (result.exception) { - is InvalidInstallId -> HttpStatusCode.BadRequest - is NotWhitelisted -> HttpStatusCode.Forbidden - else -> HttpStatusCode.Unauthorized - } - val errorCode = when (result.exception) { - is InvalidInstallId -> null - is NotWhitelisted -> ApiErrorCode.NOT_WHITELISTED - else -> ApiErrorCode.TOKEN_INVALID - } - call.respond( - status = status, - HttpResponseError( - error = "Failed to pair install", - displayMessage = result.displayMessageText(call, R("api_accounts_pair_error")), - errorCode = errorCode, + displayMessage = call.t(R("api_accounts_tokenrefresh_error")) ) ) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponent.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponent.kt index 47021bddc..bc50a5559 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponent.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponent.kt @@ -1,10 +1,13 @@ package com.darkrockstudios.apps.hammer.account import com.darkrockstudios.apps.hammer.Account +import com.darkrockstudios.apps.hammer.ServerConfig +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge import com.darkrockstudios.apps.hammer.base.http.Token -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry +import com.darkrockstudios.apps.hammer.patreon.PatreonConfig import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.utilities.Msg import com.darkrockstudios.apps.hammer.utilities.SResult @@ -15,8 +18,9 @@ class AccountsComponent( private val accountsRepository: AccountsRepository, private val whiteListRepository: WhiteListRepository, private val projectsRepository: ProjectsRepository, + private val configRepository: ConfigRepository, private val termsOfServiceRepository: TermsOfServiceRepository, - private val pluginRegistry: PluginRegistry, + private val serverConfig: ServerConfig, ) { suspend fun createAccount( email: String, @@ -63,14 +67,6 @@ class AccountsComponent( // a bad token does — never surface AccountNotFound as a 500, since the status // difference would reveal whether the account exists. val account = accountsRepository.getAccountOrNull(userId) - if (account?.deleted_at != null) { - // Real tokens were revoked at soft delete, so anyone reaching this - // held a valid refresh token; the explicit message is safe. - return SResult.failure( - "Account pending deletion", - Msg.r("api_accounts_login_error_pending_deletion") - ) - } if (account != null && checkIfWhiteListRejected(account)) { return whiteListRejectedFailure() } @@ -78,47 +74,41 @@ class AccountsComponent( return accountsRepository.refreshToken(userId, installId, refreshToken) } - suspend fun pairInstall( - userId: Long, - callerInstallId: String, - newInstallId: String, - ): SResult { - val account = accountsRepository.getAccountOrNull(userId) - ?: return SResult.failure("Account not found", Msg.r("api_accounts_login_error_notoken")) - if (account.deleted_at != null) { - return SResult.failure( - "Account pending deletion", - Msg.r("api_accounts_login_error_pending_deletion") - ) - } - if (checkIfWhiteListRejected(account)) { - return whiteListRejectedFailure() - } - - return accountsRepository.pairInstall(userId, callerInstallId, newInstallId) - } - suspend fun checkIfWhiteListRejected(email: String): Boolean { val account = accountsRepository.findAccount(email) return if (account != null) { checkIfWhiteListRejected(account) } else { - whiteListRepository.isOnWhiteList(email).not() + whiteListRepository.useWhiteList() && whiteListRepository.isOnWhiteList(email).not() } } private suspend fun checkIfWhiteListRejected(account: Account): Boolean { return !account.is_admin && + whiteListRepository.useWhiteList() && whiteListRepository.isOnWhiteList(account.email).not() } + private suspend fun getActivePatreonConfig(): PatreonConfig? { + if (serverConfig.patreonEnabled != true) return null + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + return if (config.enabled && config.patreonUrl.isNotBlank()) config else null + } + private suspend fun whiteListRejectedFailure(): ServerResult.Failure { - val message = pluginRegistry.activeAllowedUsersSource()?.rejectionMessage() - return SResult.failure( - error = "User not on whitelist", - displayMessage = message ?: Msg.r("api_allowedusers_rejected"), - exception = NotWhitelisted() - ) + val patreonConfig = getActivePatreonConfig() + return if (patreonConfig != null) { + val amount = "%.2f".format(patreonConfig.minimumAmountCents / 100.0) + SResult.failure( + error = "User not on whitelist - Patreon subscription required", + displayMessage = Msg.r("login_failure_patreon_notice_message", amount, patreonConfig.patreonUrl) + ) + } else { + SResult.failure( + error = "User not on whitelist", + displayMessage = Msg.r("api_whitelist_rejected") + ) + } } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepository.kt index 2ec13689c..37bcb0cfc 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepository.kt @@ -10,7 +10,7 @@ import com.darkrockstudios.apps.hammer.database.AccountDao import com.darkrockstudios.apps.hammer.database.AuthTokenDao import com.darkrockstudios.apps.hammer.database.CommunityAuthor import com.darkrockstudios.apps.hammer.utilities.* -import org.slf4j.LoggerFactory +import de.mkammerer.argon2.Argon2Factory import kotlin.io.encoding.Base64 import kotlin.time.Clock import kotlin.time.Duration.Companion.days @@ -95,27 +95,17 @@ class AccountsRepository( // Hash anyway so the existing-account path costs the same Argon2 time as // creating a new account — no timing oracle for account enumeration. hashPassword(password) - if (existingAccount.deleted_at != null) { - // The row must survive so the account can be restored, which - // keeps the email reserved until the retention window ends. - SResult.failure( - "account pending deletion", - Msg.r("api_accounts_login_error_pending_deletion"), - AccountPendingDeletion() - ) - } else { - SResult.failure( - "account already exists", - Msg.r("api_accounts_create_error_accountexists"), - AccountAlreadyExists() - ) - } + SResult.failure( + "account already exists", + Msg.r("api_accounts_create_error_accountexists"), + CreateFailed("Account already exists") + ) } !EmailValidator.validate(email) -> SResult.failure( "invalid email", Msg.r("api_accounts_create_error_invalidemail"), - InvalidEmail() + CreateFailed("Invalid email") ) passwordResult != PasswordValidationResult.VALID -> SResult.failure( @@ -149,14 +139,19 @@ class AccountsRepository( private fun checkPassword(account: Account, plainTextPassword: String): Boolean = checkPassword(plainTextPassword, account.password_hash) - // An unreadable stored hash is treated as a wrong password. + // Any verify failure (invalid/old hash format) is treated as a wrong password. + @Suppress("TooGenericExceptionCaught", "SwallowedException") private fun checkPassword(plainTextPassword: String, passwordHash: String): Boolean { + val argon2 = Argon2Factory.create() val passwordChars = plainTextPassword.toCharArray() return try { - Argon2PasswordHasher.verify(passwordHash, passwordChars) + argon2.verify(passwordHash, passwordChars) + } catch (_: Exception) { + // If verification fails (e.g., invalid format, old hash), return false + false } finally { - passwordChars.fill('\u0000') + argon2.wipeArray(passwordChars) } } @@ -177,32 +172,12 @@ class AccountsRepository( } return if (account != null && passwordValid) { - if (account.deleted_at != null) { - // Only reachable with valid credentials, so this reveals account - // state to its owner and nothing to password guessers. - SResult.failure( - "Account pending deletion", - Msg.r("api_accounts_login_error_pending_deletion"), - AccountPendingDeletion() - ) - } else { - val token = createToken(account.id, installId) - SResult.success(token) - } + val token = createToken(account.id, installId) + SResult.success(token) } else { - // The response can't distinguish these two — that would let anyone - // enumerate accounts — but the operator's log can, and without it a - // failing login is undiagnosable from the server side. - if (account == null) { - log.info("Login rejected: no account for the submitted email") - } else { - log.info("Login rejected: password mismatch for user ${account.id}") - } - SResult.failure( - "Invalid credentials", - Msg.r("api_accounts_login_error_invalid"), - LoginFailed("Invalid credentials") - ) + // One message for both unknown-account and wrong-password so the + // response body doesn't reveal whether the account exists. + SResult.failure("Invalid credentials", Msg.r("api_accounts_login_error_invalid")) } } @@ -238,29 +213,6 @@ class AccountsRepository( } } - /** - * Mints a session for another of the user's devices. Tokens are stored per install, so - * minting for the caller's own install would replace the caller's session; that is refused. - */ - suspend fun pairInstall(userId: Long, callerInstallId: String, newInstallId: String): SResult { - val installId = newInstallId.trim() - return when { - installId.isEmpty() -> SResult.failure( - "Invalid install id", - Msg.r("api_accounts_pair_error_invalidinstall"), - InvalidInstallId("Blank install id") - ) - - installId == callerInstallId -> SResult.failure( - "Same install id", - Msg.r("api_accounts_pair_error_sameinstall"), - InvalidInstallId("Install id matches the caller") - ) - - else -> SResult.success(createToken(userId, installId)) - } - } - /** * Delete auth tokens whose refresh window has fully elapsed, i.e. they can no * longer be used to authenticate or to refresh. A still-refreshable row (within @@ -284,18 +236,6 @@ class AccountsRepository( return accountDao.getAccount(userId)?.is_admin == true } - suspend fun markDeleted(userId: Long, deletedAt: Instant = clock.now()) { - accountDao.markDeleted(userId, deletedAt) - } - - suspend fun restoreDeleted(userId: Long) { - accountDao.restoreDeleted(userId) - } - - suspend fun getSoftDeletedBefore(cutoff: Instant): List { - return accountDao.getSoftDeletedBefore(cutoff) - } - suspend fun findAccount(email: String): Account? { return accountDao.findAccount(email) } @@ -358,8 +298,6 @@ class AccountsRepository( } companion object { - private val log = LoggerFactory.getLogger(AccountsRepository::class.java) - const val CIPHER_SALT_LENGTH = 16 // A refresh token stays valid until this long past its access token's expiry. @@ -376,17 +314,18 @@ class AccountsRepository( const val ARGON2_PARALLELISM = 2 // threads fun hashPassword(password: String): String { + val argon2 = Argon2Factory.create() val passwordChars = password.toCharArray() try { - return Argon2PasswordHasher.hash( - password = passwordChars, - memoryKib = ARGON2_MEMORY_COST_KIB, - iterations = ARGON2_TIME_COST, - parallelism = ARGON2_PARALLELISM, + return argon2.hash( + ARGON2_TIME_COST, + ARGON2_MEMORY_COST_KIB, + ARGON2_PARALLELISM, + passwordChars ) } finally { - passwordChars.fill('\u0000') + argon2.wipeArray(passwordChars) } } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryExceptions.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryExceptions.kt index f7fa5a773..ff6efbaa5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryExceptions.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryExceptions.kt @@ -1,22 +1,12 @@ package com.darkrockstudios.apps.hammer.account -import com.darkrockstudios.apps.hammer.base.http.ApiErrorCode import com.darkrockstudios.apps.hammer.base.validate.PasswordValidationResult import com.darkrockstudios.apps.hammer.utilities.Msg open class CreateFailed(message: String) : Exception(message) -class AccountAlreadyExists : CreateFailed("Account already exists") -class AccountPendingDeletion : CreateFailed("Account pending deletion") -class InvalidEmail : CreateFailed("Invalid email") class InvalidPassword(val result: PasswordValidationResult) : CreateFailed("Invalid Password") { companion object { - fun getCode(result: PasswordValidationResult): String = when (result) { - PasswordValidationResult.TOO_SHORT -> ApiErrorCode.PASSWORD_TOO_SHORT - PasswordValidationResult.TOO_LONG -> ApiErrorCode.PASSWORD_TOO_LONG - else -> ApiErrorCode.PASSWORD_INVALID - } - fun getMessage(result: PasswordValidationResult): Msg = when (result) { PasswordValidationResult.TOO_SHORT -> Msg.r("api_accounts_create_error_password_tooshort") PasswordValidationResult.TOO_LONG -> Msg.r("api_accounts_create_error_password_toolong") @@ -31,10 +21,4 @@ class InvalidPassword(val result: PasswordValidationResult) : class LoginFailed(message: String) : Exception(message) -/** Credentials were fine (or irrelevant); the account simply isn't allowed on this server. */ -class NotWhitelisted : Exception("User not on whitelist") - -/** A pairing request named no install, or named the caller's own install. */ -class InvalidInstallId(message: String) : Exception(message) - class AccountNotFound(userId: Long) : Exception("User ID ($userId) not found") diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/ConfigureAccountDeletionJob.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/ConfigureAccountDeletionJob.kt deleted file mode 100644 index eee0c29a5..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/account/ConfigureAccountDeletionJob.kt +++ /dev/null @@ -1,15 +0,0 @@ -package com.darkrockstudios.apps.hammer.account - -import com.darkrockstudios.apps.hammer.scheduling.launchRecurringTask -import io.ktor.server.application.* -import org.koin.ktor.ext.inject - -/** - * Starts the job that permanently deletes accounts past their soft-delete - * retention window. Always runs; a pass with nothing due is a no-op. - */ -fun Application.configureAccountDeletionJob() { - val job: AccountDeletionJob by inject() - launchRecurringTask(job) - log.info("Account deletion job started") -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponent.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponent.kt index 39f01969a..cc839fa2f 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponent.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponent.kt @@ -31,4 +31,12 @@ class AdminComponent( suspend fun removeFromWhiteList(email: String) { whiteListRepository.removeFromWhiteList(email) } + + suspend fun enableWhiteList() { + whiteListRepository.setWhiteListEnabled(true) + } + + suspend fun disableWhiteList() { + whiteListRepository.setWhiteListEnabled(false) + } } \ No newline at end of file diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminRoutes.kt index 75a89b8b0..a60908af2 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminRoutes.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminRoutes.kt @@ -17,6 +17,7 @@ import kotlin.time.Instant private const val ERR_KEY_WHITELIST_EMAIL_MISSING = "api_admin_whitelist_error_emailmissing" private const val ERR_KEY_WHITELIST_EXPIRES_INVALID = "api_admin_whitelist_error_expiresinvalid" +private const val ERR_KEY_ENABLE_WHITELIST_MISSING = "api_admin_enablewhitelist_enablemissing" private const val MSG_SUCCESS_KEY = "api_success" fun Route.adminRoutes() { @@ -25,6 +26,7 @@ fun Route.adminRoutes() { getWhiteList() addToWhiteList() removeFromWhiteList() + enableWhiteList() } } } @@ -94,3 +96,22 @@ private fun Route.removeFromWhiteList() { call.respond(call.t(R(MSG_SUCCESS_KEY))) } } + +private fun Route.enableWhiteList() { + val adminRepository: AdminComponent = get() + + delete("/whitelist/enable/{setEnable}") { + val setEnable = call.request.queryParameters["setEnable"]?.toBoolean() + if (setEnable == null) { + call.respondMissingParameter(ERR_KEY_ENABLE_WHITELIST_MISSING) + return@delete + } + + if (setEnable) { + adminRepository.enableWhiteList() + } else { + adminRepository.disableWhiteList() + } + call.respond(call.t(R(MSG_SUCCESS_KEY))) + } +} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminServerConfig.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminServerConfig.kt index b09291efb..dc3edd234 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminServerConfig.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/AdminServerConfig.kt @@ -6,6 +6,7 @@ import com.darkrockstudios.apps.hammer.email.SendGridConfig import com.darkrockstudios.apps.hammer.email.SmtpConfig import com.darkrockstudios.apps.hammer.monitoring.IgnoredErrorRule import com.darkrockstudios.apps.hammer.monitoring.MonitoringConfig +import com.darkrockstudios.apps.hammer.patreon.PatreonConfig import kotlinx.serialization.builtins.ListSerializer import kotlinx.serialization.json.Json @@ -24,10 +25,17 @@ data class ServerConfigKey( } object AdminServerConfig { + val WHITELIST_ENABLED = ServerConfigKey.boolean("whitelist_enabled", true) val SERVER_MESSAGE = ServerConfigKey.string("server_message", "Welcome to this instance of Hammer! Happy syncing!") val ABOUT_SERVER = ServerConfigKey.string("about_server", "") val CONTACT_EMAIL = ServerConfigKey.string("contact_email", "") val DEFAULT_LOCALE = ServerConfigKey.string("default_locale", "en") + val PATREON_CONFIG = ServerConfigKey( + key = "patreon_config", + default = PatreonConfig(), + parse = { Json.decodeFromString(it) }, + serialize = { Json.encodeToString(PatreonConfig.serializer(), it) } + ) val SMTP_CONFIG = ServerConfigKey( key = "smtp_config", default = SmtpConfig(), diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepository.kt index ea09e9bd3..e7f71aa91 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepository.kt @@ -10,9 +10,18 @@ import kotlin.time.Instant class WhiteListRepository( private val whiteListDao: WhiteListDao, + private val configRepository: ConfigRepository, private val clock: Clock, ) : KoinComponent { + suspend fun useWhiteList(): Boolean { + return configRepository.get(AdminServerConfig.WHITELIST_ENABLED) + } + + suspend fun setWhiteListEnabled(enabled: Boolean) { + configRepository.set(AdminServerConfig.WHITELIST_ENABLED, enabled) + } + suspend fun getWhiteList(): List { return whiteListDao.getAllWhiteListedEmails() } @@ -29,33 +38,15 @@ class WhiteListRepository( return whiteListDao.getPaginated(limit, offset, sortOldestFirst) } - /** A blank [emailSearch] lists everything; otherwise only emails containing it. */ - suspend fun getWhiteListWithAccountStatus( - page: Int, - pageSize: Int, - sortOldestFirst: Boolean = false, - emailSearch: String? = null, - ) = if (emailSearch.isNullOrBlank()) { + suspend fun getWhiteListWithAccountStatus(page: Int, pageSize: Int, sortOldestFirst: Boolean = false) = whiteListDao.getPaginatedWithAccountStatus( limit = pageSize.toLong(), offset = (page * pageSize).toLong(), sortOldestFirst = sortOldestFirst ) - } else { - whiteListDao.searchPaginatedWithAccountStatus( - pattern = emailSearchPattern(emailSearch), - limit = pageSize.toLong(), - offset = (page * pageSize).toLong(), - sortOldestFirst = sortOldestFirst - ) - } - suspend fun getWhiteListCount(emailSearch: String? = null): Long { - return if (emailSearch.isNullOrBlank()) { - whiteListDao.getWhiteListCount() - } else { - whiteListDao.searchCount(emailSearchPattern(emailSearch)) - } + suspend fun getWhiteListCount(): Long { + return whiteListDao.getWhiteListCount() } /** False for an entry whose expiry has passed, even if the reaping job hasn't run yet. */ @@ -70,11 +61,6 @@ class WhiteListRepository( whiteListDao.addToWhiteList(cleanedEmail, clock.now(), reason, expires) } - /** Adds every non-deleted account to the list; existing entries keep their reason and expiry. */ - suspend fun backfillFromAccounts(reason: String = REASON_EXISTING_ACCOUNT) { - whiteListDao.backfillFromAccounts(clock.now(), reason) - } - suspend fun getEntry(email: String): WhiteList? { val cleanedEmail = cleanEmail(email) return whiteListDao.getByEmail(cleanedEmail) @@ -132,15 +118,5 @@ class WhiteListRepository( companion object { const val MAX_REASON_LENGTH = 32 - const val REASON_EXISTING_ACCOUNT = "Existing account" - - /** `%` and `_` are LIKE wildcards; an admin typing `a_b@` means those literally. */ - internal fun emailSearchPattern(raw: String): String { - val escaped = raw.trim() - .replace("\\", "\\\\") - .replace("%", "\\%") - .replace("_", "\\_") - return "%$escaped%" - } } } \ No newline at end of file diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/AccountDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/AccountDao.kt index e16384df6..2d0f9cd57 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/AccountDao.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/AccountDao.kt @@ -6,8 +6,8 @@ import com.darkrockstudios.apps.hammer.account.SortDirection import com.darkrockstudios.apps.hammer.account.UserSortField import com.darkrockstudios.apps.hammer.utilities.injectIoDispatcher import kotlinx.coroutines.withContext +import kotlinx.datetime.Instant import org.koin.core.component.KoinComponent -import kotlin.time.Instant class AccountDao( database: Database, @@ -98,7 +98,6 @@ class AccountDao( pen_name = it.pen_name, created = it.created, last_sync = it.last_sync, - deleted_at = it.deleted_at, most_recent_sync = it.most_recent_sync, project_count = it.project_count ) @@ -115,7 +114,6 @@ class AccountDao( pen_name = it.pen_name, created = it.created, last_sync = it.last_sync, - deleted_at = it.deleted_at, most_recent_sync = it.most_recent_sync, project_count = it.project_count ) @@ -123,20 +121,6 @@ class AccountDao( } } - suspend fun markDeleted(userId: Long, deletedAt: Instant) = withContext(ioDispatcher) { - queries.markDeleted(deletedAt = deletedAt, userId = userId) - } - - suspend fun restoreDeleted(userId: Long) = withContext(ioDispatcher) { - queries.restoreDeleted(userId) - } - - suspend fun getSoftDeletedBefore(cutoff: Instant): List = withContext(ioDispatcher) { - // The IS NOT NULL predicate narrows deleted_at in the generated row type, - // so map back to the plain Account shape. - queries.getSoftDeletedBefore(cutoff, ::Account).executeAsList() - } - suspend fun updatePassword(userId: Long, hashedPassword: String) = withContext(ioDispatcher) { queries.updatePassword(hashedPassword, userId) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/InstantColumnAdapter.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/InstantColumnAdapter.kt index af58fad14..2849a19f1 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/InstantColumnAdapter.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/InstantColumnAdapter.kt @@ -2,17 +2,17 @@ package com.darkrockstudios.apps.hammer.database import app.cash.sqldelight.ColumnAdapter import com.darkrockstudios.apps.hammer.utilities.coerceToStorableRange -import org.slf4j.LoggerFactory import java.time.OffsetDateTime import java.time.ZoneOffset import kotlin.time.Instant import kotlin.time.toJavaInstant import kotlin.time.toKotlinInstant +import org.slf4j.LoggerFactory /** * Adapts the JDBC Postgres `TIMESTAMPTZ` column type (`OffsetDateTime`) to * `kotlin.time.Instant` so DAOs and downstream code can stay in the - * kotlin.time world. + * kotlinx-datetime / kotlin.time world. */ internal object InstantColumnAdapter : ColumnAdapter { private val logger = LoggerFactory.getLogger(InstantColumnAdapter::class.java) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDao.kt index 8f601e277..556e47b10 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDao.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDao.kt @@ -13,7 +13,6 @@ data class PublicProjectInfo( val projectName: String, val penName: String, val expiresAt: Instant?, - val accessId: Long? = null, ) data class PublishedStoryInfo( @@ -34,7 +33,6 @@ class ProjectAccessDao( ) : KoinComponent { private val ioDispatcher by injectIoDispatcher() private val queries = database.serverDatabase.projectAccessQueries - private val sceneQueries = database.serverDatabase.projectAccessSceneQueries suspend fun getAccessForProject(projectId: Long): Project_access? = withContext(ioDispatcher) { queries.getAccessForProject(projectId).executeAsOneOrNull() @@ -72,69 +70,14 @@ class ProjectAccessDao( } } - /** - * Inserts a private share and its scene restriction atomically, or returns null when - * another live share of the project already uses [password]. The project row is - * locked for the transaction so two concurrent creates cannot both pass the check. - */ - suspend fun insertAccessWithScenes( - projectId: Long, - password: String?, - expiresAt: Instant?, - sceneIds: Collection, - now: Instant, - ): Long? = withContext(ioDispatcher) { - queries.transactionWithResult { - queries.lockProjectRow(projectId).executeAsOneOrNull() - val duplicate = password != null && - queries.findLiveAccessByPassword(projectId, password, now).executeAsOneOrNull() != null - if (duplicate) { - null - } else { - // RETURNING queries are lazy; executeAsOne() is what runs the INSERT. - val accessId = queries.insertAccessReturningId(projectId, password, expiresAt).executeAsOne() - sceneIds.forEach { sceneId -> - sceneQueries.insertScene(accessId, sceneId) - } - accessId - } - } - } - - suspend fun getSceneIdsForAccess(accessId: Long): List = withContext(ioDispatcher) { - sceneQueries.getSceneIdsForAccess(accessId).executeAsList() - } - - suspend fun getSceneIdsForAccessIds(accessIds: Collection): Map> = - withContext(ioDispatcher) { - if (accessIds.isEmpty()) return@withContext emptyMap() - sceneQueries.getSceneIdsForAccessIds(accessIds).executeAsList() - .groupBy({ it.access_id }, { it.scene_id }) - .mapValues { (_, ids) -> ids.toSet() } - } - suspend fun deleteAccess(projectId: Long) { withContext(ioDispatcher) { - queries.transaction { - // Children first, matching deleteAccessById: the explicit delete backs up - // the cascade because tests disable FK enforcement. - sceneQueries.deleteForProject(projectId) - queries.deleteAccess(projectId) - } + queries.deleteAccess(projectId) } } suspend fun deleteAccessById(accessId: Long, projectId: Long): Boolean = withContext(ioDispatcher) { - queries.transactionWithResult { - // Parent first: the project_id scoping is the authorization check, and - // scene rows must only go once it has passed. The explicit child delete - // backs up the cascade because tests disable FK enforcement. - val deleted = queries.deleteAccessById(accessId, projectId).executeAsOneOrNull() != null - if (deleted) { - sceneQueries.deleteForAccess(accessId) - } - deleted - } + queries.deleteAccessById(accessId, projectId).executeAsOneOrNull() != null } suspend fun deletePublicAccessForProject(projectId: Long) { @@ -145,10 +88,7 @@ class ProjectAccessDao( suspend fun deleteAllAccessForUser(userId: Long) { withContext(ioDispatcher) { - queries.transaction { - sceneQueries.deleteAllForUser(userId) - queries.deleteAllAccessForUser(userId) - } + queries.deleteAllAccessForUser(userId) } } @@ -188,10 +128,9 @@ class ProjectAccessDao( suspend fun findProjectByPenNameProjectNameAndPassword( penName: String, projectName: String, - password: String, - now: Instant, + password: String ): PublicProjectInfo? = withContext(ioDispatcher) { - queries.findProjectByPenNameProjectNameAndPassword(penName, projectName, password, now) + queries.findProjectByPenNameProjectNameAndPassword(penName, projectName, password) .executeAsOneOrNull() ?.let { PublicProjectInfo( @@ -199,8 +138,7 @@ class ProjectAccessDao( userId = it.user_id, projectName = it.project_name, penName = it.pen_name ?: "", - expiresAt = it.expires_at, - accessId = it.access_id, + expiresAt = it.expires_at ) } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDao.kt index c7491d959..6463e774a 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDao.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDao.kt @@ -7,16 +7,8 @@ import com.darkrockstudios.apps.hammer.project.ProjectDefinition import com.darkrockstudios.apps.hammer.utilities.injectIoDispatcher import kotlinx.coroutines.withContext import org.koin.core.component.KoinComponent -import java.sql.SQLException import kotlin.time.Instant -private const val SQLSTATE_UNIQUE_VIOLATION = "23505" - -// The cause chain is walked because the driver's violation can reach us wrapped by the pool. -private fun SQLException.isUniqueViolation(): Boolean = - generateSequence(this as Throwable) { it.cause } - .any { it is SQLException && it.sqlState == SQLSTATE_UNIQUE_VIOLATION } - class ProjectDao( database: Database, ) : KoinComponent { @@ -72,18 +64,12 @@ class ProjectDao( queries.hasProjectById(userId, projectId.id).executeAsOne() } - /** False when the account already has a project under [newName]; `project(name, user_id)` is unique. */ suspend fun updateProjectName( userId: Long, projectUuid: ProjectId, newName: String - ): Boolean = withContext(ioDispatcher) { - return@withContext try { - queries.updateProjectName(userId = userId, uuid = projectUuid.id, name = newName) - true - } catch (e: SQLException) { - if (e.isUniqueViolation()) false else throw e - } + ) = withContext(ioDispatcher) { + queries.updateProjectName(userId = userId, uuid = projectUuid.id, name = newName) } suspend fun updateSyncData( diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDataDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDataDao.kt index 8394cbee0..e7d3ca6d5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDataDao.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ProjectDataDao.kt @@ -19,11 +19,6 @@ class ProjectDataDao( ?.let { ProjectDataRow(content = it.content, hash = it.hash, updatedAt = it.updated_at) } } - suspend fun getHash(userId: Long, projectId: Long): String? = - withContext(ioDispatcher) { - queries.getHashForProject(userId, projectId).executeAsOneOrNull() - } - suspend fun upsert( userId: Long, projectId: Long, diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ServerDatabaseFactory.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ServerDatabaseFactory.kt index 1862709a8..ae0e9adbd 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ServerDatabaseFactory.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/ServerDatabaseFactory.kt @@ -31,7 +31,6 @@ fun buildServerDatabase(driver: SqlDriver): ServerDatabase { accountAdapter = Account.Adapter( createdAdapter = instant, last_syncAdapter = instant, - deleted_atAdapter = instant, ), auth_tokenAdapter = Auth_token.Adapter( createdAdapter = instant, diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/StoryKudosDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/StoryKudosDao.kt deleted file mode 100644 index 68b92ff0f..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/StoryKudosDao.kt +++ /dev/null @@ -1,63 +0,0 @@ -package com.darkrockstudios.apps.hammer.database - -import app.cash.sqldelight.db.QueryResult -import com.darkrockstudios.apps.hammer.utilities.injectIoDispatcher -import kotlinx.coroutines.withContext -import org.koin.core.component.KoinComponent - -open class StoryKudosDao( - database: Database, -) : KoinComponent { - - private val ioDispatcher by injectIoDispatcher() - private val queries = database.serverDatabase.storyKudosQueries - private val driver = database.driver - - open suspend fun kindsForUser(projectId: Long, userId: Long): Set = withContext(ioDispatcher) { - queries.kindsForUser(projectId, userId).executeAsList().toSet() - } - - /** Makes [kinds] the giver's exact set of picks for the story. */ - open suspend fun replacePicks(projectId: Long, userId: Long, kinds: Set): Unit = - withContext(ioDispatcher) { - queries.transaction { - lockGiver(userId) - val existing = queries.kindsForUser(projectId, userId).executeAsList().toSet() - val removed = existing - kinds - if (removed.isNotEmpty()) queries.deleteKinds(projectId, userId, removed) - (kinds - existing).forEach { queries.insertKudos(projectId, userId, it) } - } - } - - /** - * Serializes one giver's concurrent updates so the per-group caps hold. Advisory rather than - * a row lock so the giver's other writes never wait; issued raw because SQLDelight's - * Postgres dialect can't parse the call. - */ - private fun lockGiver(userId: Long) { - driver.executeQuery( - identifier = null, - sql = "SELECT pg_advisory_xact_lock(hashtextextended('story_kudos', ?))", - mapper = { QueryResult.Value(Unit) }, - parameters = 1, - ) { bindLong(0, userId) } - } - - open suspend fun countsForProject(projectId: Long, kinds: Collection): Map = - withContext(ioDispatcher) { - queries.countsForProject(projectId, kinds).executeAsList().associate { it.kind to it.givers } - } - - open suspend fun giverCountForProject(projectId: Long, kinds: Collection): Long = - withContext(ioDispatcher) { - queries.giverCountForProject(projectId, kinds).executeAsOne() - } - - open suspend fun isOptedOut(projectId: Long): Boolean = withContext(ioDispatcher) { - queries.isOptedOut(projectId).executeAsOne() - } - - open suspend fun setOptedOut(projectId: Long, optedOut: Boolean): Unit = withContext(ioDispatcher) { - if (optedOut) queries.optOut(projectId) else queries.optIn(projectId) - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDao.kt deleted file mode 100644 index 5a7d1be0e..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDao.kt +++ /dev/null @@ -1,69 +0,0 @@ -package com.darkrockstudios.apps.hammer.database - -import com.darkrockstudios.apps.hammer.utilities.injectIoDispatcher -import kotlinx.coroutines.withContext -import org.koin.core.component.KoinComponent - -/** - * Hard-deletes every row belonging to one account, for the final stage of - * account deletion. Deletes run child-tables-first in a single transaction, - * explicitly rather than relying on ON DELETE CASCADE, because tests disable - * FK enforcement. - */ -class UserDataPurgeDao( - database: Database, -) : KoinComponent { - - private val ioDispatcher by injectIoDispatcher() - private val db = database.serverDatabase - - /** - * Returns false without deleting anything when the account no longer exists - * or is no longer soft-deleted: a restore that lands after the retention job - * snapshotted its due batch must win over the purge. - */ - suspend fun purgeUserData(userId: Long): Boolean = withContext(ioDispatcher) { - db.accountQueries.transactionWithResult { - // Row-locked so a concurrent restore serializes against this transaction. - val account = db.accountQueries.getAccountForUpdate(userId).executeAsOneOrNull() - if (account?.deleted_at == null) return@transactionWithResult false - - // Review tree (suggestion -> scene -> request). - db.reviewSuggestionQueries.deleteAllForUser(userId) - db.reviewSceneQueries.deleteAllForUser(userId) - db.reviewRequestQueries.deleteAllForUser(userId) - - // Kudos this user gave on other authors' stories. - db.storyKudosQueries.deleteAllGivenByUser(userId) - - // Everything hanging off the user's projects. - db.storyKudosQueries.deleteAllOnUserProjects(userId) - db.storyKudosQueries.deleteAllOptOutsForUser(userId) - db.publishedStoryReaderQueries.deleteAllForUser(userId) - db.publishedStoryReaderQueries.deleteAllTotalsForUser(userId) - db.deletedEntityQueries.deleteAllForUser(userId) - db.projectAccessSceneQueries.deleteAllForUser(userId) - db.projectAccessQueries.deleteAllAccessForUser(userId) - db.storyEntityQueries.deleteAllForUser(userId) - db.projectDataQueries.deleteAllForUser(userId) - db.writingActivityQueries.deleteAllForUser(userId) - db.projectQueries.deleteAllForUser(userId) - - // Account-scoped data. - db.storyIdeaQueries.deleteAllForUser(userId) - db.deletedIdeaQueries.deleteAllForUser(userId) - db.deletedProjectQueries.deleteAllForUser(userId) - db.userActivityQueries.deleteAllForUser(userId) - db.authTokenQueries.deleteByUserId(userId) - db.passwordResetTokenQueries.deleteAllForUser(userId) - - // No-FK tables that would otherwise keep dangling references. - // login_attempt rows are keyed by lower-cased email rather than user id. - db.errorLogQueries.deleteAllForUser(userId) - db.loginAttemptQueries.deleteAllForEmail(account.email.lowercase()) - - db.accountQueries.hardDeleteAccount(userId) - true - } - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/WhiteListDao.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/WhiteListDao.kt index 89d9e41a7..3610f2330 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/WhiteListDao.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/database/WhiteListDao.kt @@ -27,10 +27,6 @@ open class WhiteListDao( queries.addToWhiteList(email, dateAdded, reason, expires) } - open suspend fun backfillFromAccounts(now: Instant, reason: String): Unit = withContext(ioDispatcher) { - queries.backfillFromAccounts(now, reason) - } - open suspend fun removeFromWhiteList(email: String): Unit = withContext(ioDispatcher) { queries.removeFromWhiteList(email) } @@ -68,37 +64,20 @@ open class WhiteListDao( ): List = withContext(ioDispatcher) { return@withContext if (sortOldestFirst) { - queries.getPaginatedWithAccountStatusOldestFirst( - limit, offset, ::GetPaginatedWithAccountStatus - ).executeAsList() + queries.getPaginatedWithAccountStatusOldestFirst(limit, offset).executeAsList().map { + GetPaginatedWithAccountStatus( + email = it.email, + date_added = it.date_added, + reason = it.reason, + expires = it.expires, + has_account = it.has_account + ) + } } else { queries.getPaginatedWithAccountStatus(limit, offset).executeAsList() } } - /** [pattern] is a LIKE pattern; see `WhiteListRepository.emailSearchPattern`. */ - open suspend fun searchPaginatedWithAccountStatus( - pattern: String, - limit: Long, - offset: Long, - sortOldestFirst: Boolean = false - ): List = - withContext(ioDispatcher) { - return@withContext if (sortOldestFirst) { - queries.searchPaginatedWithAccountStatusOldestFirst( - pattern, limit, offset, ::GetPaginatedWithAccountStatus - ).executeAsList() - } else { - queries.searchPaginatedWithAccountStatus( - pattern, limit, offset, ::GetPaginatedWithAccountStatus - ).executeAsList() - } - } - - open suspend fun searchCount(pattern: String): Long = withContext(ioDispatcher) { - return@withContext queries.searchCount(pattern).executeAsOne() - } - open suspend fun getByEmail(email: String): WhiteList? = withContext(ioDispatcher) { return@withContext queries.getByEmail(email).executeAsOneOrNull() } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigrator.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigrator.kt index 7aaf71e59..7d7804fca 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigrator.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigrator.kt @@ -1,38 +1,25 @@ package com.darkrockstudios.apps.hammer.datamigrator -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.ServerConfigKey +import com.darkrockstudios.apps.hammer.database.Database import com.darkrockstudios.apps.hammer.datamigrator.migrations.DataMigration /** - * Runs ordered, one-time data migrations against an already-initialized database - * at startup. Each migration runs exactly once per server: a completion marker in - * `server_config` guards re-runs, so a migration is never re-applied on later - * boots. A migration failure propagates and aborts startup. - * - * Schema versioning lives in `PostgresSchemaInitializer`, and the one-shot - * SQLite-to-Postgres data migration has its own dedicated entry point in - * [com.darkrockstudios.apps.hammer.database.migration.SqliteToPostgresMigrator]. + * Runs ordered, idempotent data migrations against an already-initialized + * [Database]. The legacy SQLite-flavored hooks (`PRAGMA user_version`, + * `PRAGMA foreign_keys`) are gone — schema versioning lives in + * `PostgresSchemaInitializer` now, and the one-shot SQLite-to-Postgres data + * migration has its own dedicated entry point in [com.darkrockstudios.apps.hammer.database.migration.SqliteToPostgresMigrator]. */ class DataMigrator( - private val configRepository: ConfigRepository, + private val database: Database, ) { private val migrations = mutableListOf() - fun addMigration(migration: DataMigration) { + private fun addMigration(migration: DataMigration) { migrations.add(migration) } suspend fun runMigrations() { - migrations.forEach { migration -> - val marker = markerKey(migration.id) - if (configRepository.get(marker).not()) { - migration.migrate() - configRepository.set(marker, true) - } - } + migrations.forEach { it.migrate() } } - - private fun markerKey(id: String): ServerConfigKey = - ServerConfigKey.boolean("datamigration_${id}_complete", false) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/AllowedUsersBackfillMigration.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/AllowedUsersBackfillMigration.kt deleted file mode 100644 index 43352d3ef..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/AllowedUsersBackfillMigration.kt +++ /dev/null @@ -1,32 +0,0 @@ -package com.darkrockstudios.apps.hammer.datamigrator.migrations - -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.ServerConfigKey -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository - -/** - * Seeds the allowed users list with every existing, non-deleted account so servers - * upgrading from the optional-whitelist era don't lock out their users. - * - * Only runs when the server had explicitly disabled the old whitelist. On an - * enforcing server everyone active was already on the list, and a missing entry - * there means access was deliberately revoked (expired invite, lapsed patron, - * manual removal); backfilling would silently undo those revocations. - */ -class AllowedUsersBackfillMigration( - private val whiteListRepository: WhiteListRepository, - private val configRepository: ConfigRepository, -) : DataMigration { - override val id = "allowedusers_backfill" - - override suspend fun migrate() { - if (configRepository.get(LEGACY_WHITELIST_ENABLED).not()) { - whiteListRepository.backfillFromAccounts() - } - } - - companion object { - /** The removed toggle's row survives in server_config; it defaulted to enabled. */ - private val LEGACY_WHITELIST_ENABLED = ServerConfigKey.boolean("whitelist_enabled", true) - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/DataMigration.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/DataMigration.kt index 818b6fd04..722e708dc 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/DataMigration.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/datamigrator/migrations/DataMigration.kt @@ -1,8 +1,5 @@ package com.darkrockstudios.apps.hammer.datamigrator.migrations interface DataMigration { - /** Stable unique id; forms the one-time completion marker key, so never rename it. */ - val id: String - suspend fun migrate() } \ No newline at end of file diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/dependencyinjection/mainModule.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/dependencyinjection/mainModule.kt index d3572a7fd..cea8b9ea5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/dependencyinjection/mainModule.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/dependencyinjection/mainModule.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.dependencyinjection import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.StorageMode -import com.darkrockstudios.apps.hammer.account.AccountDeletionJob -import com.darkrockstudios.apps.hammer.account.AccountDeletionService import com.darkrockstudios.apps.hammer.account.AccountsComponent import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.account.BioService @@ -41,13 +39,9 @@ import com.darkrockstudios.apps.hammer.database.ReviewSuggestionDao import com.darkrockstudios.apps.hammer.database.ServerConfigDao import com.darkrockstudios.apps.hammer.database.StoryEntityDao import com.darkrockstudios.apps.hammer.database.StoryIdeaDao -import com.darkrockstudios.apps.hammer.database.StoryKudosDao import com.darkrockstudios.apps.hammer.database.UserActivityDao -import com.darkrockstudios.apps.hammer.database.UserDataPurgeDao import com.darkrockstudios.apps.hammer.database.WhiteListDao import com.darkrockstudios.apps.hammer.database.WritingActivityDao -import com.darkrockstudios.apps.hammer.datamigrator.DataMigrator -import com.darkrockstudios.apps.hammer.datamigrator.migrations.AllowedUsersBackfillMigration import com.darkrockstudios.apps.hammer.email.EmailProvider import com.darkrockstudios.apps.hammer.email.EmailService import com.darkrockstudios.apps.hammer.email.MailgunEmailService @@ -66,7 +60,6 @@ import com.darkrockstudios.apps.hammer.encryption.SimpleFileBasedAesGcmKeyProvid import com.darkrockstudios.apps.hammer.frontend.CommunityStatsProvider import com.darkrockstudios.apps.hammer.frontend.og.OgImageRenderer import com.darkrockstudios.apps.hammer.frontend.og.OgImageService -import com.darkrockstudios.apps.hammer.kudos.StoryKudosRepository import com.darkrockstudios.apps.hammer.monitoring.ErrorRepository import com.darkrockstudios.apps.hammer.monitoring.MetricsCollector import com.darkrockstudios.apps.hammer.monitoring.MetricsRepository @@ -77,6 +70,10 @@ import com.darkrockstudios.apps.hammer.monitoring.StoryReaderCollector import com.darkrockstudios.apps.hammer.monitoring.StoryReaderRepository import com.darkrockstudios.apps.hammer.monitoring.UserActivityCollector import com.darkrockstudios.apps.hammer.monitoring.UserActivityRepository +import com.darkrockstudios.apps.hammer.patreon.PatreonApiClient +import com.darkrockstudios.apps.hammer.patreon.PatreonPollingJob +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService +import com.darkrockstudios.apps.hammer.patreon.PatreonWebhookHandler import com.darkrockstudios.apps.hammer.project.ProjectEntityDatabaseDatasource import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource import com.darkrockstudios.apps.hammer.project.ProjectEntityRepository @@ -180,8 +177,6 @@ fun mainModule( single() single() single() - single() - single() single() single() @@ -194,11 +189,6 @@ fun mainModule( single { ServerIdeasRepository(get(), get(), get(), get(), get(), get(), get()) } single() single() - single { - DataMigrator(get()).apply { - addMigration(AllowedUsersBackfillMigration(get(), get())) - } - } single() single() single() @@ -210,13 +200,11 @@ fun mainModule( // make Koin try to inject the Int rather than honor it. single { StoryReaderCollector(clock = get()) } single() - single() single { MonitoringState() } single { RecurringTaskRegistry() } single() single() single() - single() single() single { val cacheConfig = get().cache @@ -241,18 +229,6 @@ fun mainModule( single { StoryRendererService(get(), get(), get()) } single() single() - // Explicit ctor: the two sync managers are named qualifiers. - single { - AccountDeletionService( - accountsRepository = get(), - penNameService = get(), - whiteListRepository = get(), - userDataPurgeDao = get(), - projectsSyncManager = get(named(PROJECTS_SYNC_MANAGER)), - projectSyncManager = get(named(PROJECT_SYNC_MANAGER)), - clock = get(), - ) - } single() single() @@ -300,6 +276,10 @@ fun mainModule( single() single() + single() + single() + single() + single() single() single() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/AboutPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/AboutPage.kt index a0dcbcdb6..87367d3c3 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/AboutPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/AboutPage.kt @@ -35,11 +35,9 @@ fun Route.aboutPage( model["aboutHtml"] = aboutHtml // The whitelist half of the band belongs with the signup CTA on the home page. - val serverMessageHtml = markdownService.markdownToSafeHtml( - configRepository.get(AdminServerConfig.SERVER_MESSAGE) - ) - model["serverMessageHtml"] = serverMessageHtml - model["hasInstanceNotice"] = serverMessageHtml.isNotBlank() + val serverMessage = configRepository.get(AdminServerConfig.SERVER_MESSAGE) + model["serverMessage"] = serverMessage + model["hasInstanceNotice"] = serverMessage.isNotBlank() model["title"] = "${call.msg("about_page_title")} — Hammer" metaDescription(aboutMarkdown)?.let { model["metaDescription"] = it } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/DashboardPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/DashboardPage.kt index 4c360f6a5..7f789c744 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/DashboardPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/DashboardPage.kt @@ -1,12 +1,10 @@ package com.darkrockstudios.apps.hammer.frontend import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.account.AccountDeletionService import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.account.BioService import com.darkrockstudios.apps.hammer.account.PenNameService import com.darkrockstudios.apps.hammer.account.PenNameService.PenNameResult -import com.darkrockstudios.apps.hammer.frontend.data.UserSession import com.darkrockstudios.apps.hammer.frontend.utils.ProjectName import com.darkrockstudios.apps.hammer.frontend.utils.Toast import com.darkrockstudios.apps.hammer.frontend.utils.authenticatedOnly @@ -19,7 +17,6 @@ import com.darkrockstudios.apps.hammer.frontend.utils.respondTemplateWithToast import com.darkrockstudios.apps.hammer.frontend.utils.respondToast import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.utilities.MarkdownService -import com.darkrockstudios.apps.hammer.utilities.isSuccess import io.ktor.htmx.HxResponseHeaders import io.ktor.http.ContentType import io.ktor.http.HttpStatusCode @@ -35,7 +32,6 @@ import io.ktor.server.routing.delete import io.ktor.server.routing.get import io.ktor.server.routing.post import io.ktor.server.routing.route -import io.ktor.server.sessions.clear import io.ktor.server.sessions.sessions import kotlinx.serialization.Serializable import kotlinx.serialization.json.Json @@ -46,7 +42,6 @@ fun Route.dashboardPage( accountsRepository: AccountsRepository, penNameService: PenNameService, bioService: BioService, - accountDeletionService: AccountDeletionService, serverConfig: ServerConfig, markdownService: MarkdownService ) { @@ -297,54 +292,6 @@ fun Route.dashboardPage( ) } - hx.get("/delete-account-dialog") { - val session = call.sessions.requireUser() - val account = accountsRepository.getAccount(session.userId) - - val model = call.withDefaults( - mapOf( - "email" to account.email, - "projectCount" to projectsRepository.getProjectsCount(session.userId), - "retentionNote" to call.msg( - "account_delete_dialog_retention_note", - serverConfig.accountDeletion.retentionDays - ), - ) - ) - - call.respond(MustacheContent("partials/delete-account-dialog.mustache", model)) - } - - hx.post("/delete-account") { - val session = call.sessions.requireUser() - val account = accountsRepository.getAccount(session.userId) - val typedEmail = call.receiveParameters()["confirmEmail"]?.trim() ?: "" - - // The JS arming of the button is UX only; the typed email is the - // real confirmation and must be verified here. - if (!typedEmail.equals(account.email, ignoreCase = true)) { - respondToast( - call.msg("account_delete_error_email_mismatch"), - Toast.Error, - HttpStatusCode.BadRequest - ) - return@post - } - - val result = accountDeletionService.softDelete(session.userId) - if (isSuccess(result)) { - call.sessions.clear() - call.response.header(HxResponseHeaders.Redirect, "/") - call.respond(HttpStatusCode.NoContent) - } else { - respondToast( - result.displayMessageText(call) ?: call.msg("account_delete_error_generic"), - Toast.Error, - HttpStatusCode.BadRequest - ) - } - } - hx.post("/community/leave") { if (!serverConfig.communityEnabled) { respondHtmlWithToast( diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/Frontend.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/Frontend.kt index 6dac38c2e..c68bfa417 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/Frontend.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/Frontend.kt @@ -2,7 +2,6 @@ package com.darkrockstudios.apps.hammer.frontend import com.darkrockstudios.apps.hammer.ExtraLink import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.account.AccountDeletionService import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.account.BioService import com.darkrockstudios.apps.hammer.account.PasswordResetRepository @@ -22,7 +21,6 @@ import com.darkrockstudios.apps.hammer.frontend.utils.canonicalUrl import com.darkrockstudios.apps.hammer.frontend.utils.localizedMsg import com.darkrockstudios.apps.hammer.frontend.utils.msg import com.darkrockstudios.apps.hammer.frontend.utils.withMessages -import com.darkrockstudios.apps.hammer.kudos.StoryKudosRepository import com.darkrockstudios.apps.hammer.monitoring.ActivityType import com.darkrockstudios.apps.hammer.monitoring.ErrorRepository import com.darkrockstudios.apps.hammer.monitoring.MetricsRepository @@ -35,9 +33,7 @@ import com.darkrockstudios.apps.hammer.monitoring.UserActivityRepository import com.darkrockstudios.apps.hammer.monitoring.isClientAbort import com.darkrockstudios.apps.hammer.monitoring.recordMonitoredError import com.darkrockstudios.apps.hammer.monitoring.toMonitoredStatus -import com.darkrockstudios.apps.hammer.plugin.NoticeSlot -import com.darkrockstudios.apps.hammer.plugin.pluginAdminNav -import com.darkrockstudios.apps.hammer.plugin.putAllowedUsersNotice +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService import com.darkrockstudios.apps.hammer.plugins.configureTemplating import com.darkrockstudios.apps.hammer.project.ProjectSyncKey import com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession @@ -81,8 +77,6 @@ import kotlin.time.Duration.Companion.days fun Route.frontend() { val accountsRepository: AccountsRepository by inject() - val accountsComponent: com.darkrockstudios.apps.hammer.account.AccountsComponent by inject() - val termsOfServiceRepository: com.darkrockstudios.apps.hammer.account.TermsOfServiceRepository by inject() val whiteListRepository: WhiteListRepository by inject() val configRepository: ConfigRepository by inject() val projectsRepository: ProjectsRepository by inject() @@ -90,7 +84,6 @@ fun Route.frontend() { val projectAccessRepository: ProjectAccessRepository by inject() val penNameService: PenNameService by inject() val bioService: BioService by inject() - val accountDeletionService: AccountDeletionService by inject() val serverConfig: ServerConfig by inject() val passwordResetRepository: PasswordResetRepository by inject() val markdownService: MarkdownService by inject() @@ -102,13 +95,17 @@ fun Route.frontend() { val userActivityRepository: UserActivityRepository by inject() val storyReaderRepository: StoryReaderRepository by inject() val storyReaderCollector: StoryReaderCollector by inject() - val storyKudosRepository: StoryKudosRepository by inject() - val serverProjectDataRepository: com.darkrockstudios.apps.hammer.project.ServerProjectDataRepository by inject() val recurringTaskRegistry: com.darkrockstudios.apps.hammer.scheduling.RecurringTaskRegistry by inject() val clock: kotlin.time.Clock by inject() val projectsSyncManager: SyncSessionManager by inject(named(PROJECTS_SYNC_MANAGER)) val projectSyncManager: SyncSessionManager by inject(named(PROJECT_SYNC_MANAGER)) + // Only inject PatreonSyncService if Patreon is enabled at server level + val patreonSyncService: PatreonSyncService? = if (serverConfig.patreonEnabled == true) { + inject().value + } else { + null + } // Only inject EmailService if email is enabled at server level val emailService: EmailService? = if (serverConfig.emailProviderType != null) { @@ -124,37 +121,21 @@ fun Route.frontend() { robotsRoutes() sitemapRoutes(serverConfig, accountsRepository, projectAccessRepository, configRepository) setupPage(serverConfig) - homePage(configRepository, markdownService) + homePage(whiteListRepository, configRepository, serverConfig) aboutPage(configRepository, serverConfig, accountsRepository, projectAccessRepository, markdownService) termsOfServicePage() privacyPolicyPage() localeRoutes() - authRoutes(accountsRepository, whiteListRepository, configRepository, securityRepository) - signupPage( - accountsComponent, - accountsRepository, - whiteListRepository, - termsOfServiceRepository, - configRepository, - securityRepository, - ) + authRoutes(accountsRepository, whiteListRepository, configRepository, serverConfig) passwordResetRoutes(passwordResetRepository) - dashboardPage( - projectsRepository, - accountsRepository, - penNameService, - bioService, - accountDeletionService, - serverConfig, - markdownService, - ) + dashboardPage(projectsRepository, accountsRepository, penNameService, bioService, serverConfig, markdownService) storyPage( storyRendererService, projectAccessRepository, projectsRepository, accountsRepository, reviewRepository, - storyReaderRepository, storyKudosRepository, serverProjectDataRepository, projectDao, clock, + storyReaderRepository, projectDao, clock, ) reviewFrontend( reviewRepository = reviewRepository, @@ -175,16 +156,8 @@ fun Route.frontend() { storyReaderCollector, accountsRepository, projectsRepository, - serverProjectDataRepository, serverConfig, ) - storyKudosRoutes( - accountsRepository, - projectsRepository, - projectAccessRepository, - projectDao, - storyKudosRepository, - ) if (serverConfig.richLinkPreviews) { val ogImageService by inject() ogImageRoutes(accountsRepository, projectAccessRepository, ogImageService) @@ -194,8 +167,8 @@ fun Route.frontend() { configRepository, accountsRepository, projectsRepository, - accountDeletionService, serverConfig, + patreonSyncService, emailService, metricsRepository, errorRepository, @@ -278,10 +251,9 @@ fun Application.configureStatusPages( } } status(HttpStatusCode.Unauthorized) { call, status -> - // API routes answer 401 with their own HttpResponseError body; responding again - // here would replace it with an empty one, leaving the client no way to tell a - // wrong password from an unknown account or an expired token. - if (!call.request.isApiCall()) { + if (call.request.isApiCall()) { + call.respond(HttpStatusCode.Unauthorized) + } else { call.respond( HttpStatusCode.Unauthorized, MustacheContent("unauthorized.mustache", call.withDefaults(ERROR_PAGE_STYLE)) @@ -336,13 +308,11 @@ fun AuthenticationConfig.frontendAuthentication(accountRepo: AccountsRepository, } /** - * Whether [session] should reach protected pages: the account must exist, not be - * pending deletion, and either be an admin or be on the allowed users list. - * Admin status is read from the account row, not the cookie, so a revoked - * admin can't ride a stale session past the gate; the deletion check precedes the - * admin allowance for the same reason. Must match the redirect gate in the login - * page: if the two disagree, a logged-in but unauthorized user loops between - * /login and /dashboard. + * Whether [session] should reach whitelist-protected pages: the account must exist + * and either be an admin or, when the whitelist is active, be on it. Admin status is + * read from the account row, not the cookie, so a revoked admin can't ride a stale + * session past the gate. Must match the redirect gate in the login page — if the two + * disagree, a logged-in but unauthorized user loops between /login and /dashboard. */ suspend fun sessionIsAuthorized( session: UserSession, @@ -352,9 +322,9 @@ suspend fun sessionIsAuthorized( val account = runCatching { accountRepo.getAccount(session.userId) }.getOrNull() return when { account == null -> false - account.deleted_at != null -> false account.is_admin -> true - else -> whitelistRepo.isOnWhiteList(account.email) + whitelistRepo.useWhiteList() -> whitelistRepo.isOnWhiteList(account.email) + else -> true } } @@ -391,13 +361,6 @@ suspend fun ApplicationCall.withDefaults(data: Map = emptyMap()): M val serverConfig = get() - // Only admin templates render the admin-nav partial that consumes these. - if (request.path().startsWith("/admin")) { - // Not putIfAbsent: the argument would compute the nav even when the key is present. - if ("pluginNavEntries" !in model) model["pluginNavEntries"] = pluginAdminNav() - model.putIfAbsent("emailFeatureEnabled", serverConfig.emailProviderType != null) - } - val configRepository = get() val aboutContent = configRepository.get(AdminServerConfig.ABOUT_SERVER) val hasAboutPage = aboutContent.isNotBlank() @@ -416,7 +379,13 @@ suspend fun ApplicationCall.withDefaults(data: Map = emptyMap()): M model["footerExtraLinks"] = footerExtraLinks model["hasFooterNav"] = hasAboutPage || hasTermsPage || hasPrivacyPage || footerExtraLinks.isNotEmpty() - putAllowedUsersNotice(model, NoticeSlot.FOOTER, htmlKey = "footerNoticeHtml", providedKey = "footerNoticeProvided") + // Add Patreon link for footer if configured + if (serverConfig.patreonEnabled == true) { + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + if (patreonConfig.enabled && patreonConfig.patreonUrl.isNotBlank()) { + model["patreonUrl"] = patreonConfig.patreonUrl + } + } // Add community enabled flag for header nav if (serverConfig.communityEnabled) { diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePage.kt index 9220bfcb7..3c7da07db 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePage.kt @@ -1,13 +1,12 @@ package com.darkrockstudios.apps.hammer.frontend +import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.admin.AdminServerConfig import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.frontend.utils.canonicalUrl import com.darkrockstudios.apps.hammer.frontend.utils.msg import com.darkrockstudios.apps.hammer.frontend.utils.webSiteJsonLd -import com.darkrockstudios.apps.hammer.utilities.MarkdownService -import com.darkrockstudios.apps.hammer.plugin.NoticeSlot -import com.darkrockstudios.apps.hammer.plugin.putAllowedUsersNotice import io.ktor.server.mustache.* import io.ktor.server.response.* import io.ktor.server.routing.* @@ -33,45 +32,39 @@ private val MASTHEAD_PRELOADS = listOf( ), ) -/** Must match the App Store links in home.mustache. Drives the iOS Safari smart app banner. */ -private const val IOS_APP_STORE_ID = "6770841038" - fun Route.homePage( + whiteListRepository: WhiteListRepository, configRepository: ConfigRepository, - markdownService: MarkdownService, + serverConfig: ServerConfig, ) { route("/") { get { val model = call.withDefaults() model["page_stylesheet"] = "/assets/css/home.css" model["preloadImages"] = MASTHEAD_PRELOADS - val serverMessageHtml = markdownService.markdownToSafeHtml( - configRepository.get(AdminServerConfig.SERVER_MESSAGE) - ) + val useWhiteList = whiteListRepository.useWhiteList() + val serverMessage = configRepository.get(AdminServerConfig.SERVER_MESSAGE) val contactEmail = configRepository.get(AdminServerConfig.CONTACT_EMAIL) - val bannerNotice = call.putAllowedUsersNotice( - model, NoticeSlot.HOME_BANNER, - htmlKey = "allowedUsersBannerHtml", providedKey = "allowedUsersBannerProvided", - ) + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val patreonFeatureEnabled = serverConfig.patreonEnabled == true + val patreonActive = patreonFeatureEnabled && patreonConfig.enabled && patreonConfig.patreonUrl.isNotBlank() - model["serverMessageHtml"] = serverMessageHtml + model["serverMessage"] = serverMessage model["page_script"] = "/assets/js/home.js" model["title"] = "Hammer — ${call.msg("home_meta_tagline")}" model["metaDescription"] = call.msg("home_meta_description") - model["iosAppStoreId"] = IOS_APP_STORE_ID model["jsonLd"] = webSiteJsonLd( name = "Hammer", url = call.canonicalUrl("/"), description = call.msg("home_meta_description"), ) - val showAllowedUsersNotice = contactEmail.isNotBlank() && bannerNotice == null - if (showAllowedUsersNotice) { - model["allowedUsersNotice"] = true - call.msg(model, "home_servermessage_allowedusers", contactEmail) + val showWhitelist = useWhiteList && contactEmail.isNotBlank() && !patreonActive + if (showWhitelist) { + model["whitelistEnabled"] = true + call.msg(model, "home_servermessage_whitelist", contactEmail) } - model["hasInstanceNotice"] = - serverMessageHtml.isNotBlank() || showAllowedUsersNotice || !bannerNotice.isNullOrBlank() + model["hasInstanceNotice"] = serverMessage.isNotBlank() || showWhitelist call.respond(MustacheContent("home.mustache", model)) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/LoginPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/LoginPage.kt index 0274a15ee..f86881326 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/LoginPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/LoginPage.kt @@ -1,21 +1,15 @@ package com.darkrockstudios.apps.hammer.frontend +import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.admin.AdminServerConfig import com.darkrockstudios.apps.hammer.admin.ConfigRepository import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.monitoring.SecurityRepository -import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT import com.darkrockstudios.apps.hammer.utilities.isSuccess -import com.darkrockstudios.apps.hammer.plugin.NoticeSlot -import com.darkrockstudios.apps.hammer.plugin.activeAllowedUsersSource -import com.darkrockstudios.apps.hammer.plugin.putAllowedUsersNotice import com.github.aymanizz.ktori18n.R import com.github.aymanizz.ktori18n.t import io.ktor.server.mustache.* -import io.ktor.server.plugins.origin -import io.ktor.server.plugins.ratelimit.* import io.ktor.server.request.* import io.ktor.server.response.* import io.ktor.server.routing.* @@ -25,9 +19,9 @@ fun Route.authRoutes( accountsRepository: AccountsRepository, whiteListRepository: WhiteListRepository, configRepository: ConfigRepository, - securityRepository: SecurityRepository, + serverConfig: ServerConfig ) { - loginPage(accountsRepository, whiteListRepository, configRepository, securityRepository) + loginPage(accountsRepository, whiteListRepository, configRepository, serverConfig) logout() unauthorized() } @@ -36,7 +30,7 @@ private fun Route.loginPage( accountsRepository: AccountsRepository, whiteListRepository: WhiteListRepository, configRepository: ConfigRepository, - securityRepository: SecurityRepository, + serverConfig: ServerConfig ) { route("/login") { get { @@ -47,61 +41,45 @@ private fun Route.loginPage( // Drop a present-but-unauthorized cookie so the user isn't bounced // straight back to /dashboard and into a redirect loop. if (session != null) call.sessions.clear() - val model = buildLoginModel(call, configRepository) + val model = buildLoginModel(call, whiteListRepository, configRepository, serverConfig) call.respond(MustacheContent("login.mustache", call.withDefaults(model))) } } - rateLimit(RateLimitName(LOGIN_RATE_LIMIT)) { - post { - val params = call.receiveParameters() - val email = params["email"] ?: "" - val password = params["password"] ?: "" + post { + val params = call.receiveParameters() + val email = params["email"] ?: "" + val password = params["password"] ?: "" - val result = accountsRepository.login( - email = email, - password = password, - installId = "web" + val result = accountsRepository.login( + email = email, + password = password, + installId = "web" + ) + if (isSuccess(result)) { + val token = result.data + val isAdmin = accountsRepository.isAdmin(token.userId) + val session = UserSession( + userId = token.userId, + username = email, + isAdmin = isAdmin ) - val session: UserSession? - val credentialsError: String? - if (isSuccess(result)) { - val token = result.data - session = UserSession( - userId = token.userId, - username = email, - isAdmin = accountsRepository.isAdmin(token.userId) - ) - credentialsError = null - } else { - session = null - credentialsError = result.displayMessageText(call) ?: "Login failed" - } - - // A whitelist rejection is a denied sign-in, so it is audited as a failure - // to match what the API path records for the same credentials. - val authorized = session != null && - sessionIsAuthorized(session, accountsRepository, whiteListRepository) - - securityRepository.recordLoginAttempt( - email = email, - ipAddress = call.request.origin.remoteAddress, - success = authorized, - ) - - if (session != null && authorized) { + if (sessionIsAuthorized(session, accountsRepository, whiteListRepository)) { call.sessions.set(session) call.respondRedirect("/dashboard") } else { - val model = buildLoginModel(call, configRepository) + // Credentials are valid but the user isn't whitelisted; don't set a + // session that /dashboard would reject (which would loop back here). + val model = buildLoginModel(call, whiteListRepository, configRepository, serverConfig) .toMutableMap() - // Valid credentials without a whitelist entry get no session, because - // /dashboard would reject it and loop back here. - model["message"] = credentialsError - ?: call.activeAllowedUsersSource()?.rejectionMessage()?.text(call) - ?: call.t(R("api_allowedusers_rejected")) + model["message"] = call.t(R("api_whitelist_rejected")) call.respond(MustacheContent("login.mustache", call.withDefaults(model))) } + } else { + val message = result.displayMessageText(call) ?: "Login failed" + val model = buildLoginModel(call, whiteListRepository, configRepository, serverConfig).toMutableMap() + model["message"] = message + call.respond(MustacheContent("login.mustache", call.withDefaults(model))) } } } @@ -109,16 +87,28 @@ private fun Route.loginPage( private suspend fun buildLoginModel( call: RoutingCall, + whiteListRepository: WhiteListRepository, configRepository: ConfigRepository, + serverConfig: ServerConfig ): Map { + val useWhiteList = whiteListRepository.useWhiteList() val contactEmail = configRepository.get(AdminServerConfig.CONTACT_EMAIL) + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val patreonFeatureEnabled = serverConfig.patreonEnabled == true + val patreonActive = patreonFeatureEnabled && patreonConfig.enabled && patreonConfig.patreonUrl.isNotBlank() return buildMap { put("page_stylesheet", "/assets/css/login.css") + put("whitelistEnabled", useWhiteList) if (contactEmail.isNotBlank()) { put("contactEmail", contactEmail) } - call.putAllowedUsersNotice(this, NoticeSlot.LOGIN) + if (patreonActive) { + val amount = "%.2f".format(patreonConfig.minimumAmountCents / 100.0) + put("patreonEnabled", true) + put("patreonUrl", patreonConfig.patreonUrl) + put("patreonMessage", call.t(R("login_patreon_notice_message"), amount)) + } } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringPage.kt index 1efd4b799..51a48cc7d 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringPage.kt @@ -43,8 +43,6 @@ import kotlinx.serialization.Serializable import kotlinx.serialization.builtins.ListSerializer import kotlinx.serialization.json.Json import java.net.URLEncoder -import java.time.ZoneId -import java.time.ZoneOffset import kotlin.math.ceil import kotlin.time.Clock import kotlin.time.Duration.Companion.days @@ -71,6 +69,8 @@ fun Route.adminMonitoringPages( projectsSyncManager: SyncSessionManager, projectSyncManager: SyncSessionManager<*, ProjectSynchronizationSession>, clock: Clock, + patreonFeatureEnabled: Boolean, + emailFeatureEnabled: Boolean, ) { route("/monitoring") { get { @@ -106,6 +106,8 @@ fun Route.adminMonitoringPages( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonOverview" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "monitoringEnabled" to enabled, "statRequests" to formatCount(totals.requestCount), "statErrorRate" to formatPercent(totals.errorRate), @@ -138,15 +140,16 @@ fun Route.adminMonitoringPages( val range = call.request.queryParameters["range"] ?: RANGE_24H val since = clock.now() - rangeToDuration(range) val stats = metricsRepository.getEndpointStats(since) - val hourly = range == RANGE_24H - val labelFormat = if (hourly) "HH:00" else "MMM dd" - val timeSeries = metricsRepository.getTimeSeries(since, hourly) - val latencyChart = buildLatencyChart(timeSeries, labelFormat, chartLabelZone(hourly)) + val labelFormat = if (range == RANGE_24H) "HH:00" else "MMM dd" + val timeSeries = metricsRepository.getTimeSeries(since, range == RANGE_24H) + val latencyChart = buildLatencyChart(timeSeries, labelFormat) val model = mutableMapOf( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonPerformance" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "range24h" to (range == RANGE_24H), "range7d" to (range == RANGE_7D), "range30d" to (range == RANGE_30D), @@ -161,10 +164,9 @@ fun Route.adminMonitoringPages( get("/errors") { val range = call.request.queryParameters["range"] ?: RANGE_24H val since = clock.now() - rangeToDuration(range) - val hourly = range == RANGE_24H - val labelFormat = if (hourly) "HH:00" else "MMM dd" - val timeSeries = metricsRepository.getTimeSeries(since, hourly) - val errorRateChart = buildErrorRateChart(timeSeries, labelFormat, chartLabelZone(hourly)) + val labelFormat = if (range == RANGE_24H) "HH:00" else "MMM dd" + val timeSeries = metricsRepository.getTimeSeries(since, range == RANGE_24H) + val errorRateChart = buildErrorRateChart(timeSeries, labelFormat) val routeFilter = call.request.queryParameters["route"]?.takeIf { it.isNotBlank() } val ignoreRules = configRepository.get(AdminServerConfig.IGNORED_ERROR_RULES) @@ -199,6 +201,8 @@ fun Route.adminMonitoringPages( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonErrors" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "range24h" to (range == RANGE_24H), "range7d" to (range == RANGE_7D), "range30d" to (range == RANGE_30D), @@ -302,6 +306,8 @@ fun Route.adminMonitoringPages( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonSecurity" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "topFailures" to topFailures, "hasTopFailures" to topFailures.isNotEmpty(), "attempts" to attempts, @@ -317,6 +323,8 @@ fun Route.adminMonitoringPages( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonJobs" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "jobs" to jobs, "hasJobs" to jobs.isNotEmpty(), "anyFailing" to jobs.any { it["failing"] == true }, @@ -329,6 +337,8 @@ fun Route.adminMonitoringPages( "page_stylesheet" to "/assets/css/admin.css", "activeMonitoring" to true, "activeMonLogs" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, ) call.respond(MustacheContent("admin-monitoring-logs.mustache", call.withDefaults(model))) } @@ -445,16 +455,9 @@ private fun securityAlertModel(alert: SecurityAlert): Map = mapOf( "href" to "/admin/monitoring/security", ) -/** - * Hourly buckets are ordinary instants, so they read best in the server's own zone. Daily buckets - * are floored to the UTC day, so labeling one anywhere else shifts every point onto a neighboring - * date. - */ -internal fun chartLabelZone(hourly: Boolean): ZoneId = if (hourly) ZoneId.systemDefault() else ZoneOffset.UTC - -private fun buildErrorRateChart(points: List, labelFormat: String, zone: ZoneId): String { +private fun buildErrorRateChart(points: List, labelFormat: String): String { val payload = ErrorRateChartPayload( - labels = points.map { formatInstant(it.bucketStart, labelFormat, zone) }, + labels = points.map { formatInstant(it.bucketStart, labelFormat) }, errorRates = points.map { pt -> if (pt.requests > 0) pt.errors.toDouble() / pt.requests * 100.0 else 0.0 }, @@ -462,34 +465,34 @@ private fun buildErrorRateChart(points: List, labelFormat: Stri return Json.encodeToString(ErrorRateChartPayload.serializer(), payload) } -private fun buildLatencyChart(points: List, labelFormat: String, zone: ZoneId): String { +private fun buildLatencyChart(points: List, labelFormat: String): String { val payload = LatencyChartPayload( - labels = points.map { formatInstant(it.bucketStart, labelFormat, zone) }, + labels = points.map { formatInstant(it.bucketStart, labelFormat) }, p95Ms = points.map { it.p95Ms }, ) return Json.encodeToString(LatencyChartPayload.serializer(), payload) } -internal fun buildActiveUsersChart(daily: List): String { +private fun buildActiveUsersChart(daily: List): String { val payload = ActiveUsersChartPayload( - labels = daily.map { formatInstant(it.day, "MMM dd", ZoneOffset.UTC) }, + labels = daily.map { formatInstant(it.day, "MMM dd") }, sync = daily.map { it.sync }, web = daily.map { it.web }, ) return Json.encodeToString(ActiveUsersChartPayload.serializer(), payload) } -internal fun buildReadersChart(daily: List): String { +private fun buildReadersChart(daily: List): String { val payload = ReadersChartPayload( - labels = daily.map { formatInstant(it.day, "MMM dd", ZoneOffset.UTC) }, + labels = daily.map { formatInstant(it.day, "MMM dd") }, readers = daily.map { it.count }, ) return Json.encodeToString(ReadersChartPayload.serializer(), payload) } -internal fun buildTrafficChart(points: List): String { +private fun buildTrafficChart(points: List): String { val payload = ChartPayload( - labels = points.map { formatInstant(it.bucketStart, "MMM dd", ZoneOffset.UTC) }, + labels = points.map { formatInstant(it.bucketStart, "MMM dd") }, requests = points.map { it.requests }, errors = points.map { it.errors }, ) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/PublicStoryPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/PublicStoryPage.kt index fa2d3b44f..aa8299a16 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/PublicStoryPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/PublicStoryPage.kt @@ -7,15 +7,14 @@ import com.darkrockstudios.apps.hammer.frontend.data.UserSession import com.darkrockstudios.apps.hammer.frontend.utils.ProjectName import com.darkrockstudios.apps.hammer.frontend.utils.applyRevalidationHeaders import com.darkrockstudios.apps.hammer.frontend.utils.canonicalUrl -import com.darkrockstudios.apps.hammer.frontend.utils.lookUpStory +import com.darkrockstudios.apps.hammer.frontend.utils.findProjectByUrlSegment import com.darkrockstudios.apps.hammer.frontend.utils.matchesETag import com.darkrockstudios.apps.hammer.frontend.utils.metaDescription import com.darkrockstudios.apps.hammer.frontend.utils.msg import com.darkrockstudios.apps.hammer.frontend.utils.pageETag +import com.darkrockstudios.apps.hammer.frontend.utils.resolveByPenName import com.darkrockstudios.apps.hammer.frontend.utils.storyArticleJsonLd import com.darkrockstudios.apps.hammer.monitoring.StoryReaderCollector -import com.darkrockstudios.apps.hammer.project.ProjectDefinition -import com.darkrockstudios.apps.hammer.project.ServerProjectDataRepository import com.darkrockstudios.apps.hammer.project.access.ProjectAccessRepository import com.darkrockstudios.apps.hammer.project.access.PublicProjectResult import com.darkrockstudios.apps.hammer.projects.ProjectsRepository @@ -46,26 +45,43 @@ fun Route.publicStoryPage( storyReaderCollector: StoryReaderCollector, accountsRepository: AccountsRepository, projectsRepository: ProjectsRepository, - serverProjectDataRepository: ServerProjectDataRepository, serverConfig: ServerConfig, ) { route("/a/{penName}/{projectName}") { get { + val penNameParam = call.parameters["penName"] + val projectNameParam = call.parameters["projectName"] + + if (penNameParam.isNullOrBlank() || projectNameParam.isNullOrBlank()) { + call.respond(HttpStatusCode.NotFound) + return@get + } + // Check for password and page in query parameters val password = call.request.queryParameters["p"] val page = call.request.queryParameters["page"]?.toIntOrNull() ?: 1 - val lookup = call.lookUpStory(accountsRepository, projectsRepository, projectAccessRepository, password) - if (lookup == null) { + // Resolve the author by pen name (verbatim, then dashes as spaces). + val account = resolveByPenName(penNameParam) { accountsRepository.findAccountByPenName(it) } + val penName = account?.pen_name + if (account == null || penName == null) { call.respond(HttpStatusCode.NotFound) return@get } - val account = lookup.account - val projectName = lookup.projectName - val result = lookup.result - val penNameForUrl = lookup.penNameSegment - val projectNameForUrl = lookup.projectSegment + // Resolve the project by the id embedded in its URL segment, scoped to this author's + // projects; the slug beside the id is decorative and ignored. + val projectName = projectsRepository.findProjectByUrlSegment(account.id, projectNameParam)?.name + if (projectName == null) { + call.respond(HttpStatusCode.NotFound) + return@get + } + + val result = projectAccessRepository.findAccessibleProject(penName, projectName, password) + + // Self-referential links reuse the incoming, already URL-safe segments. + val penNameForUrl = penNameParam + val projectNameForUrl = projectNameParam when (val resolved = result) { is PublicProjectResult.NotFound -> { @@ -101,8 +117,6 @@ fun Route.publicStoryPage( "" } - val projectDef = ProjectDefinition(name = projectName, uuid = resolved.projectUuid) - // The page shell — everything not derived from the story render. Built first so // it can be hashed into the validator, then filled in with the render below. val model = call.withDefaults( @@ -127,30 +141,15 @@ fun Route.publicStoryPage( "authorPenNameUrl" to ProjectName.penNameForUrl(resolved.penName), ) ) - if (resolved.isPublic) { - model["kudosFragmentUrl"] = "/a/$penNameForUrl/$projectNameForUrl/kudos" - } // Resolved once and reused by the render below, so the ETag costs no extra queries. - // A scene-limited share prepares only its scene subset; if every selected scene - // is gone this returns null and the link 404s like a nonexistent share. - val prepared = storyRendererService.prepareExport( - resolved.userId, - resolved.projectUuid, - resolved.sceneIds, - ) - - // Stands in for everything project-data carries (notably the declared story - // language rendered below): a hash-only lookup, so the revalidation path never - // transfers or parses the data blob. - val projectDataHash = serverProjectDataRepository.loadDataHash(resolved.userId, projectDef) + val prepared = + storyRendererService.prepareExport(resolved.userId, resolved.projectUuid) // A reader who already holds this exact page is answered without rendering it. // `indexable` is an explicit input: it gates the JSON-LD block but never reaches // the shell model. - val etag = prepared?.let { - pageETag(model, it.version, page, passwordParam, indexable, projectDataHash) - } + val etag = prepared?.let { pageETag(model, it.version, page, passwordParam, indexable) } if (etag != null && call.matchesETag(etag)) { call.applyRevalidationHeaders(etag) call.respond(HttpStatusCode.NotModified) @@ -179,20 +178,6 @@ fun Route.publicStoryPage( is PaginatedExportResult.Success -> { val data = exportResult.data - // The story's declared language, when set, becomes the page's content - // language: via the `locale` model key and the JSON-LD - // `inLanguage` below. Overridden only now, after withDefaults, so the - // header/footer extra links stay localized to the viewer's UI locale; - // the ETag covers it through projectDataHash above. - val storyLanguage = serverProjectDataRepository.loadProjectLanguage( - userId = resolved.userId, - projectDef = projectDef, - ) - if (storyLanguage != null) { - model["locale"] = storyLanguage - model["storyLanguage"] = storyLanguage - } - model.putAll( mapOf( "storyHtml" to data.pageHtml, @@ -220,7 +205,6 @@ fun Route.publicStoryPage( authorName = resolved.penName, authorUrl = call.canonicalUrl("/a/${ProjectName.penNameForUrl(resolved.penName)}"), wordCount = data.totalWordCount.toLong(), - inLanguage = storyLanguage, ) } etag?.let { call.applyRevalidationHeaders(it) } @@ -275,11 +259,32 @@ fun Route.publicStoryPage( // never reach here. Resolution mirrors the GET exactly — including the author-skip // and access checks — so a beacon can only record a read the visitor could load. post("/read") { + val penNameParam = call.parameters["penName"] + val projectNameParam = call.parameters["projectName"] + // A beacon is fire-and-forget: always answer 204 and never leak resolution // outcomes, so a bad beacon looks the same as a good one. + if (penNameParam.isNullOrBlank() || projectNameParam.isNullOrBlank()) { + call.respond(HttpStatusCode.NoContent) + return@post + } + val password = call.request.queryParameters["p"] - val resolved = call.lookUpStory(accountsRepository, projectsRepository, projectAccessRepository, password) - ?.result + + val account = resolveByPenName(penNameParam) { accountsRepository.findAccountByPenName(it) } + val penName = account?.pen_name + if (account == null || penName == null) { + call.respond(HttpStatusCode.NoContent) + return@post + } + + val projectName = projectsRepository.findProjectByUrlSegment(account.id, projectNameParam)?.name + if (projectName == null) { + call.respond(HttpStatusCode.NoContent) + return@post + } + + val resolved = projectAccessRepository.findAccessibleProject(penName, projectName, password) if (resolved is PublicProjectResult.Success) { // Skip the author reading their own story. val viewerId = call.sessions.get()?.userId diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/ReviewFrontend.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/ReviewFrontend.kt index eb05eed4a..e5b904abf 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/ReviewFrontend.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/ReviewFrontend.kt @@ -16,7 +16,6 @@ import com.darkrockstudios.apps.hammer.frontend.utils.requestBaseUrl import com.darkrockstudios.apps.hammer.frontend.utils.requireUser import com.darkrockstudios.apps.hammer.frontend.utils.respondHtmlWithToast import com.darkrockstudios.apps.hammer.frontend.utils.respondTemplateWithToast -import com.darkrockstudios.apps.hammer.frontend.utils.sceneTreeModel import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.review.ReviewInviteMailer import com.darkrockstudios.apps.hammer.review.ReviewParagraphs @@ -49,7 +48,7 @@ import io.ktor.server.routing.route import io.ktor.server.sessions.get import io.ktor.server.sessions.sessions import kotlinx.serialization.Serializable -import java.time.ZoneId +import java.time.ZoneOffset import java.time.format.DateTimeFormatter import kotlin.time.Clock import kotlin.time.Duration.Companion.days @@ -81,7 +80,16 @@ fun Route.reviewFrontend( else -> emptyList() } - val sceneTree = sceneTreeModel(scenes) + val sceneTree = scenes.map { item -> + mapOf( + "id" to item.id, + "name" to item.name, + "isGroup" to item.isGroup, + "isScene" to item.isScene, + "depth" to item.depth, + "indentPx" to (item.depth * 18), + ) + } val sceneCount = scenes.count { it.isScene } val model = call.withDefaults( @@ -883,7 +891,7 @@ private fun ApplicationCall.requestReviewUrl(token: String): String = internal fun formatReviewDate(instant: Instant): String = DateTimeFormatter.ofPattern("MMM d, yyyy", java.util.Locale.ENGLISH) - .withZone(ZoneId.systemDefault()) + .withZone(ZoneOffset.UTC) .format(instant.toJavaInstant()) /** Card models for the Editorial Reviews panel, newest first, revoked requests hidden. */ diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/RobotsRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/RobotsRoutes.kt index a0fd943be..935334b94 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/RobotsRoutes.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/RobotsRoutes.kt @@ -78,7 +78,6 @@ internal val DISALLOWED_PATHS: List = listOf( "/login", "/logout", "/setup", - "/signup", "/account", "/reset-password", "/forgot-password", diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPage.kt index 567eeff84..7957f1b76 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPage.kt @@ -2,22 +2,13 @@ package com.darkrockstudios.apps.hammer.frontend import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.frontend.utils.msg -import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT -import com.darkrockstudios.apps.hammer.projects.ProjectsRepository -import com.darkrockstudios.apps.hammer.utilities.isSuccess import io.ktor.server.mustache.* -import io.ktor.server.plugins.ratelimit.* -import io.ktor.server.request.* import io.ktor.server.response.* import io.ktor.server.routing.* -import io.ktor.server.sessions.* import org.koin.ktor.ext.inject fun Route.setupPage(serverConfig: ServerConfig) { val accountsRepository: AccountsRepository by inject() - val projectsRepository: ProjectsRepository by inject() route("/setup") { get { @@ -27,74 +18,18 @@ fun Route.setupPage(serverConfig: ServerConfig) { return@get } - call.respond(MustacheContent("setup.mustache", buildSetupModel(call, serverConfig))) - } + val model = call.withDefaults() + model["page_stylesheet"] = "/assets/css/error.css" - rateLimit(RateLimitName(LOGIN_RATE_LIMIT)) { - post { - // Guards against races with app-side account creation and double-submits - if (accountsRepository.hasUsers()) { - call.respondRedirect("/login") - return@post - } + // Build the server address for display + val serverAddress = buildServerAddress(serverConfig) + model["serverAddress"] = serverAddress - val params = call.receiveParameters() - val email = params["email"]?.trim() ?: "" - val password = params["password"] ?: "" - val confirmPassword = params["confirmPassword"] ?: "" - - suspend fun respondWithError(message: String) { - val model = buildSetupModel(call, serverConfig) - model["error"] = message - model["email"] = email - call.respond(MustacheContent("setup.mustache", model)) - } - - if (email.isEmpty() || password.isEmpty() || confirmPassword.isEmpty()) { - respondWithError(call.msg("setup_error_fields_required")) - return@post - } - if (password != confirmPassword) { - respondWithError(call.msg("setup_error_password_mismatch")) - return@post - } - - // ToS challenge is intentionally skipped for the first admin account, - // so this goes to the repository directly rather than AccountsComponent. - val result = accountsRepository.createAccount( - email = email, - installId = "web", - password = password, - ) - if (isSuccess(result)) { - val token = result.data - projectsRepository.createUserData(token.userId) - - // Read from the DB rather than assuming admin: a lost creation race - // means this account wasn't first and must not get an admin cookie. - val isAdmin = accountsRepository.isAdmin(token.userId) - val session = UserSession( - userId = token.userId, - username = email, - isAdmin = isAdmin, - ) - call.sessions.set(session) - call.respondRedirect(if (isAdmin) "/admin" else "/dashboard") - } else { - respondWithError(result.displayMessageText(call) ?: call.msg("setup_error_generic")) - } - } + call.respond(MustacheContent("setup.mustache", model)) } } } -private suspend fun buildSetupModel(call: RoutingCall, serverConfig: ServerConfig): MutableMap { - val model = call.withDefaults() - model["page_stylesheet"] = "/assets/css/error.css" - model["serverAddress"] = buildServerAddress(serverConfig) - return model -} - private fun buildServerAddress(config: ServerConfig): String { val host = config.host val port = config.port diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPage.kt deleted file mode 100644 index 010a82788..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPage.kt +++ /dev/null @@ -1,143 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.account.AccountsComponent -import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.account.CreateAccountResult -import com.darkrockstudios.apps.hammer.account.TermsOfServiceRepository -import com.darkrockstudios.apps.hammer.admin.AdminServerConfig -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.frontend.utils.msg -import com.darkrockstudios.apps.hammer.monitoring.SecurityRepository -import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT -import com.darkrockstudios.apps.hammer.plugin.NoticeSlot -import com.darkrockstudios.apps.hammer.plugin.putAllowedUsersNotice -import io.ktor.server.mustache.* -import io.ktor.server.plugins.origin -import io.ktor.server.plugins.ratelimit.* -import io.ktor.server.request.* -import io.ktor.server.response.* -import io.ktor.server.routing.* -import io.ktor.server.sessions.* - -/** - * Public self-registration. Goes through [AccountsComponent.createAccount] so the - * allowed users list and the Terms of Service challenge are enforced; only emails - * the admin has allowed can actually create an account here. - */ -fun Route.signupPage( - accountsComponent: AccountsComponent, - accountsRepository: AccountsRepository, - whiteListRepository: WhiteListRepository, - termsOfServiceRepository: TermsOfServiceRepository, - configRepository: ConfigRepository, - securityRepository: SecurityRepository, -) { - route("/signup") { - get { - val session: UserSession? = call.sessions.get() - if (session != null && sessionIsAuthorized(session, accountsRepository, whiteListRepository)) { - call.respondRedirect("/dashboard") - } else { - if (session != null) call.sessions.clear() - val model = buildSignupModel(call, termsOfServiceRepository, configRepository) - call.respond(MustacheContent("signup.mustache", model)) - } - } - - rateLimit(RateLimitName(LOGIN_RATE_LIMIT)) { - post { - val params = call.receiveParameters() - val email = params["email"]?.trim() ?: "" - val password = params["password"] ?: "" - val confirmPassword = params["confirmPassword"] ?: "" - val tosAccepted = params["tosAccepted"] != null - val acceptedTosVersion = params["acceptedTosVersion"] - - suspend fun respondWithError(message: String) { - val model = buildSignupModel(call, termsOfServiceRepository, configRepository) - model["error"] = message - model["email"] = email - call.respond(MustacheContent("signup.mustache", model)) - } - - if (email.isEmpty() || password.isEmpty() || confirmPassword.isEmpty()) { - respondWithError(call.msg("signup_error_fields_required")) - return@post - } - if (password != confirmPassword) { - respondWithError(call.msg("signup_error_password_mismatch")) - return@post - } - // The component re-checks the version; this gate just keeps the form - // honest so an unchecked box never reaches account creation. - if (termsOfServiceRepository.challenge() != null && !tosAccepted) { - respondWithError(call.msg("signup_error_tos_required")) - return@post - } - - val result = accountsComponent.createAccount( - email = email, - installId = "web", - password = password, - acceptedTosVersion = acceptedTosVersion, - ) - when (result) { - is CreateAccountResult.Success -> { - securityRepository.recordLoginAttempt( - email = email, - ipAddress = call.request.origin.remoteAddress, - success = true, - ) - val token = result.token - val session = UserSession( - userId = token.userId, - username = email, - isAdmin = accountsRepository.isAdmin(token.userId), - ) - call.sessions.set(session) - call.respondRedirect("/dashboard") - } - - is CreateAccountResult.TermsRequired -> { - // The ToS changed between render and submit; the re-render - // carries the new version in its hidden field. - respondWithError(call.msg("signup_error_tos_required")) - } - - is CreateAccountResult.Failure -> { - // A not-allowed email on a public form is an access probe and - // is audited like a failed login; validation failures are not. - if (accountsComponent.checkIfWhiteListRejected(email)) { - securityRepository.recordLoginAttempt( - email = email, - ipAddress = call.request.origin.remoteAddress, - success = false, - ) - } - respondWithError( - result.failure.displayMessageText(call) ?: call.msg("signup_error_generic") - ) - } - } - } - } - } -} - -private suspend fun buildSignupModel( - call: RoutingCall, - termsOfServiceRepository: TermsOfServiceRepository, - configRepository: ConfigRepository, -): MutableMap { - val model = call.withDefaults() - model["page_stylesheet"] = "/assets/css/login.css" - termsOfServiceRepository.challenge()?.let { model["tosVersion"] = it.version } - call.putAllowedUsersNotice(model, NoticeSlot.SIGNUP) - val contactEmail = configRepository.get(AdminServerConfig.CONTACT_EMAIL) - if (contactEmail.isNotBlank()) { - model["contactEmail"] = contactEmail - } - return model -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryKudosRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryKudosRoutes.kt deleted file mode 100644 index b241b7fa9..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryKudosRoutes.kt +++ /dev/null @@ -1,252 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.database.ProjectDao -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.frontend.utils.Toast -import com.darkrockstudios.apps.hammer.frontend.utils.lookUpStory -import com.darkrockstudios.apps.hammer.frontend.utils.msg -import com.darkrockstudios.apps.hammer.frontend.utils.respondTemplateWithToast -import com.darkrockstudios.apps.hammer.kudos.KudosGroup -import com.darkrockstudios.apps.hammer.kudos.KudosKind -import com.darkrockstudios.apps.hammer.kudos.KudosTally -import com.darkrockstudios.apps.hammer.kudos.SetPicksResult -import com.darkrockstudios.apps.hammer.kudos.StoryKudosRepository -import com.darkrockstudios.apps.hammer.project.access.ProjectAccessRepository -import com.darkrockstudios.apps.hammer.project.access.PublicProjectResult -import com.darkrockstudios.apps.hammer.projects.ProjectsRepository -import io.ktor.http.HttpHeaders -import io.ktor.http.HttpStatusCode -import io.ktor.server.application.ApplicationCall -import io.ktor.server.htmx.hx -import io.ktor.server.mustache.MustacheContent -import io.ktor.server.request.receiveParameters -import io.ktor.server.response.header -import io.ktor.server.response.respond -import io.ktor.server.routing.Route -import io.ktor.server.routing.get -import io.ktor.server.routing.post -import io.ktor.server.routing.route -import io.ktor.server.sessions.get -import io.ktor.server.sessions.sessions - -private const val KUDOS_FRAGMENT = "partials/story-kudos.mustache" - -private data class KudosStory( - val projectId: Long, - val authorId: Long, - val authorPenName: String, -) - -private val reactionIcons = mapOf( - KudosKind.MOVED_ME to "fa-heart", - KudosKind.MADE_ME_THINK to "fa-lightbulb", - KudosKind.MADE_ME_LAUGH to "fa-face-laugh-beam", - KudosKind.SURPRISED_ME to "fa-face-surprise", - KudosKind.PAGE_TURNER to "fa-book-open", -) - -/** - * Reader kudos on a publicly published story. The section loads as its own fragment so the - * story page's ETag never depends on kudos, and so per-reader picks stay out of the page shell. - */ -fun Route.storyKudosRoutes( - accountsRepository: AccountsRepository, - projectsRepository: ProjectsRepository, - projectAccessRepository: ProjectAccessRepository, - projectDao: ProjectDao, - storyKudosRepository: StoryKudosRepository, -) { - /** Only password-free public access qualifies; private shares never carry kudos. */ - suspend fun ApplicationCall.resolveKudosStory(): KudosStory? { - val resolved = lookUpStory(accountsRepository, projectsRepository, projectAccessRepository, password = null) - ?.result - if (resolved !is PublicProjectResult.Success || !resolved.isPublic) return null - val projectId = projectDao.getProjectIdOrNull(resolved.userId, resolved.projectUuid) ?: return null - return KudosStory(projectId = projectId, authorId = resolved.userId, authorPenName = resolved.penName) - } - - route("/a/{penName}/{projectName}/kudos") { - hx.get { - call.response.header(HttpHeaders.CacheControl, "no-store") - val story = call.resolveKudosStory() - if (story == null || !storyKudosRepository.isEnabled(story.projectId)) { - call.respond(HttpStatusCode.NoContent) - return@get - } - val model = call.kudosFragmentModel(story, storyKudosRepository) - model["animateIn"] = true - call.respond(MustacheContent(KUDOS_FRAGMENT, model)) - } - - // Every failure re-renders the reader's saved picks, so the chips never show an unsaved state. - hx.post { - call.response.header(HttpHeaders.CacheControl, "no-store") - val story = call.resolveKudosStory() - if (story == null) { - call.respond(HttpStatusCode.NotFound) - return@post - } - - // Not a 401: StatusPages replaces those bodies with the full unauthorized page. - val session = call.sessions.get() - if (session == null) { - respondTemplateWithToast( - templatePath = KUDOS_FRAGMENT, - model = call.kudosFragmentModel(story, storyKudosRepository), - message = call.msg("kudos_error_sign_in"), - toast = Toast.Info, - ) - return@post - } - - val requested = call.receiveParameters().getAll("kind").orEmpty() - .mapNotNullTo(mutableSetOf(), KudosKind::fromKey) - - val result = storyKudosRepository.setPicks(story.projectId, story.authorId, session.userId, requested) - if (result is SetPicksResult.Saved) { - val model = call.kudosFragmentModel(story, storyKudosRepository, savedPicks = result.picks) - call.respond(MustacheContent(KUDOS_FRAGMENT, model)) - return@post - } - - val (messageKey, status) = when (result) { - SetPicksResult.OwnStory -> "kudos_error_own_story" to HttpStatusCode.Forbidden - SetPicksResult.Disabled -> "kudos_error_disabled" to HttpStatusCode.Conflict - else -> "kudos_error_over_cap" to HttpStatusCode.BadRequest - } - respondTemplateWithToast( - templatePath = KUDOS_FRAGMENT, - model = call.kudosFragmentModel( - story, - storyKudosRepository, - closed = result == SetPicksResult.Disabled, - ), - message = call.msg(messageKey), - toast = Toast.Error, - status = status, - ) - } - } -} - -/** - * The author's Kudos sidebar panel: full counts, which only the author ever sees. Shown once - * the story is published or has kudos; otherwise it renders as a hidden placeholder that the - * publish toggle can swap in out of band. - */ -internal suspend fun ApplicationCall.kudosPanelModel( - storyKudosRepository: StoryKudosRepository, - projectId: Long, - isPublished: Boolean, - model: Map, -): Map { - @Suppress("UNCHECKED_CAST") - val messages = model["msg"] as Map - val tally = storyKudosRepository.tally(projectId) - fun rows(group: KudosGroup): List> { - val ranked = tally.ranked(group) - val top = ranked.maxOfOrNull { it.second } ?: 1L - return ranked.map { (kind, count) -> - mapOf( - "label" to (messages[kind.messageKey] ?: kind.key), - "count" to "%,d".format(count), - "percent" to (count * 100 / top), - "icon" to reactionIcons[kind].orEmpty(), - "isPublic" to (count >= KudosTally.PUBLIC_THRESHOLD), - ) - } - } - val craft = rows(KudosGroup.CRAFT) - val reactions = rows(KudosGroup.REACTION) - return mapOf( - "showKudosPanel" to (isPublished || tally.givers > 0), - "kudosEnabled" to storyKudosRepository.isEnabled(projectId), - "hasKudos" to (tally.givers > 0), - "kudosGivers" to "%,d".format(tally.givers), - "kudosGiversLabel" to msg("story_kudos_givers_label", tally.givers), - "craftKudos" to craft, - "reactionKudos" to reactions, - "hasCraftKudos" to craft.isNotEmpty(), - "hasReactionKudos" to reactions.isNotEmpty(), - "hasPublicKudos" to (craft + reactions).any { it["isPublic"] == true }, - ) -} - -/** - * [savedPicks] skips re-reading picks that were just written. [closed] renders every chip - * locked, for a story whose author turned kudos off while the reader had it open. - */ -private suspend fun ApplicationCall.kudosFragmentModel( - story: KudosStory, - storyKudosRepository: StoryKudosRepository, - savedPicks: Set? = null, - closed: Boolean = false, -): MutableMap { - val viewerId = sessions.get()?.userId - val isAuthor = viewerId == story.authorId - val canGive = viewerId != null && !isAuthor && !closed - val picks = when { - savedPicks != null -> savedPicks - viewerId != null && !isAuthor -> storyKudosRepository.picksFor(story.projectId, viewerId) - else -> emptySet() - } - val tally = storyKudosRepository.tally(story.projectId) - - val model = withDefaults() - @Suppress("UNCHECKED_CAST") - val messages = model["msg"] as Map - val label = { kind: KudosKind -> messages[kind.messageKey] ?: kind.key } - - suspend fun group(group: KudosGroup, promptKey: String, hintKey: String): Map { - val picked = picks.count { it.group == group } - // A full reaction group stays open: picking another reaction swaps it in. - val isCraft = group == KudosGroup.CRAFT - val chips = KudosKind.entries.filter { it.group == group }.map { kind -> - val checked = kind in picks - mapOf( - "key" to kind.key, - "label" to label(kind), - "icon" to reactionIcons[kind].orEmpty(), - "checked" to checked, - "disabled" to (!canGive || (isCraft && picked >= group.maxPicks && !checked)), - ) - } - return mapOf( - "prompt" to (messages[promptKey] ?: ""), - "hint" to (messages[hintKey] ?: ""), - "isReaction" to !isCraft, - "showCount" to (isCraft && canGive), - "count" to if (isCraft && canGive) msg("kudos_pick_count", picked, group.maxPicks) else "", - "chips" to chips, - ) - } - - val craftHighlights = tally.publicHighlights(KudosGroup.CRAFT).map(label) - val reactionHighlights = tally.publicHighlights(KudosGroup.REACTION).map(label) - - model.putAll( - mapOf( - "kudosTitle" to if (isAuthor) { - messages["kudos_title_author"].orEmpty() - } else { - msg("kudos_title_for", story.authorPenName) - }, - "kudosUrl" to request.local.uri.substringBefore('?'), - "groups" to listOf( - group(KudosGroup.CRAFT, "kudos_craft_prompt", "kudos_craft_hint"), - group(KudosGroup.REACTION, "kudos_reaction_prompt", "kudos_reaction_hint"), - ), - "craftHighlights" to craftHighlights, - "reactionHighlights" to reactionHighlights, - "hasCraftHighlights" to craftHighlights.isNotEmpty(), - "hasReactionHighlights" to reactionHighlights.isNotEmpty(), - "hasHighlights" to (craftHighlights.isNotEmpty() || reactionHighlights.isNotEmpty()), - "canGive" to canGive, - "isAuthor" to isAuthor, - "isSignedOut" to (viewerId == null), - "justSaved" to (savedPicks?.isNotEmpty() == true), - ) - ) - return model -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryPage.kt index 76871ce17..6e78be394 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/StoryPage.kt @@ -11,15 +11,9 @@ import com.darkrockstudios.apps.hammer.frontend.utils.findProjectByUrlSegment import com.darkrockstudios.apps.hammer.frontend.utils.formatInstant import com.darkrockstudios.apps.hammer.frontend.utils.formatSyncDate import com.darkrockstudios.apps.hammer.frontend.utils.msg -import com.darkrockstudios.apps.hammer.frontend.utils.renderTemplate import com.darkrockstudios.apps.hammer.frontend.utils.requireUser -import com.darkrockstudios.apps.hammer.frontend.utils.respondHtmlWithToast import com.darkrockstudios.apps.hammer.frontend.utils.respondTemplateWithToast -import com.darkrockstudios.apps.hammer.frontend.utils.sceneTreeModel -import com.darkrockstudios.apps.hammer.kudos.StoryKudosRepository import com.darkrockstudios.apps.hammer.monitoring.StoryReaderRepository -import com.darkrockstudios.apps.hammer.project.ProjectDefinition -import com.darkrockstudios.apps.hammer.project.ServerProjectDataRepository import com.darkrockstudios.apps.hammer.project.access.ProjectAccessRepository import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.story.SceneHierarchyResult @@ -27,9 +21,7 @@ import com.darkrockstudios.apps.hammer.story.SingleSceneExportResult import com.darkrockstudios.apps.hammer.story.StoryRenderResult import com.darkrockstudios.apps.hammer.story.StoryRendererService import com.darkrockstudios.apps.hammer.story.WordCountUtils -import com.darkrockstudios.apps.hammer.utilities.ServerResult import com.darkrockstudios.apps.hammer.utilities.truncateToUtcDay -import com.github.aymanizz.ktori18n.R import io.ktor.http.HttpStatusCode import io.ktor.server.application.ApplicationCall import io.ktor.server.htmx.hx @@ -56,8 +48,6 @@ fun Route.storyPage( accountsRepository: AccountsRepository, reviewRepository: com.darkrockstudios.apps.hammer.review.ReviewRepository, storyReaderRepository: StoryReaderRepository, - storyKudosRepository: StoryKudosRepository, - serverProjectDataRepository: ServerProjectDataRepository, projectDao: ProjectDao, clock: kotlin.time.Clock, ) { @@ -150,18 +140,9 @@ fun Route.storyPage( val reviewModels = call.reviewCards(reviewRepository, session.userId, projectId) - // The public reader page declares the story's language on the prose; the - // author's own view has to as well, or the browser hyphenates a French - // story by the rules of whatever locale the author reads Hammer in. - val storyLanguage = serverProjectDataRepository.loadProjectLanguage( - userId = session.userId, - projectDef = ProjectDefinition(name = project.name, uuid = projectId), - ) - val model = call.withDefaults( mapOf( "page_stylesheet" to "/assets/css/story.css", - "storyLanguage" to storyLanguage.orEmpty(), "page_script" to "/assets/js/story.js", "page_pre_script" to "/assets/js/review-form-logic.js", "reviews" to reviewModels, @@ -188,9 +169,6 @@ fun Route.storyPage( "hasScenes" to sceneHierarchy.isNotEmpty() ) ) - if (numericProjectId != null) { - model.putAll(call.kudosPanelModel(storyKudosRepository, numericProjectId, isPublished, model)) - } call.respond(MustacheContent("story.mustache", model)) } @@ -355,50 +333,15 @@ fun Route.storyPage( ) ) - // Publishing is what makes the Kudos panel relevant, so it swaps in out of band. - val kudosPanelHtml = projectDao.getProjectIdOrNull(session.userId, projectId)?.let { numericId -> - model.putAll(call.kudosPanelModel(storyKudosRepository, numericId, newIsPublished, model)) - model["kudosPanelOob"] = true - renderTemplate("partials/story-kudos-panel.mustache", model) - }.orEmpty() - - respondHtmlWithToast( - content = renderTemplate("partials/story-publish.mustache", model) + kudosPanelHtml, + respondTemplateWithToast( + templatePath = "partials/story-publish.mustache", + model = model, message = toastMessage, toast = toastType ) } - hx.post("/kudos-enabled") { - val session = call.sessions.requireUser() - val projectNameParam = call.parameters["projectName"] - if (projectNameParam.isNullOrBlank()) { - call.respond(HttpStatusCode.BadRequest) - return@post - } - - val project = projectsRepository.findProjectByUrlSegment(session.userId, projectNameParam) - val numericProjectId = project?.let { - projectDao.getProjectIdOrNull(session.userId, ProjectId(it.uuid)) - } - if (project == null || numericProjectId == null) { - call.respond(HttpStatusCode.NotFound) - return@post - } - - val enabled = call.receiveParameters()["enabled"] == "true" - storyKudosRepository.setEnabled(numericProjectId, enabled) - - val model = call.withDefaults( - mapOf("projectNameForUrl" to ProjectName.projectSegment(project.name, project.uuid)) - ) - val isPublished = projectAccessRepository.isPublished(session.userId, ProjectId(project.uuid)) - model.putAll(call.kudosPanelModel(storyKudosRepository, numericProjectId, isPublished, model)) - call.respond(MustacheContent("partials/story-kudos-panel.mustache", model)) - } - hx.get("/share-dialog") { - val session = call.sessions.requireUser() val projectNameParam = call.parameters["projectName"] if (projectNameParam.isNullOrBlank()) { @@ -406,38 +349,14 @@ fun Route.storyPage( return@get } - val project = projectsRepository.findProjectByUrlSegment(session.userId, projectNameParam) - if (project == null) { - call.respond(HttpStatusCode.NotFound) - return@get - } - - val hierarchyResult = - storyRendererService.getSceneHierarchy(session.userId, ProjectId(project.uuid)) - // A failed tree load must not render as an innocent empty tree: with the limit - // toggle on, an empty tree pins the submit button disabled with no explanation. - val scenes = when (hierarchyResult) { - is SceneHierarchyResult.Success -> hierarchyResult.scenes - else -> { - respondHtmlWithToast( - content = "", - message = call.msg("story_share_dialog_scenes_failed"), - toast = Toast.Error, - ) - return@get - } - } - // Get tomorrow's date as minimum date for the date picker val tomorrow = java.time.LocalDate.now().plusDays(1) val minDate = tomorrow.format(java.time.format.DateTimeFormatter.ISO_LOCAL_DATE) val model = call.withDefaults( mapOf( - "projectNameForUrl" to ProjectName.projectSegment(project.name, project.uuid), - "minDate" to minDate, - "sceneTree" to sceneTreeModel(scenes), - "sceneCount" to scenes.count { it.isScene }, + "projectNameForUrl" to projectNameParam, + "minDate" to minDate ) ) @@ -473,13 +392,6 @@ fun Route.storyPage( val formParams = call.receiveParameters() val password = formParams["password"] val expiresAt = formParams["expiresAt"]?.ifBlank { null } - // Null means the entire story; a checked limit box always produces a set, and - // the repository rejects an empty one rather than widening it. - val sceneIds: Set? = if (formParams["limitScenes"] != null) { - formParams.getAll("sceneIds")?.mapNotNull { it.toIntOrNull() }?.toSet() ?: emptySet() - } else { - null - } if (password.isNullOrBlank()) { call.respond(HttpStatusCode.BadRequest) @@ -500,12 +412,11 @@ fun Route.storyPage( kotlin.time.Instant.parse("${it}T23:59:59Z") } - val createResult = projectAccessRepository.createPrivateAccess( + projectAccessRepository.createPrivateAccess( userId = session.userId, projectUuid = projectId, password = password, - expiresAt = expiresAtInstant, - sceneIds = sceneIds, + expiresAt = expiresAtInstant ) // Return updated publish section @@ -531,29 +442,11 @@ fun Route.storyPage( ) ) - // Single respond after the when: responding from inside an exhaustive - // when's branches trips Ktor's pipeline-subject ClassCastException. - // The dialog is cleared via OOB swap only on success; a failure leaves - // it open with the author's scene selection intact. - val publishHtml = renderTemplate("partials/story-publish.mustache", model) - val closeDialog = """
""" - val (content, toastMessage, toastType) = when (createResult) { - is ServerResult.Failure -> Triple( - publishHtml, - createResult.displayMessageText(call, R("api_error_unknown")), - Toast.Error, - ) - - is ServerResult.Success -> Triple( - publishHtml + closeDialog, - call.msg("story_toast_access_created"), - Toast.Success, - ) - } - respondHtmlWithToast( - content = content, - message = toastMessage, - toast = toastType + respondTemplateWithToast( + templatePath = "partials/story-publish.mustache", + model = model, + message = call.msg("story_toast_access_created"), + toast = Toast.Success ) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/AdminPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/AdminPage.kt index d35f086eb..8ae5c037a 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/AdminPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/AdminPage.kt @@ -1,7 +1,6 @@ package com.darkrockstudios.apps.hammer.frontend import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.account.AccountDeletionService import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.account.SortDirection import com.darkrockstudios.apps.hammer.account.UserSortField @@ -10,13 +9,11 @@ import com.darkrockstudios.apps.hammer.admin.ConfigRepository import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.email.EmailService import com.darkrockstudios.apps.hammer.frontend.admin.* -import com.darkrockstudios.apps.hammer.frontend.utils.Toast import com.darkrockstudios.apps.hammer.frontend.utils.adminOnly import com.darkrockstudios.apps.hammer.frontend.utils.formatInstant import com.darkrockstudios.apps.hammer.frontend.utils.formatSyncDate import com.darkrockstudios.apps.hammer.frontend.utils.msg -import com.darkrockstudios.apps.hammer.frontend.utils.respondToast -import com.darkrockstudios.apps.hammer.plugin.installPluginAdminRoutes +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.utilities.ResUtils import io.ktor.htmx.* @@ -33,8 +30,8 @@ fun Route.adminPage( configRepository: ConfigRepository, accountsRepository: AccountsRepository, projectsRepository: ProjectsRepository, - accountDeletionService: AccountDeletionService, serverConfig: ServerConfig, + patreonSyncService: PatreonSyncService?, emailService: EmailService?, metricsRepository: com.darkrockstudios.apps.hammer.monitoring.MetricsRepository, errorRepository: com.darkrockstudios.apps.hammer.monitoring.ErrorRepository, @@ -46,26 +43,37 @@ fun Route.adminPage( projectSyncManager: com.darkrockstudios.apps.hammer.syncsessionmanager.SyncSessionManager<*, com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession>, clock: kotlin.time.Clock, ) { + val patreonFeatureEnabled = serverConfig.patreonEnabled == true val emailFeatureEnabled = serverConfig.emailProviderType != null adminOnly { route("/admin") { - adminSettingsPage(configRepository) + adminSettingsPage(configRepository, patreonFeatureEnabled, emailFeatureEnabled) adminMonitoringPages( metricsRepository, configRepository, errorRepository, securityRepository, userActivityRepository, storyReaderRepository, recurringTaskRegistry, projectsSyncManager, projectSyncManager, clock, + patreonFeatureEnabled, emailFeatureEnabled, ) - adminAllowedUsersPage() - adminUsersPage() - whiteListRoutes(whiteListRepository, clock) + adminWhitelistPage( + whiteListRepository, + configRepository, + serverConfig, + patreonFeatureEnabled, + emailFeatureEnabled + ) + adminUsersPage(patreonFeatureEnabled, emailFeatureEnabled) + whiteListRoutes(whiteListRepository, configRepository, serverConfig, clock) serverSettingsRoutes(configRepository) - usersRoutes(accountsRepository, projectsRepository, accountDeletionService) + usersRoutes(accountsRepository, projectsRepository) + if (patreonFeatureEnabled && patreonSyncService != null) { + adminPatreonPage(configRepository, patreonSyncService, emailFeatureEnabled) + patreonSettingsRoutes(configRepository, patreonSyncService, serverConfig) + } if (emailFeatureEnabled && emailService != null) { - adminEmailPage(configRepository, emailService, serverConfig) + adminEmailPage(configRepository, emailService, patreonFeatureEnabled, serverConfig) emailSettingsRoutes(configRepository, emailService) } - installPluginAdminRoutes() } } } @@ -73,6 +81,8 @@ fun Route.adminPage( // GET /admin - Server Settings page (default) private fun Route.adminSettingsPage( configRepository: ConfigRepository, + patreonFeatureEnabled: Boolean, + emailFeatureEnabled: Boolean ) { get { val configuredDefaultLocale = configRepository.get(AdminServerConfig.DEFAULT_LOCALE) @@ -88,9 +98,12 @@ private fun Route.adminSettingsPage( val model = mapOf( "page_stylesheet" to "/assets/css/admin.css", "activeSettings" to true, - "activeAllowedUsers" to false, + "activeWhitelist" to false, "activeUsers" to false, + "activePatreon" to false, "activeEmail" to false, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, "contactEmail" to configRepository.get(AdminServerConfig.CONTACT_EMAIL), "serverMessage" to configRepository.get(AdminServerConfig.SERVER_MESSAGE), "aboutServer" to configRepository.get(AdminServerConfig.ABOUT_SERVER), @@ -112,62 +125,58 @@ private fun Route.adminSettingsPage( } } -// GET /admin/allowed-users - Allowed Users management page -private fun Route.adminAllowedUsersPage() { - get("/allowed-users") { +// GET /admin/whitelist - Whitelist Management page +private fun Route.adminWhitelistPage( + whiteListRepository: WhiteListRepository, + configRepository: ConfigRepository, + serverConfig: ServerConfig, + patreonFeatureEnabled: Boolean, + emailFeatureEnabled: Boolean +) { + get("/whitelist") { + val whitelistEnabled = whiteListRepository.useWhiteList() + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val patreonActive = patreonFeatureEnabled && patreonConfig.enabled && patreonConfig.patreonUrl.isNotBlank() + val canDisableWhitelist = !patreonActive + val model = mapOf( "page_stylesheet" to "/assets/css/admin.css", "activeSettings" to false, - "activeAllowedUsers" to true, + "activeWhitelist" to true, "activeUsers" to false, + "activePatreon" to false, "activeEmail" to false, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, + "whitelist" to mapOf( + "enabled" to whitelistEnabled, + "canDisable" to canDisableWhitelist + ), ) - call.respond(MustacheContent("admin-allowed-users.mustache", call.withDefaults(model))) - } - - // Old bookmarks and links from the whitelist era. - get("/whitelist") { - call.respondRedirect("/admin/allowed-users", permanent = true) + call.respond(MustacheContent("admin-whitelist.mustache", call.withDefaults(model))) } } // GET /admin/users - User Management page -private fun Route.adminUsersPage() { +private fun Route.adminUsersPage(patreonFeatureEnabled: Boolean, emailFeatureEnabled: Boolean) { get("/users") { val model = mapOf( "page_stylesheet" to "/assets/css/admin.css", "activeSettings" to false, - "activeAllowedUsers" to false, + "activeWhitelist" to false, "activeUsers" to true, + "activePatreon" to false, "activeEmail" to false, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to emailFeatureEnabled, ) call.respond(MustacheContent("admin-users.mustache", call.withDefaults(model))) } } -private fun Route.usersRoutes( - accountsRepository: AccountsRepository, - projectsRepository: ProjectsRepository, - accountDeletionService: AccountDeletionService, -) { +private fun Route.usersRoutes(accountsRepository: AccountsRepository, projectsRepository: ProjectsRepository) { route("/users") { usersFragment(accountsRepository, projectsRepository) - - hx.post("/restore") { - val userId = call.receiveParameters()["userId"]?.toLongOrNull() - if (userId == null) { - call.respond(io.ktor.http.HttpStatusCode.BadRequest, "") - return@post - } - - if (accountDeletionService.restore(userId)) { - call.response.header(HxResponseHeaders.Refresh, "true") - call.respond(io.ktor.http.HttpStatusCode.OK, "") - } else { - // The account was already hard-deleted; a refresh would lose the toast. - respondToast(call.msg("admin_users_restore_failed"), Toast.Error) - } - } } } @@ -203,14 +212,12 @@ private suspend fun getUsersModel( val accounts = accountsRepository.getAccountsPaginated(currentPage, pageSize, actualSortBy, actualSortDirection) val usersList = accounts.map { account -> mutableMapOf( - "id" to account.id, "email" to account.email, "created" to formatDate(account.created), - "lastSync" to (formatLastSync(account.most_recent_sync) ?: call.msg("admin_users_last_sync_never")), + "lastSync" to (formatLastSync(account.most_recent_sync) ?: call.msg("admin_patreon_last_sync_never")), "penName" to account.pen_name, "hasPenName" to (account.pen_name != null), - "projectCount" to account.project_count, - "pendingDeletion" to (account.deleted_at != null) + "projectCount" to account.project_count ) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/EmailPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/EmailPage.kt index 036245599..4e3f642b3 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/EmailPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/EmailPage.kt @@ -22,6 +22,7 @@ import kotlinx.html.div internal fun Route.adminEmailPage( configRepository: ConfigRepository, emailService: EmailService, + patreonFeatureEnabled: Boolean, serverConfig: ServerConfig ) { get("/email") { @@ -35,9 +36,12 @@ internal fun Route.adminEmailPage( val model = mapOf( "page_stylesheet" to "/assets/css/admin.css", "activeSettings" to false, - "activeAllowedUsers" to false, + "activeWhitelist" to false, "activeUsers" to false, + "activePatreon" to false, "activeEmail" to true, + "patreonFeatureEnabled" to patreonFeatureEnabled, + "emailFeatureEnabled" to true, "emailConfigured" to isConfigured, "activeProvider" to activeProvider.name, "isSmtpProvider" to (activeProvider == EmailProvider.SMTP), diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/PatreonPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/PatreonPage.kt new file mode 100644 index 000000000..583a32a3f --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/PatreonPage.kt @@ -0,0 +1,206 @@ +package com.darkrockstudios.apps.hammer.frontend.admin + +import com.darkrockstudios.apps.hammer.ServerConfig +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.frontend.utils.formatPatreonDate +import com.darkrockstudios.apps.hammer.frontend.utils.msg +import com.darkrockstudios.apps.hammer.frontend.utils.respondHtmlFragment +import com.darkrockstudios.apps.hammer.frontend.withDefaults +import com.darkrockstudios.apps.hammer.patreon.PatreonApiClient +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService +import io.ktor.htmx.* +import io.ktor.http.* +import io.ktor.server.htmx.* +import io.ktor.server.mustache.* +import io.ktor.server.request.* +import io.ktor.server.response.* +import io.ktor.server.routing.* +import kotlinx.html.* +import org.koin.ktor.ext.inject + +internal fun Route.patreonSettingsRoutes( + configRepository: ConfigRepository, + patreonSyncService: PatreonSyncService, + serverConfig: ServerConfig +) { + val patreonApiClient: PatreonApiClient by inject() + + route("/patreon") { + // POST /admin/patreon/fetch-campaign - Fetch Campaign ID from Patreon API + hx.post("/fetch-campaign") { + val params = call.receiveParameters() + val accessToken = params["accessToken"]?.trim().orEmpty() + + val currentConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val effectiveToken = accessToken.ifEmpty { currentConfig.creatorAccessToken } + + if (effectiveToken.isEmpty()) { + val errorMsg = call.msg("admin_patreon_error_token_required") + call.respondHtmlFragment { + input { + id = "campaignId" + name = "campaignId" + type = InputType.text + value = "" + classes = setOf("form-input", "form-input--error") + placeholder = errorMsg + } + } + return@post + } + + val result = patreonApiClient.fetchCampaignId(effectiveToken) + + if (result.isSuccess) { + val campaignId = result.getOrThrow() + call.respondHtmlFragment { + input { + id = "campaignId" + name = "campaignId" + type = InputType.text + value = campaignId + classes = setOf("form-input") + placeholder = "123456" + } + } + } else { + val errorMsg = call.msg("admin_patreon_error_fetch_failed") + call.respondHtmlFragment { + input { + id = "campaignId" + name = "campaignId" + type = InputType.text + value = "" + classes = setOf("form-input", "form-input--error") + placeholder = errorMsg + } + } + } + } + + // POST /admin/patreon/settings - Save Patreon settings + hx.post("/settings") { + val params = call.receiveParameters() + val enabled = params["enabled"] == "true" + val campaignId = params["campaignId"]?.trim().orEmpty() + val accessToken = params["accessToken"]?.trim().orEmpty() + val webhookSecret = params["webhookSecret"]?.trim().orEmpty() + val patreonUrl = params["patreonUrl"]?.trim().orEmpty() + val minimumAmountStr = params["minimumAmount"]?.trim().orEmpty() + val pollIntervalStr = params["pollInterval"]?.trim().orEmpty() + + val currentConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + + // Validation: if trying to enable, required fields must be filled + if (enabled) { + val effectiveAccessToken = accessToken.ifEmpty { currentConfig.creatorAccessToken } + + if (campaignId.isEmpty()) { + call.response.header(HxResponseHeaders.Retarget, "#patreon-error") + call.response.header(HxResponseHeaders.Reswap, "innerHTML") + val errorMsg = call.msg("admin_patreon_error_campaign_required") + call.respondHtmlFragment { + div("error-message") { + +errorMsg + } + } + return@post + } + + if (effectiveAccessToken.isEmpty()) { + call.response.header(HxResponseHeaders.Retarget, "#patreon-error") + call.response.header(HxResponseHeaders.Reswap, "innerHTML") + val errorMsg = call.msg("admin_patreon_error_token_required") + call.respondHtmlFragment { + div("error-message") { + +errorMsg + } + } + return@post + } + } + + val minimumAmountCents = try { + (minimumAmountStr.toDoubleOrNull()?.times(100))?.toInt() ?: 500 + } catch (_: Exception) { + 500 + } + + val pollIntervalMinutes = pollIntervalStr.toIntOrNull()?.coerceAtLeast(1) ?: 60 + + val newConfig = currentConfig.copy( + enabled = enabled, + campaignId = campaignId, + creatorAccessToken = accessToken.ifEmpty { currentConfig.creatorAccessToken }, + webhookSecret = webhookSecret.ifEmpty { currentConfig.webhookSecret }, + patreonUrl = patreonUrl.ifEmpty { currentConfig.patreonUrl }, + minimumAmountCents = minimumAmountCents, + pollIntervalMinutes = pollIntervalMinutes + ) + + configRepository.set(AdminServerConfig.PATREON_CONFIG, newConfig) + + call.response.header(HxResponseHeaders.Refresh, "true") + call.respond(HttpStatusCode.OK, "") + } + + // POST /admin/patreon/sync - Trigger manual sync + hx.post("/sync") { + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + + // Don't allow sync if not enabled + if (!config.enabled) { + call.response.header(HxResponseHeaders.Retarget, "#patreon-error") + call.response.header(HxResponseHeaders.Reswap, "innerHTML") + val errorMsg = call.msg("admin_patreon_error_not_enabled") + call.respondHtmlFragment { + div("error-message") { + +errorMsg + } + } + return@post + } + + val result = patreonSyncService.performFullSync() + call.response.header(HxResponseHeaders.Refresh, "true") + call.respond(HttpStatusCode.OK, "") + } + } +} + +// GET /admin/patreon - Patreon Integration page +internal fun Route.adminPatreonPage( + configRepository: ConfigRepository, + patreonSyncService: PatreonSyncService, + emailFeatureEnabled: Boolean +) { + get("/patreon") { + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val patreonMemberCount = patreonSyncService.getPatreonWhitelistCount() + val patreonMembersWithAccounts = patreonSyncService.getPatreonMembersWithAccountsCount() + + val model = mapOf( + "page_stylesheet" to "/assets/css/admin.css", + "activeSettings" to false, + "activeWhitelist" to false, + "activeUsers" to false, + "activePatreon" to true, + "activeEmail" to false, + "patreonFeatureEnabled" to true, + "emailFeatureEnabled" to emailFeatureEnabled, + "patreonEnabled" to patreonConfig.enabled, + "campaignId" to patreonConfig.campaignId, + "accessToken" to patreonConfig.creatorAccessToken, + "webhookSecret" to patreonConfig.webhookSecret, + "patreonUrl" to patreonConfig.patreonUrl, + "minimumAmountDollars" to "%.2f".format(patreonConfig.minimumAmountCents / 100.0), + "pollIntervalMinutes" to patreonConfig.pollIntervalMinutes, + "lastSync" to formatPatreonDate(patreonConfig.lastSync).ifEmpty { "Never" }, + "patreonMemberCount" to patreonMemberCount, + "patreonMembersWithAccounts" to patreonMembersWithAccounts, + "webhookUrl" to "/patreon/webhook" + ) + call.respond(MustacheContent("admin-patreon.mustache", call.withDefaults(model))) + } +} \ No newline at end of file diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/WhitelistPage.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/WhitelistPage.kt index 98552dff9..ea2c4e5da 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/WhitelistPage.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/admin/WhitelistPage.kt @@ -1,9 +1,12 @@ package com.darkrockstudios.apps.hammer.frontend.admin +import com.darkrockstudios.apps.hammer.ServerConfig +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.frontend.utils.msg import com.darkrockstudios.apps.hammer.frontend.withDefaults -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService import io.ktor.htmx.* import io.ktor.http.* import io.ktor.server.application.* @@ -12,9 +15,7 @@ import io.ktor.server.mustache.* import io.ktor.server.request.* import io.ktor.server.response.* import io.ktor.server.routing.* -import org.koin.ktor.ext.get import io.ktor.utils.io.* -import java.net.URLEncoder import java.time.LocalDate import java.time.ZoneId import java.time.format.DateTimeFormatter @@ -28,12 +29,15 @@ import kotlin.time.Duration.Companion.days internal fun Route.whiteListRoutes( whiteListRepository: WhiteListRepository, + configRepository: ConfigRepository, + serverConfig: ServerConfig, clock: Clock, ) { - route("/allowed-users") { + route("/whitelist") { whitelistUserFragment(whiteListRepository) whitelistAdd(whiteListRepository, clock) whitelistRemove(whiteListRepository) + whitelistToggle(whiteListRepository, configRepository, serverConfig) whitelistEditReason(whiteListRepository) whitelistEditExpiry(whiteListRepository, clock) } @@ -43,9 +47,6 @@ internal fun Route.whiteListRoutes( internal const val EXPIRY_PRESET_NEVER = "never" internal const val EXPIRY_PRESET_CUSTOM = "custom" -/** The practical ceiling on an email address, so a search can't be arbitrarily long. */ -private const val MAX_SEARCH_LENGTH = 254 - /** * Resolves the add/edit form's expiry controls to an instant, or null for "never". * @@ -85,35 +86,61 @@ private fun parseCustomExpiryDate(customDate: String?): ExpiryParse { } } +private suspend fun isPatreonActive(configRepository: ConfigRepository, serverConfig: ServerConfig): Boolean { + val patreonConfig = configRepository.get(AdminServerConfig.PATREON_CONFIG) + val patreonFeatureEnabled = serverConfig.patreonEnabled == true + return patreonFeatureEnabled && patreonConfig.enabled && patreonConfig.patreonUrl.isNotBlank() +} + +private fun Route.whitelistToggle( + whiteListRepository: WhiteListRepository, + configRepository: ConfigRepository, + serverConfig: ServerConfig +) { + hx.post("/toggle") { + val enabled = whiteListRepository.useWhiteList() + val patreonActive = isPatreonActive(configRepository, serverConfig) + + // Prevent disabling whitelist when Patreon is active + if (enabled && patreonActive) { + call.respond(HttpStatusCode.Forbidden, "") + return@post + } + + whiteListRepository.setWhiteListEnabled(!enabled) + + call.response.header(HxResponseHeaders.Refresh, "true") + call.respond(HttpStatusCode.OK, "") + } +} + @OptIn(ExperimentalKtorApi::class) private fun Route.whitelistAdd(whiteListRepository: WhiteListRepository, clock: Clock) { hx.post("/add") { val params = call.receiveParameters() val email = params["email"]?.trim().orEmpty() val reason = params["reason"]?.trim().orEmpty() - // A rejected add is not an add, so the error lands in the admin's current view. val page = params["page"]?.toIntOrNull() ?: 0 val sortOldestFirst = params["sortOldestFirst"]?.toBoolean() ?: false - val search = params["q"] // Validate email format if (email.isEmpty()) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_emailrequired"), - sortOldestFirst, search + call.msg("admin_whitelist_error_emailrequired"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } if (!whiteListRepository.validateEmail(email)) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_emailinvalid"), - sortOldestFirst, search + call.msg("admin_whitelist_error_emailinvalid"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } @@ -123,10 +150,10 @@ private fun Route.whitelistAdd(whiteListRepository: WhiteListRepository, clock: if (!whiteListRepository.validateReason(actualReason)) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_reasontoolong"), - sortOldestFirst, search + call.msg("admin_whitelist_error_reasontoolong"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } @@ -134,21 +161,18 @@ private fun Route.whitelistAdd(whiteListRepository: WhiteListRepository, clock: if (parsedExpiry !is ExpiryParse.Parsed || !whiteListRepository.validateExpiry(parsedExpiry.expires)) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_expiryinvalid"), - sortOldestFirst, search + call.msg("admin_whitelist_error_expiryinvalid"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } // All validation passed whiteListRepository.addToWhiteList(email, actualReason, parsedExpiry.expires) - // A new entry is only guaranteed visible on the unfiltered first page, newest first, - // so the successful response resets the view and tells the client to match it. - call.response.header(HxResponseHeaders.Trigger, "whitelist-added") - val model = getWhitelistModel(call, whiteListRepository, page = 0, sortOldestFirst = false, search = "") - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst) + call.respond(MustacheContent("partials/whitelist.mustache", model)) } } @@ -158,14 +182,13 @@ private fun Route.whitelistRemove(whiteListRepository: WhiteListRepository) { val email = params["email"]?.trim().orEmpty() val page = params["page"]?.toIntOrNull() ?: 0 val sortOldestFirst = params["sortOldestFirst"]?.toBoolean() ?: false - val search = params["q"] if (email.isNotEmpty()) { whiteListRepository.removeFromWhiteList(email) } - val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst, search) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst) + call.respond(MustacheContent("partials/whitelist.mustache", model)) } } @@ -176,32 +199,31 @@ private fun Route.whitelistEditReason(whiteListRepository: WhiteListRepository) val reason = params["reason"]?.trim().orEmpty() val page = params["page"]?.toIntOrNull() ?: 0 val sortOldestFirst = params["sortOldestFirst"]?.toBoolean() ?: false - val search = params["q"] if (email.isEmpty()) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_emailrequired"), - sortOldestFirst, search + call.msg("admin_whitelist_error_emailrequired"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } if (!whiteListRepository.validateReason(reason)) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_reasontoolong"), - sortOldestFirst, search + call.msg("admin_whitelist_error_reasontoolong"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } whiteListRepository.updateReason(email, reason) - val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst, search) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst) + call.respond(MustacheContent("partials/whitelist.mustache", model)) } } @@ -211,15 +233,14 @@ private fun Route.whitelistEditExpiry(whiteListRepository: WhiteListRepository, val email = params["email"]?.trim().orEmpty() val page = params["page"]?.toIntOrNull() ?: 0 val sortOldestFirst = params["sortOldestFirst"]?.toBoolean() ?: false - val search = params["q"] if (email.isEmpty()) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_emailrequired"), - sortOldestFirst, search + call.msg("admin_whitelist_error_emailrequired"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } @@ -233,24 +254,24 @@ private fun Route.whitelistEditExpiry(whiteListRepository: WhiteListRepository, if (parsedExpiry !is ExpiryParse.Parsed || !whiteListRepository.validateExpiry(parsedExpiry.expires)) { val model = getWhitelistModelWithError( call, whiteListRepository, page, - call.msg("admin_allowedusers_error_expiryinvalid"), - sortOldestFirst, search + call.msg("admin_whitelist_error_expiryinvalid"), + sortOldestFirst ) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) return@post } whiteListRepository.updateExpiry(email, parsedExpiry.expires) - val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst, search) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst) + call.respond(MustacheContent("partials/whitelist.mustache", model)) } } internal fun Route.whitelistUserFragment(whiteListRepository: WhiteListRepository) { hx.get("/user-fragment") { val model = getWhitelistModel(call, whiteListRepository) - call.respond(MustacheContent("partials/allowed-users.mustache", model)) + call.respond(MustacheContent("partials/whitelist.mustache", model)) } } @@ -258,42 +279,35 @@ internal suspend fun getWhitelistModel( call: ApplicationCall, whiteListRepository: WhiteListRepository, page: Int? = null, - sortOldestFirst: Boolean? = null, - search: String? = null, + sortOldestFirst: Boolean? = null ): MutableMap { - val sourceIds = call.application.get().allowedUsersSourceIds val queryPage = call.request.queryParameters["page"]?.toIntOrNull() val actualPage = page ?: queryPage ?: 0 val querySortOldestFirst = call.request.queryParameters["sortOldestFirst"]?.toBoolean() val actualSortOldestFirst = sortOldestFirst ?: querySortOldestFirst ?: false - val actualSearch = (search ?: call.request.queryParameters["q"]) - ?.trim().orEmpty().take(MAX_SEARCH_LENGTH) - val searchFilter = actualSearch.ifEmpty { null } - val pageSize = 10 - val totalCount = whiteListRepository.getWhiteListCount(searchFilter) + val totalCount = whiteListRepository.getWhiteListCount() val totalPages = ceil(totalCount.toDouble() / pageSize).toInt() val currentPage = if (totalPages > 0) actualPage.coerceIn(0, totalPages - 1) else 0 - val whitelistEntries = whiteListRepository.getWhiteListWithAccountStatus( - currentPage, pageSize, actualSortOldestFirst, searchFilter - ) + val whitelistEntries = + whiteListRepository.getWhiteListWithAccountStatus(currentPage, pageSize, actualSortOldestFirst) val whitelistItems = whitelistEntries.map { entry -> mapOf( "email" to entry.email, "dateAdded" to (formatDateFromTimestamp(entry.date_added) - ?: call.msg("admin_allowedusers_date_added_unknown")), + ?: call.msg("admin_whitelist_date_added_unknown")), "reason" to entry.reason, "hasAccount" to entry.has_account, "hasExpiry" to (entry.expires != null), "expires" to (entry.expires?.let { formatDateFromTimestamp(it) } - ?: call.msg("admin_allowedusers_expiry_never")), + ?: call.msg("admin_whitelist_expiry_never")), // Prefills the edit dialog's , which only accepts yyyy-MM-dd. "expiresRaw" to (entry.expires?.let { formatDateInputValue(it) } ?: ""), - // A syncing source owns its entries' lifecycle, so expiry isn't the admin's to set. - "sourceManaged" to (entry.reason in sourceIds), + // Patreon sync owns its entries' lifecycle, so expiry isn't the admin's to set. + "isPatreon" to (entry.reason == PatreonSyncService.WHITELIST_REASON), ) } @@ -302,18 +316,13 @@ internal suspend fun getWhitelistModel( whitelist["currentPage"] = currentPage whitelist["currentPageDisplay"] = currentPage + 1 whitelist["totalPages"] = totalPages - // Mustache renders a section on a boxed 0, so paging needs its own boolean. - whitelist["hasPages"] = totalPages > 0 whitelist["hasNextPage"] = currentPage < totalPages - 1 whitelist["hasPrevPage"] = currentPage > 0 whitelist["nextPage"] = currentPage + 1 whitelist["prevPage"] = currentPage - 1 + whitelist["enabled"] = whiteListRepository.useWhiteList() whitelist["sortOldestFirst"] = actualSortOldestFirst whitelist["sortNewestFirst"] = !actualSortOldestFirst - whitelist["search"] = actualSearch - // Reflected into hx-get URLs, where mustache's HTML escaping alone isn't enough. - whitelist["searchEnc"] = URLEncoder.encode(actualSearch, Charsets.UTF_8) - whitelist["hasSearch"] = actualSearch.isNotEmpty() val model = call.withDefaults() model["whitelist"] = whitelist @@ -326,10 +335,9 @@ private suspend fun getWhitelistModelWithError( whiteListRepository: WhiteListRepository, page: Int, errorMessage: String, - sortOldestFirst: Boolean? = null, - search: String? = null, + sortOldestFirst: Boolean? = null ): MutableMap { - val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst, search) + val model = getWhitelistModel(call, whiteListRepository, page, sortOldestFirst) model["error"] = errorMessage return model } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/AdminSecurity.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/AdminSecurity.kt index 2ced993ab..e58fec826 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/AdminSecurity.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/AdminSecurity.kt @@ -3,17 +3,16 @@ package com.darkrockstudios.apps.hammer.frontend.utils import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.frontend.data.UserSession import io.ktor.htmx.HxRequestHeaders -import io.ktor.htmx.HxResponseHeaders import io.ktor.http.HttpStatusCode -import io.ktor.server.application.ApplicationCall import io.ktor.server.application.createRouteScopedPlugin import io.ktor.server.auth.authenticate -import io.ktor.server.response.header -import io.ktor.server.response.respond +import io.ktor.server.html.respondHtml import io.ktor.server.response.respondRedirect import io.ktor.server.routing.Route import io.ktor.server.sessions.get import io.ktor.server.sessions.sessions +import kotlinx.html.div +import kotlinx.html.stream.createHTML import org.koin.ktor.ext.get val AdminOnlyPlugin = createRouteScopedPlugin( @@ -24,7 +23,14 @@ val AdminOnlyPlugin = createRouteScopedPlugin( val session = call.sessions.get() if (session == null || !accountsRepository.isAdmin(session.userId)) { - call.denyAccess(HttpStatusCode.Forbidden, "/unauthorized") + if (call.request.headers[HxRequestHeaders.Request] == "true") { + val message = call.msg("security_access_denied") + call.respondHtml(HttpStatusCode.Forbidden) { + createHTML().div { +message } + } + } else { + call.respondRedirect("/unauthorized") + } return@onCall } } @@ -44,7 +50,14 @@ val AuthenticatedOnlyPlugin = createRouteScopedPlugin( val session = call.sessions.get() if (session == null) { - call.denyAccess(HttpStatusCode.Unauthorized, "/login") + if (call.request.headers[HxRequestHeaders.Request] == "true") { + val message = call.msg("security_please_login") + call.respondHtml(HttpStatusCode.Unauthorized) { + createHTML().div { +message } + } + } else { + call.respondRedirect("/login") + } return@onCall } } @@ -56,20 +69,3 @@ fun Route.authenticatedOnly(build: Route.() -> Unit): Route { apply(build) } } - -/** - * Turns a caller away to [destination], keeping [status] honest for the access log. - * - * An htmx request is redirected by header rather than by body: htmx acts on HX-Redirect before it - * decides what to do with the response body, so this still works where a body cannot be relied on. - * A body would be the wrong tool anyway — htmx discards the body of a 4xx, and StatusPages answers - * a 401 with the whole unauthorized page, which has no business being swapped into a fragment. - */ -private suspend fun ApplicationCall.denyAccess(status: HttpStatusCode, destination: String) { - if (request.headers[HxRequestHeaders.Request] == "true") { - response.header(HxResponseHeaders.Redirect, destination) - respond(status) - } else { - respondRedirect(destination) - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/DateUtils.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/DateUtils.kt index a1659cedc..3aa57e387 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/DateUtils.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/DateUtils.kt @@ -11,6 +11,16 @@ const val SYNC_DATE_PATTERN = "MMM dd, yyyy 'at' HH:mm" fun formatSyncDate(instant: kotlin.time.Instant): String = formatInstant(instant, SYNC_DATE_PATTERN) +/** Format a Patreon ISO datetime string for display. Patreon hands us strings, not Instants. */ +fun formatPatreonDate(dateTimeStr: String): String { + if (dateTimeStr.isEmpty()) return "" + return try { + formatInstant(kotlin.time.Instant.parse(dateTimeStr), SYNC_DATE_PATTERN) + } catch (_: Exception) { + dateTimeStr + } +} + /** Format a kotlin.time.Instant with the given pattern, in [zone] (system zone by default). */ fun formatInstant( instant: kotlin.time.Instant, diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/Localization.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/Localization.kt index 1e4463180..af03e389f 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/Localization.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/Localization.kt @@ -3,7 +3,6 @@ package com.darkrockstudios.apps.hammer.frontend.utils import com.darkrockstudios.apps.hammer.admin.AdminServerConfig import com.darkrockstudios.apps.hammer.admin.ConfigRepository import com.darkrockstudios.apps.hammer.frontend.LOCALE_COOKIE_NAME -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry import com.darkrockstudios.apps.hammer.utilities.ResUtils import io.ktor.http.* import io.ktor.server.application.* @@ -88,19 +87,6 @@ suspend fun ApplicationCall.withMessages(data: Map = emptyMap()): M messages[key] = bundle.getString(key) } - // Plugin bundles layer on top, same English-baseline rule per bundle. - val pluginRegistry = runCatching { application.get() }.getOrNull() - pluginRegistry?.plugins?.mapNotNull { it.messageBundle() }?.forEach { bundleName -> - val pluginEnglish = ResourceBundle.getBundle(bundleName, Locale.ENGLISH) - pluginEnglish.keys.asSequence().forEach { key -> - messages[key] = pluginEnglish.getString(key) - } - val pluginLocalized = ResourceBundle.getBundle(bundleName, locale) - pluginLocalized.keys.asSequence().forEach { key -> - messages[key] = pluginLocalized.getString(key) - } - } - val availableLocales = ResUtils.getTranslatedLocales() val localesForTemplate = availableLocales.map { lc -> mapOf( diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SceneTreeModel.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SceneTreeModel.kt deleted file mode 100644 index af2965a7d..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SceneTreeModel.kt +++ /dev/null @@ -1,16 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend.utils - -import com.darkrockstudios.apps.hammer.story.SceneHierarchyItem - -/** Mustache model rows for the scene-select-tree partial, indent pre-computed. */ -fun sceneTreeModel(scenes: List): List> = - scenes.map { item -> - mapOf( - "id" to item.id, - "name" to item.name, - "isGroup" to item.isGroup, - "isScene" to item.isScene, - "depth" to item.depth, - "indentPx" to (item.depth * 18), - ) - } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLd.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLd.kt index ce36e1ccb..ccde3e729 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLd.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLd.kt @@ -37,7 +37,6 @@ private data class ArticleLd( val url: String, val author: PersonLd, val wordCount: Long? = null, - val inLanguage: String? = null, ) @Serializable @@ -74,7 +73,6 @@ fun storyArticleJsonLd( authorName: String, authorUrl: String, wordCount: Long? = null, - inLanguage: String? = null, ): String = jsonLdEncoder.encodeToString( ArticleLd( @@ -82,7 +80,6 @@ fun storyArticleJsonLd( url = url, author = PersonLd(name = authorName, url = authorUrl), wordCount = wordCount, - inLanguage = inLanguage, ), ).escapeForScript() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/StoryLookup.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/StoryLookup.kt deleted file mode 100644 index c4f9f47d2..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/StoryLookup.kt +++ /dev/null @@ -1,48 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend.utils - -import com.darkrockstudios.apps.hammer.Account -import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.project.access.ProjectAccessRepository -import com.darkrockstudios.apps.hammer.project.access.PublicProjectResult -import com.darkrockstudios.apps.hammer.projects.ProjectsRepository -import io.ktor.server.application.ApplicationCall - -data class StoryLookup( - val account: Account, - val projectName: String, - val result: PublicProjectResult, - /** The incoming, already URL-safe route segments, for self-referential links. */ - val penNameSegment: String, - val projectSegment: String, -) - -/** - * Resolves the `{penName}/{projectName}` route parameters of a public story URL to the access - * the reader gets with [password]. Null when the author or project does not exist. - */ -suspend fun ApplicationCall.lookUpStory( - accountsRepository: AccountsRepository, - projectsRepository: ProjectsRepository, - projectAccessRepository: ProjectAccessRepository, - password: String?, -): StoryLookup? { - val penNameParam = parameters["penName"] - val projectNameParam = parameters["projectName"] - if (penNameParam.isNullOrBlank() || projectNameParam.isNullOrBlank()) return null - - // Pen name verbatim first, then dashes as spaces. - val account = resolveByPenName(penNameParam) { accountsRepository.findAccountByPenName(it) } ?: return null - val penName = account.pen_name ?: return null - - // The id embedded in the segment is authoritative; the slug beside it is decorative. - val projectName = projectsRepository.findProjectByUrlSegment(account.id, projectNameParam)?.name - ?: return null - - return StoryLookup( - account = account, - projectName = projectName, - result = projectAccessRepository.findAccessibleProject(penName, projectName, password), - penNameSegment = penNameParam, - projectSegment = projectNameParam, - ) -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastUtils.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastUtils.kt index 92e606fbe..6feac81a7 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastUtils.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastUtils.kt @@ -1,19 +1,11 @@ package com.darkrockstudios.apps.hammer.frontend.utils import com.github.mustachejava.DefaultMustacheFactory -import io.ktor.htmx.HxResponseHeaders -import io.ktor.htmx.HxSwap import io.ktor.http.* import io.ktor.server.response.* import io.ktor.server.routing.* import java.io.StringWriter -/** - * Marks an error response whose body is an htmx swap payload. htmx discards 4xx and 5xx bodies by - * default; toast.js swaps the ones carrying this header so their toast reaches the user. - */ -const val SWAP_ERROR_HEADER = "X-Hammer-Swap-Error" - /** * Toast notification types for server-driven OOB swaps */ @@ -56,7 +48,12 @@ suspend fun RoutingContext.respondHtmlWithToast( toast: Toast = Toast.Success, status: HttpStatusCode = HttpStatusCode.OK ) { - respondSwap(content, message, toast, status) + val toastHtml = toastHtml(message, toast) + call.respondText( + text = "$content$toastHtml", + contentType = ContentType.Text.Html, + status = status + ) } /** @@ -68,32 +65,8 @@ suspend fun RoutingContext.respondToast( toast: Toast = Toast.Success, status: HttpStatusCode = HttpStatusCode.OK ) { - respondSwap(content = "", message = message, toast = toast, status = status) -} - -/** - * The single exit for htmx swap payloads: content, its toast, and the headers that decide what - * htmx does with an error response. Error statuses are marked with [SWAP_ERROR_HEADER] so the - * client swaps them at all, and those with nothing to show reswap to `none` so the toast lands - * without emptying the request's target. Whitespace counts as nothing to show: a template of - * all-conditional sections renders to a stray newline, which would blank the target just as - * thoroughly as an empty body. - */ -private suspend fun RoutingContext.respondSwap( - content: String, - message: String, - toast: Toast, - status: HttpStatusCode -) { - if (status.value >= 400) { - call.response.header(SWAP_ERROR_HEADER, "true") - if (content.isBlank()) { - call.response.header(HxResponseHeaders.Reswap, HxSwap.none) - } - } - call.respondText( - text = content + toastHtml(message, toast), + text = toastHtml(message, toast), contentType = ContentType.Text.Html, status = status ) @@ -124,5 +97,11 @@ suspend fun RoutingContext.respondTemplateWithToast( toast: Toast = Toast.Success, status: HttpStatusCode = HttpStatusCode.OK ) { - respondSwap(renderTemplate(templatePath, model), message, toast, status) + val content = renderTemplate(templatePath, model) + val toastHtml = toastHtml(message, toast) + call.respondText( + text = "$content$toastHtml", + contentType = ContentType.Text.Html, + status = status + ) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/KudosKind.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/KudosKind.kt deleted file mode 100644 index b21e31300..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/KudosKind.kt +++ /dev/null @@ -1,36 +0,0 @@ -package com.darkrockstudios.apps.hammer.kudos - -enum class KudosGroup(val maxPicks: Int) { - CRAFT(maxPicks = 4), - REACTION(maxPicks = 1), -} - -/** - * The chips a reader can pick. [key] is what the database stores, so it must never change - * once shipped; declaration order is display order. - */ -enum class KudosKind(val key: String, val group: KudosGroup) { - PROSE("prose", KudosGroup.CRAFT), - VOICE("voice", KudosGroup.CRAFT), - CHARACTERS("characters", KudosGroup.CRAFT), - DIALOGUE("dialogue", KudosGroup.CRAFT), - PLOT("plot", KudosGroup.CRAFT), - PACING("pacing", KudosGroup.CRAFT), - WORLDBUILDING("worldbuilding", KudosGroup.CRAFT), - ATMOSPHERE("atmosphere", KudosGroup.CRAFT), - OPENING("opening", KudosGroup.CRAFT), - ENDING("ending", KudosGroup.CRAFT), - MOVED_ME("moved_me", KudosGroup.REACTION), - MADE_ME_THINK("made_me_think", KudosGroup.REACTION), - MADE_ME_LAUGH("made_me_laugh", KudosGroup.REACTION), - SURPRISED_ME("surprised_me", KudosGroup.REACTION), - PAGE_TURNER("page_turner", KudosGroup.REACTION); - - val messageKey: String get() = "kudos_kind_$key" - - companion object { - private val byKey = entries.associateBy { it.key } - - fun fromKey(key: String): KudosKind? = byKey[key] - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepository.kt deleted file mode 100644 index 22e8ec322..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepository.kt +++ /dev/null @@ -1,80 +0,0 @@ -package com.darkrockstudios.apps.hammer.kudos - -import com.darkrockstudios.apps.hammer.database.StoryKudosDao - -sealed interface SetPicksResult { - data class Saved(val picks: Set) : SetPicksResult - data object OwnStory : SetPicksResult - data object Disabled : SetPicksResult - data object OverCap : SetPicksResult -} - -data class KudosTally( - val counts: Map, - val givers: Long, -) { - /** Kinds with at least one pick, most-picked first, ties in display order. */ - fun ranked(group: KudosGroup): List> = - counts.filterKeys { it.group == group } - .filterValues { it > 0 } - .toList() - .sortedWith(compareByDescending> { it.second }.thenBy { it.first.ordinal }) - - /** What the public page may show: names only, and only once enough readers agree. */ - fun publicHighlights(group: KudosGroup): List = - ranked(group).filter { it.second >= PUBLIC_THRESHOLD }.map { it.first } - - companion object { - const val PUBLIC_THRESHOLD = 3L - } -} - -class StoryKudosRepository( - private val storyKudosDao: StoryKudosDao, -) { - - suspend fun picksFor(projectId: Long, userId: Long): Set = - storyKudosDao.kindsForUser(projectId, userId).mapNotNullTo(mutableSetOf(), KudosKind::fromKey) - - /** - * Replaces the giver's picks. Picking a second reaction swaps it in for the previous one, - * so a whole-form submit with both checked keeps only the newly picked reaction. - */ - suspend fun setPicks( - projectId: Long, - authorId: Long, - giverId: Long, - requested: Set, - ): SetPicksResult { - if (giverId == authorId) return SetPicksResult.OwnStory - if (!isEnabled(projectId)) return SetPicksResult.Disabled - - val previous = picksFor(projectId, giverId) - val picks = swapReaction(requested, previous) - val overCap = KudosGroup.entries.any { group -> picks.count { it.group == group } > group.maxPicks } - if (overCap) return SetPicksResult.OverCap - - storyKudosDao.replacePicks(projectId, giverId, picks.mapTo(mutableSetOf()) { it.key }) - return SetPicksResult.Saved(picks) - } - - suspend fun tally(projectId: Long): KudosTally { - val keys = KudosKind.entries.map { it.key } - val counts = storyKudosDao.countsForProject(projectId, keys) - .mapNotNull { (key, count) -> KudosKind.fromKey(key)?.let { it to count } } - .toMap() - return KudosTally(counts = counts, givers = storyKudosDao.giverCountForProject(projectId, keys)) - } - - suspend fun isEnabled(projectId: Long): Boolean = !storyKudosDao.isOptedOut(projectId) - - suspend fun setEnabled(projectId: Long, enabled: Boolean) = - storyKudosDao.setOptedOut(projectId, optedOut = !enabled) - - private fun swapReaction(requested: Set, previous: Set): Set { - val reactions = requested.filter { it.group == KudosGroup.REACTION }.toSet() - if (reactions.size <= 1) return requested - val newlyPicked = reactions - previous - return if (newlyPicked.size == 1) requested - (reactions - newlyPicked) else requested - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/ConfigureMonitoringJob.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/ConfigureMonitoringJob.kt index a60fb2bcf..8a3a2be9e 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/ConfigureMonitoringJob.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/ConfigureMonitoringJob.kt @@ -5,7 +5,7 @@ import io.ktor.server.application.* import org.koin.ktor.ext.inject /** - * Starts the monitoring maintenance job. Unlike plugin-contributed jobs, this always + * Starts the monitoring maintenance job. Unlike the Patreon job, this always * starts: the master enable lives in the runtime [MonitoringConfig] and is * checked inside the loop, so toggling it does not require a restart. The loop * no-ops cheaply when monitoring is disabled. diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepository.kt index 15a27a751..12de7de8b 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepository.kt @@ -3,8 +3,6 @@ package com.darkrockstudios.apps.hammer.monitoring import com.darkrockstudios.apps.hammer.Login_attempt import com.darkrockstudios.apps.hammer.database.LoginAttemptDao import io.ktor.util.* -import io.ktor.util.logging.Logger -import kotlin.coroutines.cancellation.CancellationException import kotlin.time.Clock import kotlin.time.Instant import org.koin.core.component.KoinComponent @@ -12,37 +10,20 @@ import org.koin.core.component.KoinComponent /** * Records login attempts for brute-force visibility. Emails are stored * lower-cased so failure counts are stable regardless of how the attacker cased - * the address, and blank ones as null so they stay out of the per-account - * queries. The monitoring toggles are honored here rather than at the call - * sites, so callers always pass the source address and no login route can - * record what an operator has switched off. + * the address. The IP is optional — callers pass null when storeLoginIp is off. */ class SecurityRepository( private val loginAttemptDao: LoginAttemptDao, - private val monitoringState: MonitoringState, - private val log: Logger, private val clock: Clock, ) : KoinComponent { - /** - * Recording is passive observation, so a failed write is logged and swallowed - * rather than failing the sign-in that triggered it. - */ suspend fun recordLoginAttempt(email: String?, ipAddress: String?, success: Boolean) { - if (monitoringState.loginTrackingEnabled.not()) return - - try { - loginAttemptDao.recordAttempt( - email = email?.ifBlank { null }?.cleaned(), - ipAddress = ipAddress.takeIf { monitoringState.storeLoginIp }, - success = success, - at = clock.now(), - ) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - log.error("Failed to record login attempt", e) - } + loginAttemptDao.recordAttempt( + email = email?.cleaned(), + ipAddress = ipAddress, + success = success, + at = clock.now(), + ) } suspend fun countRecentFailures(email: String, since: Instant): Long = diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClient.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClient.kt new file mode 100644 index 000000000..0664ec882 --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClient.kt @@ -0,0 +1,191 @@ +package com.darkrockstudios.apps.hammer.patreon + +import io.ktor.client.* +import io.ktor.client.call.* +import io.ktor.client.engine.java.* +import io.ktor.client.plugins.contentnegotiation.* +import io.ktor.client.plugins.logging.* +import io.ktor.client.request.* +import io.ktor.http.* +import io.ktor.serialization.kotlinx.json.* +import kotlinx.serialization.Serializable +import kotlinx.serialization.json.Json +import org.slf4j.Logger +import java.security.MessageDigest +import javax.crypto.Mac +import javax.crypto.spec.SecretKeySpec + +@Serializable +data class PatreonMemberAttributes( + val email: String? = null, + val patron_status: String? = null, + val currently_entitled_amount_cents: Int = 0 +) + +@Serializable +data class PatreonMemberData( + val id: String, + val attributes: PatreonMemberAttributes? = null +) + +@Serializable +data class PatreonPaginationCursors( + val next: String? = null +) + +@Serializable +data class PatreonPagination( + val cursors: PatreonPaginationCursors? = null +) + +@Serializable +data class PatreonMeta( + val pagination: PatreonPagination? = null +) + +@Serializable +data class PatreonMembersResponse( + val data: List = emptyList(), + val meta: PatreonMeta? = null +) + +@Serializable +data class PatreonCampaignData( + val id: String, + val type: String +) + +@Serializable +data class PatreonCampaignsResponse( + val data: List = emptyList() +) + +class PatreonApiClient( + private val logger: Logger +) { + private val json = Json { + ignoreUnknownKeys = true + isLenient = true + } + + private val httpClient = HttpClient(Java) { + install(ContentNegotiation) { + json(json) + } + install(Logging) { + level = LogLevel.INFO + } + } + + suspend fun fetchAllQualifyingMembers( + campaignId: String, + accessToken: String, + minimumAmountCents: Int + ): Result> { + val allEmails = mutableListOf() + var cursor: String? = null + + try { + do { + val response = fetchMembersPage(campaignId, accessToken, cursor) + + response.data.forEach { member -> + val attributes = member.attributes + if (attributes != null && + attributes.patron_status == "active_patron" && + attributes.currently_entitled_amount_cents >= minimumAmountCents && + !attributes.email.isNullOrBlank() + ) { + allEmails.add(attributes.email) + } + } + + cursor = response.meta?.pagination?.cursors?.next + } while (cursor != null) + + return Result.success(allEmails) + // API boundary: any failure becomes a failed Result. + } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { + logger.error("Failed to fetch Patreon members", e) + return Result.failure(e) + } + } + + private suspend fun fetchMembersPage( + campaignId: String, + accessToken: String, + cursor: String? = null + ): PatreonMembersResponse { + val url = buildString { + append("https://www.patreon.com/api/oauth2/v2/campaigns/$campaignId/members") + append("?fields[member]=email,patron_status,currently_entitled_amount_cents") + append("&page[count]=1000") + if (cursor != null) { + append("&page[cursor]=$cursor") + } + } + + val response = httpClient.get(url) { + header(HttpHeaders.Authorization, "Bearer $accessToken") + header(HttpHeaders.UserAgent, "HammerServer/1.0") + } + + if (!response.status.isSuccess()) { + throw PatreonApiException("Patreon API returned ${response.status}") + } + + return response.body() + } + + suspend fun fetchCampaignId(accessToken: String): Result { + return try { + val url = "https://www.patreon.com/api/oauth2/v2/campaigns" + + val response = httpClient.get(url) { + header(HttpHeaders.Authorization, "Bearer $accessToken") + header(HttpHeaders.UserAgent, "HammerServer/1.0") + } + + if (!response.status.isSuccess()) { + return Result.failure(PatreonApiException("Patreon API returned ${response.status}")) + } + + val campaignsResponse: PatreonCampaignsResponse = response.body() + + if (campaignsResponse.data.isEmpty()) { + return Result.failure(PatreonApiException("No campaigns found for this account")) + } + + // Return the first campaign ID + Result.success(campaignsResponse.data.first().id) + } catch (e: Exception) { + logger.error("Failed to fetch campaign ID", e) + Result.failure(e) + } + } + + fun verifyWebhookSignature(payload: String, signature: String, secret: String): Boolean { + return try { + val mac = Mac.getInstance("HmacMD5") + val secretKey = SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + val computedSignature = hash.joinToString("") { "%02x".format(it) } + // Constant-time compare: a byte-by-byte String.equals leaks, via timing, + // how long a prefix of the expected signature an attacker guessed right. + MessageDigest.isEqual( + computedSignature.toByteArray(Charsets.UTF_8), + signature.lowercase().toByteArray(Charsets.UTF_8), + ) + } catch (e: Exception) { + logger.error("Failed to verify webhook signature", e) + false + } + } + + fun close() { + httpClient.close() + } +} + +class PatreonApiException(message: String) : Exception(message) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonConfig.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonConfig.kt new file mode 100644 index 000000000..cb58fa214 --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonConfig.kt @@ -0,0 +1,15 @@ +package com.darkrockstudios.apps.hammer.patreon + +import kotlinx.serialization.Serializable + +@Serializable +data class PatreonConfig( + val enabled: Boolean = false, + val campaignId: String = "", + val creatorAccessToken: String = "", + val webhookSecret: String = "", + val patreonUrl: String = "", + val minimumAmountCents: Int = 500, + val pollIntervalMinutes: Int = 60, + val lastSync: String = "" +) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonPollingJob.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonPollingJob.kt new file mode 100644 index 000000000..fd9f2ed3d --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonPollingJob.kt @@ -0,0 +1,31 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.scheduling.RecurringTask +import org.slf4j.Logger +import kotlin.time.Duration.Companion.minutes + +class PatreonPollingJob( + private val patreonSyncService: PatreonSyncService, + private val configRepository: ConfigRepository, + logger: Logger, +) : RecurringTask("Patreon polling job", logger) { + + override suspend fun tick() { + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + if (config.enabled) { + logger.info("Running scheduled Patreon sync") + val result = patreonSyncService.performFullSync() + if (result.isFailure) { + logger.error("Scheduled Patreon sync failed", result.exceptionOrNull()) + } + } + } + + override suspend fun nextDelay() = + configRepository.get(AdminServerConfig.PATREON_CONFIG).pollIntervalMinutes.coerceAtLeast(1).minutes + + /** Back off longer after a failure (e.g. a sync error or an unreadable config) before retrying. */ + override suspend fun errorBackoff() = 5.minutes +} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonRoutes.kt new file mode 100644 index 000000000..681d731a9 --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonRoutes.kt @@ -0,0 +1,64 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.ServerConfig +import io.ktor.http.* +import io.ktor.server.request.* +import io.ktor.server.response.* +import io.ktor.server.routing.* +import org.koin.ktor.ext.inject + +fun Route.patreonRoutes(serverConfig: ServerConfig) { + // Only set up routes if Patreon is enabled at server level + if (serverConfig.patreonEnabled != true) { + return + } + + val webhookHandler: PatreonWebhookHandler by inject() + + route("/patreon") { + webhookEndpoint(serverConfig, webhookHandler) + } +} + +private fun Route.webhookEndpoint( + serverConfig: ServerConfig, + webhookHandler: PatreonWebhookHandler +) { + post("/webhook") { + // Check if Patreon is enabled at server level + if (serverConfig.patreonEnabled != true) { + call.respond(HttpStatusCode.NotFound) + return@post + } + + val signature = call.request.headers["X-Patreon-Signature"] + val eventType = call.request.headers["X-Patreon-Event"] + val payload = call.receiveText() + + when (val result = webhookHandler.handleWebhook(payload, signature, eventType)) { + is WebhookResult.Disabled -> { + call.respond(HttpStatusCode.NotFound) + } + + is WebhookResult.MissingSignature -> { + call.respond(HttpStatusCode.BadRequest, "Missing signature") + } + + is WebhookResult.NotConfigured -> { + call.respond(HttpStatusCode.InternalServerError, "Webhook not configured") + } + + is WebhookResult.InvalidSignature -> { + call.respond(HttpStatusCode.Unauthorized, "Invalid signature") + } + + is WebhookResult.Success -> { + call.respond(HttpStatusCode.OK, "Sync completed") + } + + is WebhookResult.SyncFailed -> { + call.respond(HttpStatusCode.InternalServerError, result.error) + } + } + } +} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncService.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncService.kt new file mode 100644 index 000000000..2a33c7d0b --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncService.kt @@ -0,0 +1,141 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.account.AccountsRepository +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.admin.WhiteListRepository +import io.ktor.util.* +import kotlinx.serialization.Serializable +import org.slf4j.Logger +import kotlin.time.Clock + +@Serializable +data class SyncResult( + val added: Int, + val removed: Int, + val skipped: Int, + val errors: List = emptyList() +) + +class PatreonSyncService( + private val patreonApiClient: PatreonApiClient, + private val whiteListRepository: WhiteListRepository, + private val accountsRepository: AccountsRepository, + private val configRepository: ConfigRepository, + private val clock: Clock, + private val logger: Logger +) { + companion object { + const val WHITELIST_REASON = "Patreon" + } + + suspend fun performFullSync(): Result { + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + + if (!config.enabled) { + logger.info("Patreon sync skipped - disabled in config") + return Result.success(SyncResult(added = 0, removed = 0, skipped = 0)) + } + + if (config.campaignId.isBlank() || config.creatorAccessToken.isBlank()) { + logger.warn("Patreon sync skipped - missing campaign ID or access token") + return Result.failure(PatreonSyncException("Missing campaign ID or access token")) + } + + logger.info("Starting Patreon sync for campaign ${config.campaignId}") + + // 1. Get qualifying patrons from Patreon API + val patreonResult = patreonApiClient.fetchAllQualifyingMembers( + campaignId = config.campaignId, + accessToken = config.creatorAccessToken, + minimumAmountCents = config.minimumAmountCents + ) + + if (patreonResult.isFailure) { + return Result.failure(patreonResult.exceptionOrNull()!!) + } + + val patreonEmails = patreonResult.getOrThrow() + .map { it.trim().toLowerCasePreservingASCIIRules() } + .toSet() + + logger.info("Found ${patreonEmails.size} qualifying Patreon members") + + // 2. Get current Patreon-managed whitelist entries ONLY + val currentPatreonEntries = whiteListRepository.getWhiteListByReason(WHITELIST_REASON) + .map { it.email } + .toSet() + + logger.info("Found ${currentPatreonEntries.size} existing Patreon whitelist entries") + + // 3. Add new patrons (only if not already whitelisted with ANY reason) + var addedCount = 0 + var skippedCount = 0 + val errors = mutableListOf() + + for (email in patreonEmails) { + try { + if (!whiteListRepository.isOnWhiteList(email)) { + whiteListRepository.addToWhiteList(email, WHITELIST_REASON) + logger.info("Added Patreon member to whitelist: $email") + addedCount++ + } else if (email !in currentPatreonEntries) { + // Already whitelisted with different reason - skip + logger.debug("Skipping Patreon member (already whitelisted): $email") + skippedCount++ + } + // Per-member: one failure must not abort the whole sync. + } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { + logger.error("Failed to add Patreon member to whitelist: $email", e) + errors.add("Failed to add $email: ${e.message}") + } + } + + // 4. Remove lapsed patrons + force logout (only Patreon-managed entries) + var removedCount = 0 + val toRemove = currentPatreonEntries - patreonEmails + + for (email in toRemove) { + try { + whiteListRepository.removeFromWhiteList(email) + forceLogout(email) + logger.info("Removed lapsed Patreon member from whitelist: $email") + removedCount++ + } catch (e: Exception) { + logger.error("Failed to remove Patreon member from whitelist: $email", e) + errors.add("Failed to remove $email: ${e.message}") + } + } + + // Update last sync time + val updatedConfig = config.copy(lastSync = clock.now().toString()) + configRepository.set(AdminServerConfig.PATREON_CONFIG, updatedConfig) + + val result = SyncResult( + added = addedCount, + removed = removedCount, + skipped = skippedCount, + errors = errors + ) + + logger.info("Patreon sync completed: added=$addedCount, removed=$removedCount, skipped=$skippedCount, errors=${errors.size}") + + return Result.success(result) + } + + suspend fun forceLogout(email: String) { + if (accountsRepository.forceLogout(email)) { + logger.info("Force logged out user: $email") + } + } + + suspend fun getPatreonWhitelistCount(): Long { + return whiteListRepository.getWhiteListByReason(WHITELIST_REASON).size.toLong() + } + + suspend fun getPatreonMembersWithAccountsCount(): Long { + return whiteListRepository.countByReasonWithAccounts(WHITELIST_REASON) + } +} + +class PatreonSyncException(message: String) : Exception(message) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandler.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandler.kt new file mode 100644 index 000000000..023cb7d72 --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandler.kt @@ -0,0 +1,62 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import org.slf4j.Logger + +class PatreonWebhookHandler( + private val patreonApiClient: PatreonApiClient, + private val patreonSyncService: PatreonSyncService, + private val configRepository: ConfigRepository, + private val logger: Logger +) { + suspend fun handleWebhook( + payload: String, + signature: String?, + eventType: String? + ): WebhookResult { + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + + if (!config.enabled) { + logger.info("Patreon webhook received but integration is disabled") + return WebhookResult.Disabled + } + + if (signature.isNullOrBlank()) { + logger.warn("Patreon webhook missing signature header") + return WebhookResult.MissingSignature + } + + if (config.webhookSecret.isBlank()) { + logger.warn("Patreon webhook secret not configured") + return WebhookResult.NotConfigured + } + + // Verify signature + if (!patreonApiClient.verifyWebhookSignature(payload, signature, config.webhookSecret)) { + logger.warn("Patreon webhook signature verification failed") + return WebhookResult.InvalidSignature + } + + logger.info("Received valid Patreon webhook: $eventType") + + // On any member event, trigger a full sync + // This is the simplest and most reliable approach + val syncResult = patreonSyncService.performFullSync() + + return if (syncResult.isSuccess) { + WebhookResult.Success(syncResult.getOrThrow()) + } else { + WebhookResult.SyncFailed(syncResult.exceptionOrNull()?.message ?: "Unknown error") + } + } +} + +sealed class WebhookResult { + data object Disabled : WebhookResult() + data object MissingSignature : WebhookResult() + data object NotConfigured : WebhookResult() + data object InvalidSignature : WebhookResult() + data class Success(val syncResult: SyncResult) : WebhookResult() + data class SyncFailed(val error: String) : WebhookResult() +} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/configurePatreonPolling.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/configurePatreonPolling.kt new file mode 100644 index 000000000..7e31d3bed --- /dev/null +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/patreon/configurePatreonPolling.kt @@ -0,0 +1,16 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.ServerConfig +import com.darkrockstudios.apps.hammer.scheduling.launchRecurringTask +import io.ktor.server.application.* +import org.koin.ktor.ext.inject + +fun Application.configurePatreonPolling(config: ServerConfig) { + if (config.patreonEnabled == true) { + val pollingJob: PatreonPollingJob by inject() + launchRecurringTask(pollingJob) + log.info("Patreon polling job started") + } else { + log.info("Patreon integration disabled at server level") + } +} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/AllowedUsersSource.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/AllowedUsersSource.kt deleted file mode 100644 index 8cc05dc19..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/AllowedUsersSource.kt +++ /dev/null @@ -1,49 +0,0 @@ -package com.darkrockstudios.apps.hammer.plugin - -import com.darkrockstudios.apps.hammer.utilities.Msg -import io.ktor.server.application.* - -/** - * Where an [AllowedUsersSource] notice is rendered. Each slot is inserted unescaped, so - * sources return trusted HTML, typically from their own mustache template. - */ -enum class NoticeSlot { - /** Info panel on the web login page. */ - LOGIN, - - /** Info panel on the web signup page. */ - SIGNUP, - - /** Instance notice band on the home page. */ - HOME_BANNER, - - /** Social/links row in the site footer. */ - FOOTER, -} - -/** - * A system that decides who belongs on the allowed-users list, e.g. a membership service - * that syncs subscribers onto it. - * - * The [id] doubles as the `WhiteListRepository` reason tag: a source must only add and - * remove entries carrying its own tag, so manually-added entries and other sources' - * entries survive its syncs. - */ -interface AllowedUsersSource { - val id: String - - /** Fully configured and turned on. Inactive sources contribute no notices. */ - suspend fun isActive(): Boolean - - /** - * HTML for [slot]. Null falls back to the stock template content for that slot; an - * empty string replaces the stock content with nothing. - */ - suspend fun notice(call: ApplicationCall, slot: NoticeSlot): String? - - /** - * Shown by the native client when signup/login is rejected because the user is not - * on the allowed list. Null falls back to the stock rejection message. - */ - suspend fun rejectionMessage(): Msg? -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/InstalledPlugins.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/InstalledPlugins.kt deleted file mode 100644 index 292cec499..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/InstalledPlugins.kt +++ /dev/null @@ -1,7 +0,0 @@ -package com.darkrockstudios.apps.hammer.plugin - -/** - * The plugins compiled into this build. Downstream distributions register theirs here; - * keep this file otherwise untouched so their patch applies cleanly. - */ -fun installedPlugins(): List = listOf() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginRegistry.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginRegistry.kt deleted file mode 100644 index f8c7ad00e..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginRegistry.kt +++ /dev/null @@ -1,32 +0,0 @@ -package com.darkrockstudios.apps.hammer.plugin - -import org.slf4j.Logger - -/** - * The [installedPlugins] active in this build. Everything that consumes plugin - * contributions (routing, DI, admin UI, notices) goes through this. - */ -class PluginRegistry(val plugins: List) { - - // Lazy: the registry is built before Koin starts, and a source may inject dependencies - // when constructed. First access happens at request time, when the graph is up. - private val sources: List by lazy { plugins.mapNotNull { it.allowedUsersSource() } } - - /** Reason tags owned by a source, whose whitelist entries the admin must not hand-edit. */ - val allowedUsersSourceIds: Set by lazy { sources.map { it.id }.toSet() } - - /** - * The allow-list source currently in effect, or null if none is active. With multiple - * active sources the first by registration order wins for notices; syncing is - * unaffected since each source only touches entries tagged with its own id. - */ - suspend fun activeAllowedUsersSource(): AllowedUsersSource? = - sources.firstOrNull { it.isActive() } - - companion object { - fun create(plugins: List, logger: Logger): PluginRegistry { - plugins.forEach { logger.info("Server plugin '${it.id}' installed") } - return PluginRegistry(plugins) - } - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginWiring.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginWiring.kt deleted file mode 100644 index fc89846c1..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/PluginWiring.kt +++ /dev/null @@ -1,81 +0,0 @@ -package com.darkrockstudios.apps.hammer.plugin - -import com.darkrockstudios.apps.hammer.scheduling.launchRecurringTask -import io.ktor.server.application.* -import io.ktor.server.request.* -import io.ktor.server.routing.* -import io.ktor.util.* -import org.koin.ktor.ext.get -import org.koin.ktor.ext.inject - -/** Mounts every enabled plugin's public routes at the receiver. */ -fun Route.installPluginRoutes() { - val pluginRegistry: PluginRegistry by application.inject() - pluginRegistry.plugins.forEach { it.installRoutes(this) } -} - -/** Mounts every enabled plugin's admin routes at the receiver, inside the admin gate. */ -fun Route.installPluginAdminRoutes() { - val pluginRegistry: PluginRegistry by application.inject() - pluginRegistry.plugins.forEach { it.installAdminRoutes(this) } -} - -/** Starts every enabled plugin's recurring tasks. */ -fun Application.launchPluginTasks() { - val pluginRegistry: PluginRegistry by inject() - pluginRegistry.plugins - .flatMap { it.recurringTasks(this) } - .forEach { launchRecurringTask(it) } -} - -/** - * Every enabled plugin's admin nav entries as mustache model maps, marking the entry - * whose href the current request is under as active. Admin page models put this under - * `pluginNavEntries` for the admin-nav partial. - */ -suspend fun ApplicationCall.pluginAdminNav(): List> { - val pluginRegistry: PluginRegistry = application.get() - val path = request.path() - return pluginRegistry.plugins - .flatMap { it.adminNavEntries() } - .map { entry -> - mapOf( - "href" to entry.href, - "icon" to entry.icon, - "label" to entry.label(this), - "active" to (path == entry.href || path.startsWith("${entry.href}/")), - ) - } -} - -/** - * The allow-list source currently in effect, or null if none is active. Resolved once per - * request: isActive() may cost a config read, and several model builders ask per render. - */ -suspend fun ApplicationCall.activeAllowedUsersSource(): AllowedUsersSource? { - attributes.getOrNull(activeSourceKey)?.let { return it.source } - val source = application.get().activeAllowedUsersSource() - attributes.put(activeSourceKey, CachedActiveSource(source)) - return source -} - -private val activeSourceKey = AttributeKey("ActiveAllowedUsersSource") - -private class CachedActiveSource(val source: AllowedUsersSource?) - -/** - * Applies [AllowedUsersSource.notice] for [slot] to a template model: [providedKey] is set - * when an active source answered (suppressing the stock content), [htmlKey] only when there - * is markup to render. Returns the raw notice, null when no active source provided one. - */ -suspend fun ApplicationCall.putAllowedUsersNotice( - model: MutableMap, - slot: NoticeSlot, - htmlKey: String = "allowedUsersNoticeHtml", - providedKey: String = "allowedUsersNoticeProvided", -): String? { - val html = activeAllowedUsersSource()?.notice(this, slot) ?: return null - model[providedKey] = true - if (html.isNotBlank()) model[htmlKey] = html - return html -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/ServerPlugin.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/ServerPlugin.kt deleted file mode 100644 index 8fee4f77f..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugin/ServerPlugin.kt +++ /dev/null @@ -1,54 +0,0 @@ -package com.darkrockstudios.apps.hammer.plugin - -import com.darkrockstudios.apps.hammer.scheduling.RecurringTask -import io.ktor.server.application.* -import io.ktor.server.routing.* -import org.koin.core.module.Module - -/** - * A server extension. Registering it in [installedPlugins] is what activates it; there is - * no separate enablement switch. - * - * Plugins compile as part of `:server`, so they may use anything in it, including Koin - * injection inside route handlers and tasks. - */ -interface ServerPlugin { - /** Stable identifier, also used as this plugin's allow-list reason tag. */ - val id: String - - /** Koin definitions for this plugin, installed alongside the main module. */ - fun koinModule(): Module? = null - - /** Public routes, mounted at the routing root. */ - fun installRoutes(route: Route) {} - - /** Admin routes, mounted under `/admin` inside the admin-only gate. */ - fun installAdminRoutes(route: Route) {} - - /** Entries appended to the admin navigation. */ - fun adminNavEntries(): List = emptyList() - - /** - * Base name of this plugin's resource bundle (e.g. `i18n.MyPluginMessages`), merged into - * every page's template msg map. Must resolve for Locale.ENGLISH, so ship a base or `_en` - * variant. Null contributes nothing. - */ - fun messageBundle(): String? = null - - /** Background jobs to launch at startup. */ - fun recurringTasks(application: Application): List = emptyList() - - /** The allow-list source this plugin provides, if any. */ - fun allowedUsersSource(): AllowedUsersSource? = null -} - -/** - * @param href absolute path, e.g. `/admin/patreon`. Also used to mark the entry active. - * @param icon Font Awesome classes, e.g. `fa-brands fa-patreon`. - * @param label localized label for the current request. - */ -data class AdminNavEntry( - val href: String, - val icon: String, - val label: suspend (ApplicationCall) -> String, -) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/DependencyInjection.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/DependencyInjection.kt index ecd707798..633954d39 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/DependencyInjection.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/DependencyInjection.kt @@ -3,9 +3,6 @@ package com.darkrockstudios.apps.hammer.plugins import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.database.Database import com.darkrockstudios.apps.hammer.dependencyinjection.mainModule -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry -import com.darkrockstudios.apps.hammer.plugin.ServerPlugin -import com.darkrockstudios.apps.hammer.plugin.installedPlugins import io.ktor.server.application.* import org.koin.core.module.Module import org.koin.dsl.module @@ -13,25 +10,17 @@ import org.koin.ktor.ext.get import org.koin.ktor.plugin.Koin import org.koin.logger.slf4jLogger -fun Application.configureDependencyInjection( - serverConfig: ServerConfig = ServerConfig(), - addInModule: Module? = null, - plugins: List = installedPlugins(), -) { +fun Application.configureDependencyInjection(serverConfig: ServerConfig = ServerConfig(), addInModule: Module? = null) { val logger = log - val pluginRegistry = PluginRegistry.create(plugins, logger) - val serverConfigModule = module { single { serverConfig } - single { pluginRegistry } } install(Koin) { slf4jLogger() val modules = mutableListOf(mainModule(logger), serverConfigModule) - pluginRegistry.plugins.mapNotNullTo(modules) { it.koinModule() } if (addInModule != null) { modules.add(addInModule) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/HTTP.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/HTTP.kt index da89256d5..cd43306f0 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/HTTP.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/HTTP.kt @@ -17,21 +17,12 @@ import io.ktor.server.plugins.compression.gzip import io.ktor.server.plugins.compression.minimumSize import io.ktor.server.plugins.conditionalheaders.ConditionalHeaders import io.ktor.server.plugins.defaultheaders.DefaultHeaders -import io.ktor.server.plugins.forwardedheaders.XForwardedHeaders import io.ktor.server.plugins.hsts.HSTS import io.ktor.server.plugins.httpsredirect.HttpsRedirect import io.ktor.server.request.path import io.ktor.server.routing.IgnoreTrailingSlash fun Application.configureHTTP(config: ServerConfig) { - if (config.trustProxyForwarding) { - install(XForwardedHeaders) { - // Ktor defaults to the first X-Forwarded-For entry, which the client supplies. - // Only the last is the adjacent proxy's own observation of who connected. - useLastProxy() - } - } - val analyticsProvider = config.analytics.provider val analyticsScriptHosts = analyticsProvider?.scriptSrcHosts().orEmpty() val analyticsConnectHosts = analyticsProvider?.connectSrcHosts().orEmpty() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Localization.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Localization.kt index 8f69f3d92..c9efc91bf 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Localization.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Localization.kt @@ -2,9 +2,6 @@ package com.darkrockstudios.apps.hammer.plugins import com.darkrockstudios.apps.hammer.utilities.ResUtils import com.github.aymanizz.ktori18n.I18n -import com.github.aymanizz.ktori18n.KeyGenerator -import com.github.aymanizz.ktori18n.MessageResolver -import com.github.aymanizz.ktori18n.ResourceBundleMessageResolver import io.ktor.server.application.* import java.util.* @@ -12,26 +9,8 @@ fun Application.configureLocalization() { install(I18n) { supportedLocales = ResUtils.getTranslatedLocales() defaultLocale = Locale.ENGLISH - messageResolver = EnglishFallbackMessageResolver() //useOfCookie = true //useOfRedirection = true //excludePrefixes("/api") } -} - -/** - * A locale bundle has no parent bundle to inherit from, so a key its translation - * doesn't carry yet resolves against English rather than throwing - * MissingResourceException at the caller. - */ -private class EnglishFallbackMessageResolver : MessageResolver { - private val delegate = ResourceBundleMessageResolver() - - override fun t(locale: Locale, keyGenerator: KeyGenerator, vararg args: Any): String = - try { - delegate.t(locale, keyGenerator, *args) - } catch (e: MissingResourceException) { - if (locale.language == Locale.ENGLISH.language) throw e - delegate.t(Locale.ENGLISH, keyGenerator, *args) - } -} +} \ No newline at end of file diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Routing.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Routing.kt index a1fa79cf9..be07c2dd0 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Routing.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Routing.kt @@ -5,7 +5,7 @@ import com.darkrockstudios.apps.hammer.account.accountRoutes import com.darkrockstudios.apps.hammer.admin.adminRoutes import com.darkrockstudios.apps.hammer.base.http.API_ROUTE_PREFIX import com.darkrockstudios.apps.hammer.frontend.frontend -import com.darkrockstudios.apps.hammer.plugin.installPluginRoutes +import com.darkrockstudios.apps.hammer.patreon.patreonRoutes import com.darkrockstudios.apps.hammer.project.projectRoutes import com.darkrockstudios.apps.hammer.projects.projectsRoutes import com.darkrockstudios.apps.hammer.storyideas.ideasRoutes @@ -20,7 +20,7 @@ fun Application.configureRouting(serverConfig: ServerConfig = ServerConfig()) { val logger = log routing { frontend() - installPluginRoutes() + patreonRoutes(serverConfig) route(API_ROUTE_PREFIX) { accountRoutes() projectsRoutes() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Security.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Security.kt index 2d7018fb7..028469938 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Security.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Security.kt @@ -36,15 +36,18 @@ fun Application.configureSecurity() { val userId = parameters["userId"]?.toLongOrNull() ?: INVALID_USER_ID val result = accountRepo.checkToken(userId, tokenCredential.token) if (isSuccess(result)) { - // deleted_at is checked before the admin allowance so a - // soft-deleted admin is locked out like anyone else. - val account = accountRepo.getAccountOrNull(result.data) - val okay = account != null && - account.deleted_at == null && - (account.is_admin || whitelistRepo.isOnWhiteList(account.email)) + val okay = if (whitelistRepo.useWhiteList()) { + val account = accountRepo.getAccount(userId) + account.is_admin || whitelistRepo.isOnWhiteList(account.email) + } else { + true + } + + val dbUserId = result.data + ServerUserIdPrincipal(dbUserId) if (okay) { - ServerUserIdPrincipal(result.data) + ServerUserIdPrincipal(dbUserId) } else { null } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Serialization.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Serialization.kt index 59dce8f6d..c08286a28 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Serialization.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/Serialization.kt @@ -1,12 +1,11 @@ package com.darkrockstudios.apps.hammer.plugins -import com.darkrockstudios.apps.hammer.base.http.createNetworkJsonSerializer import io.ktor.serialization.kotlinx.json.* import io.ktor.server.application.* import io.ktor.server.plugins.contentnegotiation.* fun Application.configureSerialization() { install(ContentNegotiation) { - json(createNetworkJsonSerializer()) + json() } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/SetupModePlugin.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/SetupModePlugin.kt index 18286ccc7..8e2e8b0ce 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/SetupModePlugin.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/plugins/SetupModePlugin.kt @@ -12,8 +12,7 @@ import java.util.concurrent.atomic.AtomicBoolean /** * Plugin that redirects frontend requests to the setup page when no users exist in the database. - * The setup page lets the admin create the first account directly, or shows instructions for - * creating it via the Hammer app. + * This allows admins to see instructions for creating their first account via the Hammer app. * * API routes are NOT blocked - they must remain accessible so the Hammer app can create the first account. */ diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatabaseDatasource.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatabaseDatasource.kt index 6c1abc4d4..f720700ea 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatabaseDatasource.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatabaseDatasource.kt @@ -329,11 +329,15 @@ class ProjectEntityDatabaseDatasource( userId: Long, projectId: ProjectId, newProjectName: String - ): Boolean = projectDao.updateProjectName( - userId = userId, - projectUuid = projectId, - newName = newProjectName, - ) + ): Boolean { + projectDao.updateProjectName( + userId = userId, + projectUuid = projectId, + newName = newProjectName, + ) + + return true + } override suspend fun getProject(userId: Long, projectId: ProjectId): ProjectDefinition? { val projectData = projectDao.getProjectData(userId, projectId) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatasource.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatasource.kt index beb3dc789..e478bf1e8 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatasource.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectEntityDatasource.kt @@ -68,7 +68,6 @@ interface ProjectEntityDatasource { type: ApiProjectEntity.Type ): List - /** False when the account already holds another project under [newProjectName]. */ suspend fun renameProject(userId: Long, projectId: ProjectId, newProjectName: String): Boolean /** All of a project's entity ids paired with their cached hashes, in one query, sorted by id. */ diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectRepositoryExceptions.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectRepositoryExceptions.kt index b00209c37..3821a6ae4 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectRepositoryExceptions.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ProjectRepositoryExceptions.kt @@ -29,6 +29,3 @@ class ProjectNotFound(val projectId: ProjectId) : class InvalidProjectName(val name: String) : Exception("Invalid project name: $name") - -class ProjectNameTaken(val name: String) : - Exception("This account already has a project named: $name") diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/SceneSetLoader.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/SceneSetLoader.kt deleted file mode 100644 index 6a7ce85d2..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/SceneSetLoader.kt +++ /dev/null @@ -1,45 +0,0 @@ -package com.darkrockstudios.apps.hammer.project - -import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.http.ApiSceneType -import com.darkrockstudios.apps.hammer.utilities.isFailure - -sealed class SceneSetResult { - data class Success(val scenes: List) : SceneSetResult() - data class InvalidId(val id: Int, val exception: Throwable? = null) : SceneSetResult() - - /** The id resolves to a scene GROUP, which carries no prose of its own. */ - data class NotAScene(val id: Int) : SceneSetResult() -} - -/** - * Loads and validates a set of leaf-scene ids in one pass: existence is checked against a - * single defs query, then each scene is loaded and group ids are rejected. Groups share - * [ApiProjectEntity.Type.SCENE] with leaf scenes, so a type check alone cannot tell them apart. - */ -suspend fun ProjectEntityDatasource.loadSceneSet( - userId: Long, - projectDef: ProjectDefinition, - sceneIds: Collection, -): SceneSetResult { - val validIds = getEntityDefsByType( - userId = userId, - projectDef = projectDef, - type = ApiProjectEntity.Type.SCENE, - ).map { it.id }.toSet() - - val scenes = ArrayList(sceneIds.size) - for (sceneId in sceneIds) { - if (sceneId !in validIds) return SceneSetResult.InvalidId(sceneId) - val result = loadEntity( - userId, projectDef, sceneId, - ApiProjectEntity.Type.SCENE, - ApiProjectEntity.SceneEntity.serializer(), - ) - if (isFailure(result)) return SceneSetResult.InvalidId(sceneId, result.exception) - val scene = result.data - if (scene.sceneType != ApiSceneType.Scene) return SceneSetResult.NotAScene(sceneId) - scenes += scene - } - return SceneSetResult.Success(scenes) -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ServerProjectDataRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ServerProjectDataRepository.kt index b2640a417..4b6c9f8a2 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ServerProjectDataRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/ServerProjectDataRepository.kt @@ -42,28 +42,6 @@ class ServerProjectDataRepository( return SResult.success(RawProjectDataDto(data = data, hash = row.hash)) } - /** - * The stored project-data hash, for HTTP validators: it changes with any project-data - * edit (including the declared language) without transferring or parsing the content. - * Null when the project has no data row. - */ - suspend fun loadDataHash(userId: Long, projectDef: ProjectDefinition): String? { - val projectId = projectDao.getProjectIdOrNull(userId, projectDef.uuid) ?: return null - return projectDataDao.getHash(userId, projectId) - } - - /** The project's declared BCP-47 language for public-page metadata; null when unset or unreadable. */ - suspend fun loadProjectLanguage(userId: Long, projectDef: ProjectDefinition): String? { - val projectId = projectDao.getProjectIdOrNull(userId, projectDef.uuid) ?: return null - val row = projectDataDao.get(userId, projectId) ?: return null - val element = try { - json.parseToJsonElement(row.content) - } catch (e: SerializationException) { - return null - } - return decodeAsProjectData(element)?.language?.takeIf { it.isNotBlank() } - } - suspend fun save( userId: Long, projectDef: ProjectDefinition, diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepository.kt index a99462c2e..7e775d8cf 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepository.kt @@ -2,16 +2,10 @@ package com.darkrockstudios.apps.hammer.project.access import com.darkrockstudios.apps.hammer.Project_access import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity import com.darkrockstudios.apps.hammer.database.CommunityFeedStory import com.darkrockstudios.apps.hammer.database.ProjectAccessDao import com.darkrockstudios.apps.hammer.database.ProjectDao import com.darkrockstudios.apps.hammer.database.PublishedStoryInfo -import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource -import com.darkrockstudios.apps.hammer.project.SceneSetResult -import com.darkrockstudios.apps.hammer.project.loadSceneSet -import com.darkrockstudios.apps.hammer.utilities.Msg -import com.darkrockstudios.apps.hammer.utilities.SResult import java.time.ZoneId import java.time.format.DateTimeFormatter import kotlin.time.Clock @@ -31,8 +25,6 @@ sealed class PublicProjectResult { val projectName: String, val penName: String, val isPublic: Boolean, - /** Scene ids this share is limited to; null exposes the entire story. */ - val sceneIds: Set? = null, ) : PublicProjectResult() data object NotFound : PublicProjectResult() @@ -45,26 +37,12 @@ data class AccessEntryInfo( val password: String?, val expiresAt: Instant?, val expiresAtFormatted: String?, - val isExpired: Boolean, - /** Number of still-existing scenes this share is limited to; null exposes the entire story. */ - val sceneCount: Int? = null, -) { - val isRestricted: Boolean - get() = sceneCount != null - - /** Restricted, but every selected scene has since been deleted: the link is dead. */ - val isSceneless: Boolean - get() = sceneCount == 0 - - /** Pluralization hook for the Mustache access list. */ - val isSingleScene: Boolean - get() = sceneCount == 1 -} + val isExpired: Boolean +) class ProjectAccessRepository( private val projectAccessDao: ProjectAccessDao, private val projectDao: ProjectDao, - private val projectEntityDatasource: ProjectEntityDatasource, private val clock: Clock, ) { suspend fun getAccessForProject(userId: Long, projectUuid: ProjectId): Project_access? { @@ -119,78 +97,19 @@ class ProjectAccessRepository( projectAccessDao.deletePublicAccessForProject(projectId) } - /** - * [sceneIds] limits the share to those scenes; null shares the entire story. A non-null - * empty set is rejected rather than widened, so a caller that filtered its selection down - * to nothing can never accidentally expose the whole manuscript. - */ suspend fun createPrivateAccess( userId: Long, projectUuid: ProjectId, password: String, expiresAt: Instant?, - sceneIds: Set? = null, - ): SResult { - if (sceneIds != null && sceneIds.isEmpty()) { - return SResult.failure("No scenes selected", Msg.r("story_toast_access_no_scenes")) - } - - val projectDef = projectEntityDatasource.getProject(userId, projectUuid) - ?: return SResult.failure("Project not found", Msg.r("api_access_create_error_project_not_found")) - if (sceneIds != null) { - when (val loaded = projectEntityDatasource.loadSceneSet(userId, projectDef, sceneIds)) { - is SceneSetResult.InvalidId -> return SResult.failure( - "Invalid scene ${loaded.id}", - Msg.r("api_access_create_error_invalid_scene"), - loaded.exception, - ) - - is SceneSetResult.NotAScene -> return SResult.failure( - "Entity ${loaded.id} is not a scene", - Msg.r("api_access_create_error_invalid_scene") - ) - - is SceneSetResult.Success -> Unit - } - } - + ) { val projectId = projectDao.getProjectId(userId, projectUuid) - val accessId = projectAccessDao.insertAccessWithScenes( - projectId = projectId, - password = password, - expiresAt = expiresAt, - sceneIds = sceneIds ?: emptySet(), - now = clock.now(), - ) - // Null means another live share of this project already uses the password; the reader - // lookup resolves a single row per password, so allowing it would strand one share. - if (accessId == null) { - return SResult.failure( - "Password already used by another share", - Msg.r("api_access_create_error_duplicate_password") - ) - } - return SResult.success(Unit) + projectAccessDao.insertAccess(projectId, password, expiresAt) } suspend fun getPrivateAccessEntries(userId: Long, projectUuid: ProjectId): List { val projectId = projectDao.getProjectId(userId, projectUuid) val entries = projectAccessDao.getPrivateAccessForProject(projectId) - val restrictions = projectAccessDao.getSceneIdsForAccessIds(entries.map { it.id }) - // Scene counts reflect scenes that still exist, so a share whose selection has been - // deleted out from under it reads as dead instead of quietly advertising stale scenes. - val liveSceneIds = if (restrictions.isEmpty()) { - emptySet() - } else { - val projectDef = projectEntityDatasource.getProject(userId, projectUuid) - projectDef?.let { def -> - projectEntityDatasource.getEntityDefsByType( - userId = userId, - projectDef = def, - type = ApiProjectEntity.Type.SCENE, - ).map { it.id }.toSet() - } ?: emptySet() - } val now = clock.now() val formatter = DateTimeFormatter.ofPattern("MMM dd, yyyy").withZone(ZoneId.systemDefault()) @@ -204,8 +123,7 @@ class ProjectAccessRepository( password = entry.access_password, expiresAt = expiresAt, expiresAtFormatted = formattedDate, - isExpired = isExpired, - sceneCount = restrictions[entry.id]?.let { ids -> ids.intersect(liveSceneIds).size }, + isExpired = isExpired ) } } @@ -282,30 +200,20 @@ class ProjectAccessRepository( } // Check password-protected access - val passwordInfo = projectAccessDao.findProjectByPenNameProjectNameAndPassword( - penName = penName, - projectName = projectName, - password = password, - now = clock.now(), - ) ?: return PublicProjectResult.PasswordRequired + val passwordInfo = projectAccessDao.findProjectByPenNameProjectNameAndPassword(penName, projectName, password) + ?: return PublicProjectResult.PasswordRequired // Check expiration if set if (passwordInfo.expiresAt != null && clock.now() > passwordInfo.expiresAt) { return PublicProjectResult.PasswordRequired } - val sceneIds = passwordInfo.accessId - ?.let { projectAccessDao.getSceneIdsForAccess(it) } - ?.toSet() - ?.ifEmpty { null } - return PublicProjectResult.Success( userId = passwordInfo.userId, projectUuid = ProjectId(passwordInfo.projectUuid), projectName = passwordInfo.projectName, penName = passwordInfo.penName, isPublic = false, - sceneIds = sceneIds, ) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRepository.kt index 634bd048c..c4db2d525 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRepository.kt @@ -227,12 +227,11 @@ class ProjectsRepository( return SResult.failure(InvalidProjectName(newProjectName ?: "null")) val existingProject = projectEntityDatasource.checkProjectExists(userId, projectId) - if (existingProject.not()) return SResult.failure(ProjectNotFound(projectId)) - - return if (projectEntityDatasource.renameProject(userId, projectId, newProjectName)) { + return if (existingProject) { + projectEntityDatasource.renameProject(userId, projectId, newProjectName) SResult.success() } else { - SResult.failure(ProjectNameTaken(newProjectName)) + SResult.failure(ProjectNotFound(projectId)) } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRoutes.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRoutes.kt index 71c0dee95..be1eadbeb 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRoutes.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/projects/ProjectsRoutes.kt @@ -14,7 +14,6 @@ import com.darkrockstudios.apps.hammer.project.InvalidProjectName import com.darkrockstudios.apps.hammer.project.InvalidSyncIdException import com.darkrockstudios.apps.hammer.monitoring.ActivityType import com.darkrockstudios.apps.hammer.monitoring.UserActivityCollector -import com.darkrockstudios.apps.hammer.project.ProjectNameTaken import com.darkrockstudios.apps.hammer.project.ProjectNotFound import com.darkrockstudios.apps.hammer.storyideas.ServerIdeasRepository import com.darkrockstudios.apps.hammer.utilities.* @@ -31,8 +30,6 @@ import org.koin.ktor.ext.get private const val ERROR_GENERIC = "Error" private const val ERR_KEY_INVALID_PROJECT_NAME = "api_project_rename_error_invalidname" -private const val ERR_KEY_PROJECT_NAME_TAKEN = "api_project_rename_error_nametaken" -private const val ERR_KEY_PROJECT_NOT_FOUND = "api_project_getproject_error_notfound" /** Reads syncId from header, responding 400 "Missing Header" with a localized message if absent. */ private suspend fun ApplicationCall.requireSyncIdFromHeader(): String? { @@ -236,12 +233,7 @@ private suspend fun RoutingContext.respondRenameFailure(exception: Throwable?) { is ProjectNotFound -> call.respond( status = HttpStatusCode.NotFound, - HttpResponseError(error = ERROR_GENERIC, displayMessage = call.t(R(ERR_KEY_PROJECT_NOT_FOUND))), - ) - - is ProjectNameTaken -> call.respond( - status = HttpStatusCode.Conflict, - HttpResponseError(error = ERROR_GENERIC, displayMessage = call.t(R(ERR_KEY_PROJECT_NAME_TAKEN))), + HttpResponseError(error = ERROR_GENERIC, displayMessage = call.t(R(ERR_KEY_INVALID_PROJECT_NAME))), ) else -> call.respondSyncFailure(exception) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepository.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepository.kt index e41006d82..8b77866a5 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepository.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepository.kt @@ -14,8 +14,6 @@ import com.darkrockstudios.apps.hammer.encryption.ContentEncryptorRegistry import com.darkrockstudios.apps.hammer.project.ProjectDefinition import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource import com.darkrockstudios.apps.hammer.project.ProjectSyncKey -import com.darkrockstudios.apps.hammer.project.SceneSetResult -import com.darkrockstudios.apps.hammer.project.loadSceneSet import com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession import com.darkrockstudios.apps.hammer.project.synchronizers.ServerSceneDraftSynchronizer import com.darkrockstudios.apps.hammer.project.synchronizers.ServerSceneSynchronizer @@ -102,19 +100,28 @@ class ReviewRepository( ?: return SResult.failure("Project not found", Msg.r("api_review_create_error_project_not_found")) // Load and validate every requested scene before minting anything. - val scenes = when (val loaded = projectEntityDatasource.loadSceneSet(userId, projectDef, sceneIds)) { - is SceneSetResult.InvalidId -> return SResult.failure( - "Invalid scene ${loaded.id}", - Msg.r("api_review_create_error_invalid_scene"), - loaded.exception, + val scenes = mutableListOf() + for (sceneId in sceneIds) { + val type = projectEntityDatasource.findEntityType(sceneId, userId, projectDef) + if (type != ApiProjectEntity.Type.SCENE) { + return SResult.failure( + "Entity $sceneId is not a scene", + Msg.r("api_review_create_error_invalid_scene") + ) + } + val result = projectEntityDatasource.loadEntity( + userId, projectDef, sceneId, + ApiProjectEntity.Type.SCENE, + ApiProjectEntity.SceneEntity.serializer(), ) - - is SceneSetResult.NotAScene -> return SResult.failure( - "Entity ${loaded.id} is not a scene", - Msg.r("api_review_create_error_invalid_scene") - ) - - is SceneSetResult.Success -> loaded.scenes + if (isFailure(result)) { + return SResult.failure( + "Failed to load scene $sceneId", + Msg.r("api_review_create_error_invalid_scene"), + result.exception, + ) + } + scenes += result.data } val draftName = forEditDraftName(label) @@ -796,9 +803,8 @@ class ReviewRepository( private val collapseSpaces = Regex(""" {2,}""") /** - * Build a for-edit draft name. Deliberately narrower than the client's current - * SceneDraftsDatasource.validDraftName rules (alphanumeric, space, apostrophe, max 128) so - * the name is also accepted by clients predating the widened character set. + * Build a for-edit draft name that satisfies the client's + * SceneDraftsDatasource.validDraftName rules (alphanumeric, space, apostrophe, max 128). */ fun forEditDraftName(label: String): String { val sanitizedLabel = sanitizeForDraftName(label) @@ -806,11 +812,7 @@ class ReviewRepository( return base.take(MAX_DRAFT_NAME_LENGTH).trim() } - /** - * Name for the committed draft, same narrow constraints (so no comma in the date). - * Dated in UTC, not the server's configured zone: this name is written into the author's - * project and syncs to devices anywhere, so it should not depend on a server setting. - */ + /** Name for the committed draft, same validDraftName constraints (so no comma in the date). */ fun reviewedDraftName(label: String, at: kotlin.time.Instant): String { val date = java.time.format.DateTimeFormatter .ofPattern("MMM d yyyy", java.util.Locale.ENGLISH) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTask.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTask.kt index c9118a7ab..a4a938cd2 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTask.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTask.kt @@ -16,7 +16,7 @@ import kotlin.time.Instant /** * Shared scaffolding for the server's recurring background jobs (token cleanup, - * monitoring maintenance, plugin sync jobs, ...). A subclass supplies the work + * monitoring maintenance, Patreon polling, ...). A subclass supplies the work * ([tick]) and the cadence ([nextDelay]); this base owns the loop, the * already-running guard, exception handling, graceful shutdown, and the * liveness/timing bookkeeping surfaced as a [RecurringTaskStatus]. diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTaskRegistry.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTaskRegistry.kt index 9a5524b51..19c3db252 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTaskRegistry.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/scheduling/RecurringTaskRegistry.kt @@ -5,7 +5,8 @@ import java.util.concurrent.CopyOnWriteArrayList /** * Holds the set of [RecurringTask]s that have been started, so the admin * dashboard can report each one's status. Tasks register themselves when - * launched via [launchRecurringTask]; a task that never starts does not appear. + * launched via [launchRecurringTask]; a task that never starts (e.g. Patreon + * polling when the integration is disabled at the server level) does not appear. */ class RecurringTaskRegistry { private val tasks = CopyOnWriteArrayList() diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRenderCache.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRenderCache.kt index e49c80cf0..50c36bedc 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRenderCache.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRenderCache.kt @@ -18,8 +18,7 @@ import kotlin.time.Duration * Keys are built from the render's inputs — the project name and every scene's stored content hash * — so a synced edit, rename, reorder, or deletion lands on a different key and renders fresh. The * superseded entry is simply orphaned, then reclaimed by size eviction or [prune]. Bump - * [RENDER_VERSION] after a change to how markdown becomes HTML: it sits in [fingerprint], so it - * invalidates the readers' ETags along with the cached pages. + * [RENDER_VERSION] to invalidate everything after a change to how markdown becomes HTML. */ class StoryRenderCache( fileSystem: TouchableFileSystem, @@ -65,7 +64,7 @@ class StoryRenderCache( wordsPerPage: Int, sceneHashes: List, ): String = - "story-html:${projectId.id}:$page:$wordsPerPage:${fingerprint(projectName, sceneHashes)}" + "story-html:$RENDER_VERSION:${projectId.id}:$page:$wordsPerPage:${fingerprint(projectName, sceneHashes)}" private fun encode(result: PaginatedStoryExportResult): ByteArray = json.encodeToString(result).toByteArray(Charsets.UTF_8) @@ -76,19 +75,16 @@ class StoryRenderCache( .getOrNull() companion object { - private const val RENDER_VERSION = "v5" + private const val RENDER_VERSION = "v1" /** - * Everything a render of this story depends on, collapsed to a string: the renderer itself, - * the title heading and every scene's stored content hash. Doubles as the HTTP validator for - * story pages, so [RENDER_VERSION] has to be in here as well as in the cache key — otherwise - * a reader holding the old ETag is answered 304 with the old markup. + * Everything a render of this story depends on, collapsed to a string: the title heading + * and every scene's stored content hash. Doubles as the HTTP validator for story pages. * * The name is length-prefixed so one containing the delimiters can't imitate a scene list. */ fun fingerprint(projectName: String, sceneHashes: List): String = - "$RENDER_VERSION|${projectName.length}:$projectName|" + - sceneHashes.joinToString(",") { "${it.id}:${it.hash}" } + "${projectName.length}:$projectName|" + sceneHashes.joinToString(",") { "${it.id}:${it.hash}" } } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererService.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererService.kt index 7d30af025..8b43ad3d4 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererService.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererService.kt @@ -4,7 +4,6 @@ import com.darkrockstudios.apps.hammer.base.ProjectId import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity import com.darkrockstudios.apps.hammer.base.http.ApiSceneType import com.darkrockstudios.apps.hammer.base.http.EntityHash -import com.darkrockstudios.apps.hammer.base.markdown.countWords import com.darkrockstudios.apps.hammer.project.ProjectDefinition import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource import com.darkrockstudios.apps.hammer.utilities.MarkdownService @@ -53,12 +52,12 @@ class StoryRendererService( } val markdown = buildStoryMarkdown(projectDef.name, scenes) - val html = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) + val html = markdownService.markdownToSafeHtml(markdown) // Calculate total word count from scene content only (not group names) val totalWordCount = scenes .filter { it.sceneType == ApiSceneType.Scene } - .sumOf { countWords(it.content) } + .sumOf { WordCountUtils.countWords(it.content) } StoryRenderResult.Success( projectName = projectDef.name, @@ -88,132 +87,64 @@ class StoryRendererService( // Get root-level scenes (direct children of root) val rootScenes = scenesByParent[0]?.sortedBy { it.order } ?: emptyList() + var chapterNumber = 1 for (scene in rootScenes) { - // The author's own heading, verbatim: a story renders as written, never renumbered. - builder.append("## ${scene.name}\n\n") + builder.append("\n## $chapterNumber. ${scene.name}\n\n") if (scene.sceneType == ApiSceneType.Scene) { // Write scene content directly if (scene.content.isNotBlank()) { - builder.appendScene(scene.content) + builder.append(scene.content) + builder.append("\n") } } else { // It's a Group - write all child scenes' content writeGroupChildren(builder, scene.id, scenesByParent) } - } - // A scene the walk can't reach still belongs to the author, and their readers can see it on - // the published page; it would be worse for it to be missing here than to sit at the end. - for (orphan in walkScenes(scenes).orphans) { - builder.append("## ${orphan.name}\n\n") - if (orphan.content.isNotBlank()) builder.appendScene(orphan.content) + chapterNumber++ } return builder.toString() } - /** Appends every scene under [parentId], depth first, and returns their total word count. */ private fun writeGroupChildren( builder: StringBuilder, parentId: Int, scenesByParent: Map> - ): Int { - val children = scenesByParent[parentId]?.sortedBy { it.order } ?: return 0 + ) { + val children = scenesByParent[parentId]?.sortedBy { it.order } ?: return - var wordCount = 0 for (child in children) { if (child.sceneType == ApiSceneType.Scene) { if (child.content.isNotBlank()) { - builder.appendScene(child.content) - wordCount += countWords(child.content) + builder.append(child.content) + builder.append("\n") } } else { - wordCount += writeGroupChildren(builder, child.id, scenesByParent) + // Recursively process nested groups + writeGroupChildren(builder, child.id, scenesByParent) } } - return wordCount - } - - /** - * Scenes are separate passages. Without the blank line the last paragraph of one scene and the - * first of the next parse as a single paragraph; the trim keeps a scene that already ends in - * newlines from gaining a spurious break. - */ - private fun StringBuilder.appendScene(content: String) { - append(content.trimEnd()) - append("\n\n") } /** * Resolve a story once, so a caller that needs its [PreparedExport.version] before deciding to - * render doesn't pay for the lookup twice. A whole-story export costs one project lookup plus - * one indexed hash query with no decryption. Null when the project doesn't exist. + * render doesn't pay for the lookup twice. Costs one project lookup plus one indexed hash query + * with no decryption. Null when the project doesn't exist. */ - suspend fun prepareExport( - userId: Long, - projectId: ProjectId, - sceneFilter: Set? = null, - ): PreparedExport? { + suspend fun prepareExport(userId: Long, projectId: ProjectId): PreparedExport? { val projectDef = projectEntityDatasource.getProject(userId, projectId) ?: return null - val allHashes = sceneHashes(userId, projectDef) - - if (sceneFilter == null) { - return PreparedExport( - userId = userId, - projectId = projectId, - projectDef = projectDef, - sceneHashes = allHashes, - version = StoryRenderCache.fingerprint(projectDef.name, allHashes), - ) - } - - val presentIds = allHashes.map { it.id }.toSet() - val selectedIds = presentIds intersect sceneFilter - if (selectedIds.isEmpty()) return null - - // Where a selected scene falls in the reading order is decided by the groups above it, so - // the share's validator has to cover those too or a reordered chapter is answered 304 with - // the old order. A scene's path is its whole ancestor chain, so one more read settles it. - val selected = loadScenes(userId, projectDef, selectedIds) - val ancestorIds = selected.flatMapTo(mutableSetOf()) { it.path } - .intersect(presentIds) - selectedIds - val ancestors = loadScenes(userId, projectDef, ancestorIds) - - val coveredIds = selectedIds + ancestorIds - // Still only this share's scenes and the structure around them: an edit to a scene the - // share doesn't show leaves the validator alone, and two shares of different scene sets - // never collide on one. - val sceneHashes = allHashes.filter { it.id in coveredIds } + val sceneHashes = sceneHashes(userId, projectDef) return PreparedExport( userId = userId, projectId = projectId, projectDef = projectDef, sceneHashes = sceneHashes, - sceneFilter = sceneFilter, - // Read once here and carried to the render, so a cache miss doesn't decrypt twice. - scenes = selected + ancestors, - scenesComplete = selected.size + ancestors.size == coveredIds.size, version = StoryRenderCache.fingerprint(projectDef.name, sceneHashes), ) } - /** Loads [ids], skipping any that fail; the caller compares sizes to detect a partial read. */ - private suspend fun loadScenes( - userId: Long, - projectDef: ProjectDefinition, - ids: Collection, - ): List = ids.mapNotNull { id -> - val result = projectEntityDatasource.loadEntity( - userId = userId, - projectDef = projectDef, - entityId = id, - entityType = ApiProjectEntity.Type.SCENE, - serializer = ApiProjectEntity.SceneEntity.serializer() - ) - if (isSuccess(result)) result.data else null - } - /** * [cacheable] opts this render into the disk cache. Only pass true for stories reachable * without a password: a cached page is decrypted prose sitting in plaintext on disk, which is @@ -248,8 +179,6 @@ class StoryRendererService( page = page, wordsPerPage = wordsPerPage, cacheable = cacheable, - sceneFilter = prepared.sceneFilter, - preloaded = prepared.scenes?.let { PreloadedScenes(it, prepared.scenesComplete) }, ) private suspend fun renderOrCache( @@ -260,8 +189,6 @@ class StoryRendererService( page: Int, wordsPerPage: Int, cacheable: Boolean, - sceneFilter: Set? = null, - preloaded: PreloadedScenes? = null, ): PaginatedExportResult { val cache = renderCache.takeIf { cacheable } @@ -273,9 +200,9 @@ class StoryRendererService( page = page, wordsPerPage = wordsPerPage, sceneHashes = sceneHashes, - ) { renderPaginated(userId, projectDef, page, wordsPerPage, sceneFilter, preloaded) } + ) { renderPaginated(userId, projectDef, page, wordsPerPage) } } else { - renderPaginated(userId, projectDef, page, wordsPerPage, sceneFilter, preloaded).result + renderPaginated(userId, projectDef, page, wordsPerPage).result } PaginatedExportResult.Success(result) } catch (e: Exception) { @@ -295,28 +222,14 @@ class StoryRendererService( projectDef: ProjectDefinition, page: Int, wordsPerPage: Int, - sceneFilter: Set? = null, - preloaded: PreloadedScenes? = null, ): StoryRender { - // A scene-limited share arrives with its scenes and their ancestor groups already read; - // nothing else in the project is touched, so unshared prose is never decrypted. A whole - // story reads every scene, which is also every scene it renders. - val scenes: List - val complete: Boolean - if (preloaded != null) { - scenes = preloaded.scenes - complete = preloaded.complete - } else { - val sceneDefs = projectEntityDatasource.getEntityDefsByType( - userId = userId, - projectDef = projectDef, - type = ApiProjectEntity.Type.SCENE - ) - scenes = loadScenes(userId, projectDef, sceneDefs.map { it.id }) - complete = scenes.size == sceneDefs.size - } + val sceneDefs = projectEntityDatasource.getEntityDefsByType( + userId = userId, + projectDef = projectDef, + type = ApiProjectEntity.Type.SCENE + ) - if (scenes.isEmpty()) { + if (sceneDefs.isEmpty()) { return StoryRender( result = PaginatedStoryExportResult( projectName = projectDef.name, @@ -332,21 +245,32 @@ class StoryRendererService( prevPage = 1, estimatedReadingTimeMinutes = 1 ), - complete = complete, + complete = true, ) } - val selected = walkScenes(scenes).scenes - .let { ordered -> if (sceneFilter == null) ordered else ordered.filter { it.id in sceneFilter } } - - val processedScenes = selected.map { scene -> - ProcessedScene( - scene = scene, - wordCount = countWords(scene.content), - markdown = scene.content + val scenes: List = sceneDefs.mapNotNull { def -> + val result = projectEntityDatasource.loadEntity( + userId = userId, + projectDef = projectDef, + entityId = def.id, + entityType = ApiProjectEntity.Type.SCENE, + serializer = ApiProjectEntity.SceneEntity.serializer() ) + if (isSuccess(result)) result.data else null } + // Process all scenes with their word counts (only count actual scenes, not groups) + val processedScenes = scenes + .filter { it.sceneType == ApiSceneType.Scene } + .map { scene -> + ProcessedScene( + scene = scene, + wordCount = WordCountUtils.countWords(scene.content), + markdown = scene.content + ) + } + val totalWordCount = processedScenes.sumOf { it.wordCount } val estimatedReadingTime = WordCountUtils.estimateReadingTimeMinutes(totalWordCount) @@ -360,7 +284,7 @@ class StoryRendererService( // Build markdown and HTML for current page only val pageMarkdown = buildPaginatedMarkdown(projectDef.name, currentPageScenes, currentPage == 1) - val pageHtml = markdownService.markdownToSafeHtml(pageMarkdown, preserveLineBreaks = true) + val pageHtml = markdownService.markdownToSafeHtml(pageMarkdown) return StoryRender( result = PaginatedStoryExportResult( @@ -380,43 +304,10 @@ class StoryRendererService( // A scene that failed to load is silently absent from the prose. Serve the page, but // never persist it: a transient decrypt or DB failure must not outlive itself in the // cache, where the key wouldn't change until the author next edits. - complete = complete, + complete = scenes.size == sceneDefs.size, ) } - /** - * Flattens the scene tree to its leaf scenes in the order the author sees them: depth first, - * siblings by [ApiProjectEntity.SceneEntity.order]. - */ - private fun walkScenes(scenes: List): SceneWalk { - val scenesByParent = scenes.groupBy { it.path.lastOrNull() ?: ROOT_KEY } - val ordered = mutableListOf() - val visited = mutableSetOf() - - fun visit(parentId: Int) { - val children = scenesByParent[parentId] ?: return - for (scene in children.sortedBy { it.order }) { - // A path cycle would otherwise recurse forever. - if (!visited.add(scene.id)) continue - if (scene.sceneType == ApiSceneType.Scene) ordered += scene else visit(scene.id) - } - } - visit(ROOT_ID) - - val orphans = scenes.filter { it.sceneType == ApiSceneType.Scene && it.id !in visited } - return SceneWalk(scenes = ordered + orphans, orphans = orphans) - } - - /** - * The story's leaf scenes in reading order. [orphans] are the ones the walk couldn't reach, - * a scene whose parent group is missing; they land at the end of [scenes] so that nothing the - * author wrote silently disappears from a render. - */ - private class SceneWalk( - val scenes: List, - val orphans: List, - ) - private fun paginateScenes( scenes: List, wordsPerPage: Int @@ -463,7 +354,8 @@ class StoryRendererService( if (scene.markdown.isNotBlank()) { // Add scene name as chapter header builder.append("## ${scene.scene.name}\n\n") - builder.appendScene(scene.markdown) + builder.append(scene.markdown) + builder.append("\n\n") } } @@ -599,17 +491,17 @@ class StoryRendererService( val (markdown, wordCount) = if (targetScene.sceneType == ApiSceneType.Scene) { // Single scene - just its content val content = if (targetScene.content.isNotBlank()) { - "## ${targetScene.name}\n\n${targetScene.content.trimEnd()}\n" + "## ${targetScene.name}\n\n${targetScene.content}\n" } else { "## ${targetScene.name}\n" } - content to countWords(targetScene.content) + content to WordCountUtils.countWords(targetScene.content) } else { // Group - collect all child scenes' content buildGroupMarkdown(targetScene, scenesByParent) } - val html = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) + val html = markdownService.markdownToSafeHtml(markdown) SingleSceneExportResult.Success( projectName = projectDef.name, @@ -632,16 +524,33 @@ class StoryRendererService( scenesByParent: Map> ): Pair { val builder = StringBuilder() - builder.append("## ${group.name}\n\n") - val wordCount = writeGroupChildren(builder, group.id, scenesByParent) + var totalWordCount = 0 - return builder.toString() to wordCount + builder.append("## ${group.name}\n\n") + + fun collectGroupContent(parentId: Int) { + val children = scenesByParent[parentId]?.sortedBy { it.order } ?: return + for (child in children) { + if (child.sceneType == ApiSceneType.Scene) { + if (child.content.isNotBlank()) { + builder.append(child.content) + builder.append("\n") + totalWordCount += WordCountUtils.countWords(child.content) + } + } else { + // Recursively collect nested group content + collectGroupContent(child.id) + } + } + } + + collectGroupContent(group.id) + + return builder.toString() to totalWordCount } companion object { - /** Bucket for a scene with no path at all; distinct from the real root, which is id 0. */ private const val ROOT_KEY = -1 - private const val ROOT_ID = 0 const val DEFAULT_WORDS_PER_PAGE = 2000 } } @@ -670,21 +579,6 @@ class PreparedExport internal constructor( internal val projectDef: ProjectDefinition, internal val sceneHashes: List, val version: String, - /** Scene ids the render is limited to; null renders the entire story. */ - internal val sceneFilter: Set? = null, - /** - * The scenes a limited share renders and the groups that place them, read while resolving the - * version. Null for a whole-story export, which reads its scenes at render time instead. - */ - internal val scenes: List? = null, - /** False when one of [scenes] failed to load, which bars the render from the cache. */ - internal val scenesComplete: Boolean = true, -) - -/** Scenes resolved before the render, with whether the set is whole. */ -internal class PreloadedScenes( - val scenes: List, - val complete: Boolean, ) @Serializable diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/WordCountUtils.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/WordCountUtils.kt index 61149aae1..459044623 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/WordCountUtils.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/story/WordCountUtils.kt @@ -1,6 +1,13 @@ package com.darkrockstudios.apps.hammer.story object WordCountUtils { + private val wordsRegex = "\\s+".toRegex() + + fun countWords(text: String): Int { + val trimmed = text.trim() + return if (trimmed.isEmpty()) 0 else trimmed.split(wordsRegex).size + } + fun estimateReadingTimeMinutes(wordCount: Int, wordsPerMinute: Int = 225): Int { return ((wordCount + wordsPerMinute - 1) / wordsPerMinute).coerceAtLeast(1) } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/syncsessionmanager/SyncSessionManager.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/syncsessionmanager/SyncSessionManager.kt index 09787daae..e010d5c76 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/syncsessionmanager/SyncSessionManager.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/syncsessionmanager/SyncSessionManager.kt @@ -19,11 +19,6 @@ class SyncSessionManager( fun terminateSession(key: K): Boolean = synchronizationSessions.remove(key) != null - /** Removes every session whose key matches [predicate]. */ - fun terminateSessions(predicate: (K) -> Boolean) { - synchronizationSessions.keys.removeAll { predicate(it) } - } - suspend fun createNewSession(key: K, createSession: (key: K, syncId: String) -> T): String { val newSyncId = syncIdGenerator.nextString() val newSession = createSession(key, newSyncId) diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasher.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasher.kt deleted file mode 100644 index 10f1e1c88..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasher.kt +++ /dev/null @@ -1,176 +0,0 @@ -package com.darkrockstudios.apps.hammer.utilities - -import org.bouncycastle.crypto.generators.Argon2BytesGenerator -import org.bouncycastle.crypto.params.Argon2Parameters -import java.security.MessageDigest -import java.security.SecureRandom -import java.util.Base64 - -/** - * Argon2 password hashing that reads and writes the standard PHC encoded string: - * `$argon2i$v=19$m=65536,t=3,p=2$$`. - * - * [verify] takes every parameter from the stored string, so hashes written with any - * variant, version, or cost settings keep working. - * - * Pure JVM on purpose: a libargon2 binding extracts a shared object at runtime and - * executes it, which fails outright wherever the extraction directory is mounted - * noexec, as it commonly is on hardened container hosts. - */ -object Argon2PasswordHasher { - - const val SALT_LENGTH = 16 - const val HASH_LENGTH = 32 - - private const val ARGON2_I = "argon2i" - private const val ARGON2_D = "argon2d" - private const val ARGON2_ID = "argon2id" - - private const val MAX_MEMORY_KIB = 1024 * 1024 - private const val MAX_ITERATIONS = 100 - private const val MAX_PARALLELISM = 64 - - // Absent `v=` means the original Argon2 version, which predates the marker. - private val DEFAULT_VERSION = Argon2Parameters.ARGON2_VERSION_10 - - private val secureRandom = SecureRandom() - private val encoder = Base64.getEncoder().withoutPadding() - private val decoder = Base64.getDecoder() - - fun hash(password: CharArray, memoryKib: Int, iterations: Int, parallelism: Int): String { - val salt = ByteArray(SALT_LENGTH) - secureRandom.nextBytes(salt) - - val hash = derive( - type = Argon2Parameters.ARGON2_i, - version = Argon2Parameters.ARGON2_VERSION_13, - salt = salt, - memoryKib = memoryKib, - iterations = iterations, - parallelism = parallelism, - password = password, - outputLength = HASH_LENGTH, - ) - - return buildString { - append('$').append(ARGON2_I) - append("\$v=").append(Argon2Parameters.ARGON2_VERSION_13) - append("\$m=").append(memoryKib) - append(",t=").append(iterations) - append(",p=").append(parallelism) - append('$').append(encoder.encodeToString(salt)) - append('$').append(encoder.encodeToString(hash)) - } - } - - /** Returns false for anything that isn't a well-formed hash of [password]. */ - fun verify(encoded: String, password: CharArray): Boolean { - val parsed = parse(encoded) ?: return false - - val computed = derive( - type = parsed.type, - version = parsed.version, - salt = parsed.salt, - memoryKib = parsed.memoryKib, - iterations = parsed.iterations, - parallelism = parsed.parallelism, - password = password, - outputLength = parsed.hash.size, - ) - - return MessageDigest.isEqual(parsed.hash, computed) - } - - @Suppress("LongParameterList") - private fun derive( - type: Int, - version: Int, - salt: ByteArray, - memoryKib: Int, - iterations: Int, - parallelism: Int, - password: CharArray, - outputLength: Int, - ): ByteArray { - val parameters = Argon2Parameters.Builder(type) - .withVersion(version) - .withSalt(salt) - .withMemoryAsKB(memoryKib) - .withIterations(iterations) - .withParallelism(parallelism) - .build() - - val generator = Argon2BytesGenerator() - generator.init(parameters) - - val output = ByteArray(outputLength) - generator.generateBytes(password, output) - return output - } - - private class Parsed( - val type: Int, - val version: Int, - val memoryKib: Int, - val iterations: Int, - val parallelism: Int, - val salt: ByteArray, - val hash: ByteArray, - ) - - @Suppress("ReturnCount", "MagicNumber") - private fun parse(encoded: String): Parsed? { - // The leading '$' makes the first field empty, so a full hash splits into six. - val fields = encoded.split('$') - if (fields.size !in 5..6 || fields[0].isNotEmpty()) return null - - val type = when (fields[1]) { - ARGON2_I -> Argon2Parameters.ARGON2_i - ARGON2_D -> Argon2Parameters.ARGON2_d - ARGON2_ID -> Argon2Parameters.ARGON2_id - else -> return null - } - - val hasVersion = fields.size == 6 - val version = if (hasVersion) { - val field = fields[2] - if (!field.startsWith("v=")) return null - field.removePrefix("v=").toIntOrNull() ?: return null - } else { - DEFAULT_VERSION - } - if (version != Argon2Parameters.ARGON2_VERSION_10 && version != Argon2Parameters.ARGON2_VERSION_13) return null - - val costs = fields[if (hasVersion) 3 else 2] - .split(',') - .map { it.split('=', limit = 2) } - if (costs.any { it.size != 2 }) return null - val costsByKey = costs.associate { it[0] to it[1] } - - // keyid/data would change the derivation and we never write them. - if (costsByKey.keys != setOf("m", "t", "p")) return null - - val memoryKib = costsByKey.getValue("m").toIntOrNull() ?: return null - val iterations = costsByKey.getValue("t").toIntOrNull() ?: return null - val parallelism = costsByKey.getValue("p").toIntOrNull() ?: return null - - // The lower bounds are what the algorithm requires. The upper bounds keep a - // corrupt stored value from allocating the heap away or hashing for hours. - if (parallelism < 1 || parallelism > MAX_PARALLELISM) return null - if (iterations < 1 || iterations > MAX_ITERATIONS) return null - if (memoryKib < 8 * parallelism || memoryKib > MAX_MEMORY_KIB) return null - - val salt = decodeOrNull(fields[if (hasVersion) 4 else 3]) ?: return null - val hash = decodeOrNull(fields[if (hasVersion) 5 else 4]) ?: return null - if (salt.isEmpty() || hash.isEmpty()) return null - - return Parsed(type, version, memoryKib, iterations, parallelism, salt, hash) - } - - @Suppress("SwallowedException") - private fun decodeOrNull(value: String): ByteArray? = try { - decoder.decode(value) - } catch (_: IllegalArgumentException) { - null - } -} diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/DateTimeUtils.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/DateTimeUtils.kt index 63e865be2..f94c143ca 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/DateTimeUtils.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/DateTimeUtils.kt @@ -1,17 +1,30 @@ package com.darkrockstudios.apps.hammer.utilities +import kotlinx.datetime.LocalDateTime +import kotlinx.datetime.TimeZone +import kotlinx.datetime.toJavaLocalDateTime +import kotlinx.datetime.toLocalDateTime import java.time.ZoneId import java.time.format.DateTimeFormatter import kotlin.time.Instant import kotlin.time.toJavaInstant import kotlin.time.toKotlinInstant +fun Instant.formatLocal(format: String): String = + toLocalDateTime(TimeZone.currentSystemDefault()).format(format) + private const val MILLIS_PER_DAY = 24L * 60 * 60 * 1000 /** Floor an instant to the start (00:00) of its UTC day. */ fun Instant.truncateToUtcDay(): Instant = Instant.fromEpochMilliseconds(toEpochMilliseconds() / MILLIS_PER_DAY * MILLIS_PER_DAY) +fun LocalDateTime.format(format: String): String = + DateTimeFormatter.ofPattern(format).format(this.toJavaLocalDateTime()) + +//ISO 8601 +fun Instant.toISO8601(): String = toString() + /** * Coerce an instant into the range a Postgres `TIMESTAMPTZ` column can hold. Instants near * [Instant.DISTANT_PAST]..[Instant.DISTANT_FUTURE] round-trip; values beyond reach further than an diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownService.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownService.kt index c86857116..e40d183d8 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownService.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownService.kt @@ -1,13 +1,10 @@ package com.darkrockstudios.apps.hammer.utilities -import com.darkrockstudios.apps.hammer.base.markdown.ProseHtml -import org.intellij.markdown.flavours.gfm.GFMFlavourDescriptor +import org.intellij.markdown.flavours.commonmark.CommonMarkFlavourDescriptor import org.intellij.markdown.html.HtmlGenerator -import org.intellij.markdown.parser.LinkMap import org.intellij.markdown.parser.MarkdownParser import org.owasp.html.HtmlPolicyBuilder import org.owasp.html.PolicyFactory -import java.util.regex.Pattern /** * Service for converting Markdown to sanitized HTML. @@ -15,13 +12,9 @@ import java.util.regex.Pattern * This service uses the JetBrains Markdown library for parsing and * OWASP HTML Sanitizer to prevent XSS attacks by only allowing * safe HTML elements and attributes. - * - * The flavour is GitHub Flavored Markdown, matching the editor that writes the - * content: CommonMark has no strikethrough, so `~~struck~~` reached the page as - * literal tildes. */ class MarkdownService { - private val markdownFlavour = GFMFlavourDescriptor() + private val markdownFlavour = CommonMarkFlavourDescriptor() private val markdownParser = MarkdownParser(markdownFlavour) /** @@ -29,25 +22,17 @@ class MarkdownService { * - Strips all script tags and event handlers * - Only allows http/https URLs in links * - Adds rel="nofollow" to all links for security - * - * An element the parser can produce but the policy drops does not vanish: its text survives - * unwrapped, so a stripped table reads as its cells run together. Everything GFM emits is - * either allowed here or, like an image or a task-list checkbox, deliberately left out. */ private val sanitizer: PolicyFactory = HtmlPolicyBuilder() .allowElements( - "p", "br", "strong", "em", "b", "i", "u", "del", + "p", "br", "strong", "em", "b", "i", "u", "ul", "ol", "li", "h1", "h2", "h3", "h4", "h5", "h6", "blockquote", "code", "pre", - "table", "thead", "tbody", "tr", "th", "td", "a", "hr" ) .allowUrlProtocols("http", "https") .allowAttributes("href").onElements("a") - // A list that starts at 5 has to say so, or it renders as 1. - .allowAttributes("start").matching(ORDERED_LIST_START).onElements("ol") - .allowAttributes("align").matching(COLUMN_ALIGNMENT).onElements("th", "td") .requireRelNofollowOnLinks() .toFactory() @@ -58,41 +43,13 @@ class MarkdownService { * All script tags, event handlers, and javascript: URLs are stripped. * * @param markdown The markdown text to convert - * @param preserveLineBreaks Lay the text out the way the author typed it: every newline starts a - * new line and every blank line is a blank line, which is what the editor shows them. Story prose - * opts in; anywhere the markdown is a short piece of writing rather than a story, such as a bio or - * a policy page, wants CommonMark's usual reflowing. * @return Sanitized HTML string safe for rendering */ - fun markdownToSafeHtml(markdown: String, preserveLineBreaks: Boolean = false): String { + fun markdownToSafeHtml(markdown: String): String { if (markdown.isBlank()) return "" - val source = ProseHtml.normalizeLineEndings(markdown) - val parsedTree = markdownParser.buildMarkdownTreeFromString(source) - val linkMap = LinkMap.buildLinkMap(parsedTree, source) - val providers = if (preserveLineBreaks) { - ProseHtml.providers(markdownFlavour, linkMap) - } else { - markdownFlavour.createHtmlGeneratingProviders(linkMap, null) - } - - val unsafeHtml = HtmlGenerator(source, parsedTree, providers).generateHtml() - return sanitizer.sanitize(unsafeHtml.strikethroughAsDel()) - } - - /** - * The GFM generator emits strikethrough as ``. Rewrite it - * to `` so the sanitizer, which allows no attributes on a `span` and so - * would unwrap it, can keep the element. - */ - private fun String.strikethroughAsDel(): String = - replace(STRIKETHROUGH_SPAN, "$1") - - companion object { - private val STRIKETHROUGH_SPAN = - Regex("""(.*?)""", RegexOption.DOT_MATCHES_ALL) - - private val ORDERED_LIST_START: Pattern = Pattern.compile("[0-9]{1,9}") - private val COLUMN_ALIGNMENT: Pattern = Pattern.compile("left|center|right") + val parsedTree = markdownParser.buildMarkdownTreeFromString(markdown) + val unsafeHtml = HtmlGenerator(markdown, parsedTree, markdownFlavour).generateHtml() + return sanitizer.sanitize(unsafeHtml) } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/SResult.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/SResult.kt index 1f44d135f..fd282e96a 100644 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/SResult.kt +++ b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/SResult.kt @@ -26,11 +26,11 @@ sealed class ServerResult { ) : ServerResult() { override val isSuccess = false - suspend fun displayMessageText(call: ApplicationCall, default: R): String { + fun displayMessageText(call: ApplicationCall, default: R): String { return displayMessage?.text(call) ?: call.t(default) } - suspend fun displayMessageText(call: ApplicationCall): String? { + fun displayMessageText(call: ApplicationCall): String? { return displayMessage?.text(call) } } @@ -55,33 +55,17 @@ sealed class ServerResult { typealias Msg = ServerMessage -sealed class ServerMessage { - abstract suspend fun text(call: ApplicationCall): String +class ServerMessage private constructor( + @PropertyKey(resourceBundle = DEFAULT_RESOURCE_BUNDLE) res: R, + inArgs: List +) { + val r: R = res + val args: List = inArgs - class Resource internal constructor( - @PropertyKey(resourceBundle = DEFAULT_RESOURCE_BUNDLE) res: R, - inArgs: List - ) : ServerMessage() { - val r: R = res - val args: List = inArgs - - override suspend fun text(call: ApplicationCall): String = call.t(r, args) - } - - /** Text already resolved by the caller, e.g. by a plugin from its own resource bundle. */ - class Literal(private val value: String) : ServerMessage() { - override suspend fun text(call: ApplicationCall): String = value - } - - /** Resolved per request, for messages living outside the default bundle. */ - class Dynamic(private val resolve: suspend (ApplicationCall) -> String) : ServerMessage() { - override suspend fun text(call: ApplicationCall): String = resolve(call) - } + fun text(call: ApplicationCall): String = call.t(r, args) companion object { - fun r(key: String, vararg args: Any): ServerMessage = Resource(R(key), args.toList()) - fun literal(text: String): ServerMessage = Literal(text) - fun dynamic(resolve: suspend (ApplicationCall) -> String): ServerMessage = Dynamic(resolve) + fun r(key: String, vararg args: Any): ServerMessage = ServerMessage(R(key), args.toList()) } } diff --git a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZone.kt b/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZone.kt deleted file mode 100644 index b2078986b..000000000 --- a/server/src/main/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZone.kt +++ /dev/null @@ -1,80 +0,0 @@ -package com.darkrockstudios.apps.hammer.utilities - -import ch.qos.logback.classic.BasicConfigurator -import ch.qos.logback.classic.LoggerContext -import ch.qos.logback.classic.util.ContextInitializer -import org.slf4j.LoggerFactory -import java.time.DateTimeException -import java.time.ZoneId -import java.util.TimeZone - -const val TIMEZONE_ENV_VAR = "HAMMER_TIMEZONE" - -private val timeZoneLogger = LoggerFactory.getLogger("HammerServer") - -/** - * The zone every server-rendered timestamp and log line is stamped in: [configured] (`timezone` in - * `config.toml`) wins, then the `HAMMER_TIMEZONE` environment variable, then `TZ`, then the host's - * own zone. The JVM already honors `TZ` on Linux; reading it back here extends it to hosts that do - * not, so the same variable works everywhere. - * - * An unusable `timezone` or `HAMMER_TIMEZONE` throws, because both are deliberate settings and - * ignoring one would leave every timestamp wrong with nothing to point at. A `TZ` java.time cannot - * parse only warns and falls through to the host zone: the POSIX form (`CET-1CEST,M3.5.0`) is a - * legitimate value the platform has already applied, so it is not ours to reject. - */ -fun resolveServerTimeZone( - configured: String?, - readEnv: (String) -> String? = System::getenv, -): ZoneId { - configured?.trim()?.ifBlank { null }?.let { return parseZone(it, "timezone in config.toml") } - readEnv(TIMEZONE_ENV_VAR)?.trim()?.ifBlank { null }?.let { return parseZone(it, TIMEZONE_ENV_VAR) } - readEnv("TZ")?.trim()?.ifBlank { null }?.let { tz -> - // A leading colon is the POSIX spelling of "what follows names a zone": TZ=":Europe/Paris". - runCatching { ZoneId.of(tz.removePrefix(":")) }.getOrNull()?.let { return it } - timeZoneLogger.warn( - "TZ is set to \"$tz\", which is not an IANA zone ID, so it is being left to the host. " + - "To name the zone explicitly, use $TIMEZONE_ENV_VAR or the timezone config setting.", - ) - } - return ZoneId.systemDefault() -} - -private fun parseZone(value: String, source: String): ZoneId = - try { - ZoneId.of(value) - } catch (e: DateTimeException) { - throw IllegalArgumentException( - "$source is set to \"$value\", which is not a known time zone. " + - "Use an IANA zone ID such as \"Europe/Paris\" or \"UTC\".", - e, - ) - } - -/** - * Makes [zone] the JVM default, which is what `ZoneId.systemDefault()` (the zone every - * server-rendered timestamp is formatted in) and Logback's `%d` both read. - */ -fun applyServerTimeZone(zone: ZoneId) { - if (TimeZone.getDefault().toZoneId() == zone) return - TimeZone.setDefault(TimeZone.getTimeZone(zone)) - reloadLogbackConfiguration() -} - -/** - * Logback's date converter captures the default zone when it parses `logback.xml`, which happens the - * first time any logger is created, before the config file has even been read. Reloading rebuilds - * the converters against the zone just applied, so log lines carry it too. - */ -private fun reloadLogbackConfiguration() { - val context = LoggerFactory.getILoggerFactory() as? LoggerContext ?: return - context.reset() - try { - ContextInitializer(context).autoConfig() - } catch (@Suppress("TooGenericExceptionCaught") e: Throwable) { - // reset() already detached every appender, so anything escaping here would leave the server - // with no console output and an empty admin log viewer. - System.err.println("Logging config failed to reload after the time zone change: ${e.message}") - BasicConfigurator().configure(context) - } -} diff --git a/server/src/main/resources/assets/css/admin.css b/server/src/main/resources/assets/css/admin.css index ed886ce13..f7a8ca56c 100644 --- a/server/src/main/resources/assets/css/admin.css +++ b/server/src/main/resources/assets/css/admin.css @@ -169,17 +169,6 @@ border: 1px solid var(--neutral-300); } -.status-badge--danger { - background: rgba(239, 68, 68, 0.12); - color: #991b1b; - border: 1px solid rgba(239, 68, 68, 0.3); -} - -.user-restore-btn { - padding: 0.25rem 0.75rem; - font-size: 0.875rem; -} - /* ======================================== Form Styling ======================================== */ @@ -290,18 +279,6 @@ gap: 0.75rem; } -.whitelist-search { - display: flex; - gap: 0.75rem; - align-items: flex-end; - margin-bottom: 1rem; -} - -.whitelist-search__field { - flex: 1; - margin-bottom: 0; -} - .whitelist-controls { display: flex; align-items: center; @@ -311,28 +288,6 @@ border-bottom: 2px solid var(--neutral-200); } -/* Pushed left of the sort button, which the container's flex-end would otherwise pin it to. */ -.whitelist-controls__filter { - display: inline-flex; - align-items: center; - gap: 0.375rem; - margin-right: auto; - font-size: 0.875rem; - color: var(--text-secondary); -} - -.whitelist-controls__filter code { - font-family: 'Kingthings Typewriter', 'Courier New', monospace; - color: var(--text-primary); - word-break: break-all; -} - -.whitelist-controls .whitelist-controls__filter-clear { - padding: 0.25rem 0.5rem; - border: none; - line-height: 1; -} - .whitelist-controls .btn { font-size: 0.875rem; padding: 0.5rem 1rem; @@ -740,16 +695,6 @@ min-width: auto; } - .whitelist-controls { - flex-wrap: wrap; - gap: 0.5rem; - } - - .whitelist-controls__filter { - margin-right: 0; - width: 100%; - } - .whitelist-entry { flex-direction: column; align-items: flex-start; diff --git a/server/src/main/resources/assets/css/authors.css b/server/src/main/resources/assets/css/authors.css index 228d009c6..6b6140cb8 100644 --- a/server/src/main/resources/assets/css/authors.css +++ b/server/src/main/resources/assets/css/authors.css @@ -314,19 +314,15 @@ .pagination-button:hover:not(.pagination-button--disabled) { border-color: var(--accent); color: var(--accent); - background: var(--paper-white); transform: translateY(-2px); box-shadow: var(--shadow-md); } -.pagination-button--disabled, -.pagination-button--disabled:hover { +.pagination-button--disabled { color: var(--neutral-400); border-color: var(--neutral-200); background: var(--neutral-50); cursor: not-allowed; - transform: none; - box-shadow: none; } .pagination-info { diff --git a/server/src/main/resources/assets/css/base.css b/server/src/main/resources/assets/css/base.css index 2a4bb4144..77d91aa47 100644 --- a/server/src/main/resources/assets/css/base.css +++ b/server/src/main/resources/assets/css/base.css @@ -656,84 +656,10 @@ a:focus-visible { color: var(--neutral-800); } -/* The notice is admin-authored markdown, so the band has to hold anything a short - document can contain while staying a single band-height strip. */ -.instance-band__text > :first-child { - margin-top: 0; -} - -.instance-band__text > :last-child { +.instance-band__text p:last-child { margin-bottom: 0; } -.instance-band__text p { - margin: 0 0 0.6rem 0; -} - -.instance-band__text a { - color: var(--primary); - text-decoration: underline; - text-decoration-color: var(--accent-dark); - text-decoration-thickness: 2px; - text-underline-offset: 3px; - transition: color var(--transition-base); -} - -.instance-band__text a:hover, -.instance-band__text a:focus-visible { - color: var(--accent-dark); -} - -.instance-band__text h1, -.instance-band__text h2, -.instance-band__text h3, -.instance-band__text h4, -.instance-band__text h5, -.instance-band__text h6 { - font-family: 'Kingthings Typewriter', 'Courier New', monospace; - font-size: 1.05rem; - color: var(--neutral-800); - margin: 0 0 0.4rem 0; -} - -.instance-band__text ul, -.instance-band__text ol { - margin: 0 0 0.6rem 0; - padding-left: 1.5rem; -} - -.instance-band__text blockquote { - margin: 0 0 0.6rem 0; - padding-left: 0.9rem; - border-left: 2px solid var(--accent); - color: var(--neutral-700); -} - -.instance-band__text code { - font-family: 'Courier New', monospace; - font-size: 0.9em; - background: rgba(41, 37, 36, 0.08); - padding: 0.1em 0.35em; -} - -.instance-band__text pre { - margin: 0 0 0.6rem 0; - padding: 0.6rem 0.8rem; - overflow-x: auto; - background: rgba(41, 37, 36, 0.08); -} - -.instance-band__text pre code { - background: none; - padding: 0; -} - -.instance-band__text hr { - margin: 0.6rem 0; - border: none; - border-top: 1px dashed rgba(180, 83, 9, 0.4); -} - /* Only a separator when it actually follows a server message; a whitelisted server with no message set shows this band on its own. */ .instance-band__inner--whitelist:not(:first-child) { diff --git a/server/src/main/resources/assets/css/dashboard.css b/server/src/main/resources/assets/css/dashboard.css index e75d0c6a8..4751ac1e5 100644 --- a/server/src/main/resources/assets/css/dashboard.css +++ b/server/src/main/resources/assets/css/dashboard.css @@ -613,19 +613,6 @@ box-shadow: none; } -/* Account-level danger zone sits below the account info card */ -.account-danger-zone { - margin-top: 1.5rem; -} - -.account-admin-delete-note { - margin-top: 1.5rem; - font-family: 'Lora', Georgia, serif; - font-size: 0.9375rem; - font-style: italic; - color: var(--neutral-500); -} - /* Projects and Account containers */ .projects-container { margin-top: 1.5rem; diff --git a/server/src/main/resources/assets/css/error.css b/server/src/main/resources/assets/css/error.css index e7424991b..2aaff6f3c 100644 --- a/server/src/main/resources/assets/css/error.css +++ b/server/src/main/resources/assets/css/error.css @@ -499,93 +499,9 @@ } } -/* Setup Admin Account Form */ -.setup-form { - max-width: 400px; - margin: 0 auto 1.5rem; - text-align: left; -} - -.setup-form__error { - background: rgba(239, 68, 68, 0.12); - border: 2px solid #ef4444; - border-radius: 0.5rem; - padding: 0.75rem 1rem; - margin-bottom: 1rem; -} - -.setup-form__error p { - color: #991b1b; - font-weight: 500; - margin: 0; - font-size: 0.9375rem; -} - -.setup-form__actions { - margin-top: 1.25rem; -} - -.setup-form__submit { - width: 100%; - font-family: 'Kingthings Typewriter', monospace; - font-size: 1.125rem; - padding: 1rem 2rem; - background: #14532d; - color: white; - border: none; - border-radius: 0.5rem; - cursor: pointer; - transition: all var(--transition-base); - box-shadow: var(--shadow-md); -} - -.setup-form__submit:hover { - background: #166534; - transform: translateY(-2px); - box-shadow: var(--shadow-lg); -} - -.setup-form__submit:active { - transform: translateY(0); - box-shadow: var(--shadow-sm); -} - -.setup-form__submit:focus-visible { - outline: 2px solid #22c55e; - outline-offset: 4px; -} - -/* Secondary "set up from the app" section */ -.setup-alt { - margin-top: 1.5rem; - padding-top: 1.5rem; - border-top: 1px dashed rgba(20, 83, 45, 0.3); -} - -.setup-alt__title { - font-family: 'Kingthings Typewriter', monospace; - font-size: 1rem; - color: #166534; - margin-bottom: 1rem; -} - -@media only screen and (max-width: 600px) { - .setup-form__submit { - font-size: 1rem; - padding: 0.875rem 1.75rem; - } -} - /* Reduced motion for setup */ @media (prefers-reduced-motion: reduce) { .error-card.setup .error-icon { animation: none; } - - .setup-form__submit, - .setup-form__submit:hover, - .setup-form__submit:active { - transition: none; - transform: none; - } } diff --git a/server/src/main/resources/assets/css/feed.css b/server/src/main/resources/assets/css/feed.css index b904b9e19..4e87834b7 100644 --- a/server/src/main/resources/assets/css/feed.css +++ b/server/src/main/resources/assets/css/feed.css @@ -417,19 +417,15 @@ .pagination-button:hover:not(.pagination-button--disabled) { border-color: var(--accent); color: var(--accent); - background: var(--paper-white); transform: translateY(-2px); box-shadow: var(--shadow-md); } -.pagination-button--disabled, -.pagination-button--disabled:hover { +.pagination-button--disabled { color: var(--neutral-400); border-color: var(--neutral-200); background: var(--neutral-50); cursor: not-allowed; - transform: none; - box-shadow: none; } .pagination-info { diff --git a/server/src/main/resources/assets/css/story.css b/server/src/main/resources/assets/css/story.css index ccf9db93e..f71e78d74 100644 --- a/server/src/main/resources/assets/css/story.css +++ b/server/src/main/resources/assets/css/story.css @@ -69,11 +69,6 @@ border-bottom: 3px solid var(--accent); } -/* ======================================== - Story Prose - Typography for author-written markdown - ======================================== */ - .story-content { background: white; padding: 3rem; @@ -81,7 +76,6 @@ box-shadow: var(--shadow-lg); line-height: 1.8; font-size: 1.125rem; - color: var(--text-primary); overflow-wrap: break-word; word-wrap: break-word; word-break: normal; @@ -114,258 +108,36 @@ padding-top: 0; } -.story-content h3, -.story-content h4, -.story-content h5, -.story-content h6 { - font-family: 'Kingthings Typewriter', monospace; - color: var(--text-primary); - margin-top: 2.5rem; - margin-bottom: 0.75rem; -} - -.story-content h3 { - font-size: 1.375rem; -} - -.story-content h4 { - font-size: 1.1875rem; -} - -.story-content h5, -.story-content h6 { - font-size: 1rem; - letter-spacing: 0.06em; - text-transform: uppercase; - color: var(--text-secondary); -} - .story-content p { margin-bottom: 0; - font-size: inherit; - color: inherit; text-indent: 2em; text-align: justify; } -/* ---------------------------------------- - Lists - ---------------------------------------- */ - -.story-content ul, -.story-content ol { - margin: 1.5em 0; - padding-left: 3.5em; - text-align: left; +/* Standard typographic rule: don't indent the first paragraph after a heading */ +.story-content h1 + p, +.story-content h2 + p, +.story-content h3 + p { text-indent: 0; } -.story-content li { - margin-bottom: 0.75em; - padding-left: 0.4em; -} - -.story-content li:last-child { - margin-bottom: 0; -} - -.story-content li::marker { - color: var(--accent); -} - -.story-content ol > li::marker { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.95em; -} - -.story-content li > p { - margin: 0; - text-indent: 0; - text-align: left; -} - -.story-content li > p + p { - margin-top: 0.6em; -} - -/* Nested lists tuck under their parent item instead of repeating the outer gap */ -.story-content li > ul, -.story-content li > ol { - margin: 0.6em 0 0; - padding-left: 2em; -} - -.story-content ul ul { - list-style-type: circle; -} - -.story-content ul ul ul { - list-style-type: square; -} - -.story-content ol ol { - list-style-type: lower-alpha; -} - -.story-content ol ol ol { - list-style-type: lower-roman; -} - -/* ---------------------------------------- - Tables - ---------------------------------------- */ - -.story-content table { - display: block; - width: fit-content; - max-width: 100%; - margin: 2em auto; - overflow-x: auto; - border-collapse: collapse; - font-size: 0.9375em; - text-indent: 0; -} - -.story-content th, -.story-content td { - padding: 0.5em 1em; - border: 1px solid var(--neutral-200); - text-align: left; - vertical-align: top; -} - -/* Author CSS outranks the align attribute markdown's column alignment produces, so honour it here */ -.story-content th[align="center"], -.story-content td[align="center"] { - text-align: center; -} - -.story-content th[align="right"], -.story-content td[align="right"] { - text-align: right; -} - -.story-content th { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.9375em; - font-weight: 500; - color: var(--text-secondary); - background: rgba(245, 245, 244, 0.7); - border-bottom-color: var(--neutral-300); -} - -/* ---------------------------------------- - Scene break - ---------------------------------------- */ - -.story-content hr { - position: relative; - width: 45%; - max-width: 14rem; - height: 1px; - margin: 3rem auto; - border: none; - background: linear-gradient(90deg, - transparent 0%, - var(--neutral-300) 20%, - var(--neutral-300) 80%, - transparent 100% - ); - overflow: visible; -} - -.story-content hr::after { - content: '\25C6'; - position: absolute; - top: 50%; - left: 50%; - transform: translate(-50%, -50%); - padding: 0 0.75rem; - background: white; - color: var(--accent); - font-size: 0.75rem; - line-height: 1; -} - -/* ---------------------------------------- - Quotes and code - ---------------------------------------- */ - -.story-content blockquote { - margin: 2em 0 2em 1.5em; - padding: 1em 1.5em; - background: rgba(245, 245, 244, 0.7); - border-left: 3px solid rgba(217, 119, 6, 0.4); - border-radius: 0 0.375rem 0.375rem 0; - color: var(--text-secondary); - font-style: italic; -} - -.story-content blockquote p { - margin: 0; - text-indent: 0; - text-align: left; - color: inherit; -} - -/* Emphasis inside already-italic type reads as upright */ -.story-content blockquote em { - font-style: normal; -} - -.story-content blockquote blockquote { - margin-right: 0; - margin-bottom: 0; -} - -.story-content blockquote > :last-child { - margin-bottom: 0; -} - .story-content pre { - margin: 1.5em 0; - padding: 1rem 1.25rem; - background: var(--neutral-100); - border: 1px solid var(--neutral-200); - border-radius: 0.375rem; white-space: pre-wrap; word-wrap: break-word; overflow-x: auto; max-width: 100%; - text-indent: 0; } .story-content code { - font-family: 'Courier New', monospace; - font-size: 0.9375em; - word-break: normal; - overflow-wrap: anywhere; + word-break: break-all; } -.story-content p > code, -.story-content li > code { - padding: 0.125em 0.375em; - background: var(--neutral-100); - border-radius: 0.25rem; -} - -/* Struck text is a revision the author left visible; it recedes but stays readable */ -.story-content del { - text-decoration: line-through; - text-decoration-thickness: 1px; +.story-content blockquote { + margin: 1rem 0; + padding-left: 1rem; + border-left: 3px solid var(--neutral-300); color: var(--text-secondary); -} - -.story-content a { - color: var(--accent-dark); - text-decoration: underline; - text-decoration-color: rgba(217, 119, 6, 0.4); - text-underline-offset: 0.15em; -} - -.story-content a:hover { - color: var(--accent); - text-decoration-color: var(--accent); + font-style: italic; } .story-empty { @@ -545,32 +317,6 @@ .story-title { font-size: 2rem; } - - .story-content ul, - .story-content ol { - padding-left: 2.25em; - } - - .story-content blockquote { - margin-left: 0.5em; - padding: 0.875em 1.125em; - } - - .story-content hr { - width: 60%; - margin: 2.25rem auto; - } -} - -/* A column this narrow can't justify without opening rivers between words */ -@media only screen and (max-width: 600px) { - .story-content { - hyphens: none; - } - - .story-content p { - text-align: left; - } } /* ======================================== @@ -1416,8 +1162,6 @@ .access-entry-expiry { display: flex; align-items: center; - gap: 0.75rem; - flex-wrap: wrap; } .access-expiry { @@ -1441,23 +1185,6 @@ color: var(--neutral-400); } -.access-scope { - display: inline-flex; - align-items: center; - gap: 0.375rem; - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.75rem; - color: var(--text-secondary); -} - -.access-scope i { - font-size: 0.6875rem; -} - -.access-scope.dead { - color: var(--error); -} - .delete-access-btn { display: flex; align-items: center; @@ -1855,13 +1582,10 @@ /* ===== Request a Review dialog ===== */ -/* Tall sheet dialogs (review request, private share): pinned header and actions - with the form as the single scroll column between them. */ -.dialog--sheet { +.dialog--review { max-width: 540px; width: 92%; max-height: calc(100vh - 48px); - max-height: calc(100dvh - 48px); display: flex; flex-direction: column; /* Fully opaque: this dialog is tall enough to overlap the page footer, @@ -1869,25 +1593,18 @@ background: #fffdfa; } -.dialog--sheet .dialog__actions { +.dialog--review .dialog__actions { background: #faf6ee; } -.dialog--sheet form { +.dialog--review form { display: flex; flex-direction: column; - flex: 1 1 auto; min-height: 0; } -/* The only scroll region in the dialog. The scene list renders at its full - height inside it, so the whole form scrolls as one column between the pinned - header and actions instead of nesting a second scroller. */ -.dialog--sheet .dialog__body { - flex: 1 1 auto; - min-height: 0; +.dialog--review .dialog__body { overflow-y: auto; - overscroll-behavior: contain; } .review-form__row { @@ -1923,9 +1640,7 @@ pointer-events: none; } -/* Selectable chip, shared by the review expiry picker and reader kudos */ -.review-form__chip, -.story-kudos__chip { +.review-form__chip { font-family: 'Kingthings Typewriter', monospace; font-size: 0.8rem; padding: 0.5rem 0.95rem; @@ -1938,15 +1653,13 @@ user-select: none; } -.review-form__expiry input[type="radio"]:checked + .review-form__chip, -.story-kudos__input:checked + .story-kudos__chip { +.review-form__expiry input[type="radio"]:checked + .review-form__chip { border-color: var(--accent); background: #fdf1e3; color: var(--accent-dark); } -.review-form__expiry input[type="radio"]:focus-visible + .review-form__chip, -.story-kudos__input:focus-visible + .story-kudos__chip { +.review-form__expiry input[type="radio"]:focus-visible + .review-form__chip { outline: 2px solid var(--accent); outline-offset: 3px; } @@ -1965,17 +1678,13 @@ color: var(--neutral-400); } -/* Frames the master row and the list as one control. Nothing here scrolls: the - list is as tall as the story is long and the dialog body scrolls it. */ -.review-form__scene-box { +.review-form__scene-tree { border: 1px solid var(--neutral-200); border-radius: 10px; background: #ffffff; - overflow: hidden; -} - -.review-form__scene-tree { padding: 0.4rem 0; + max-height: 260px; + overflow-y: auto; } .review-scene-master { @@ -1984,9 +1693,12 @@ justify-content: space-between; gap: 0.6rem; padding: 0.55rem 1rem; + margin: 0 0.4rem 0.25rem 0.4rem; border-bottom: 1px dashed var(--neutral-200); - background: #faf6ee; - flex-shrink: 0; + position: sticky; + top: 0; + background: #ffffff; + z-index: 1; } .review-scene-master__name { @@ -2094,40 +1806,12 @@ color: var(--neutral-800); } -[data-scene-submit]:disabled { +#review-send-btn:disabled { background: var(--neutral-200); color: var(--neutral-400); cursor: default; } -/* ===== Share dialog scene limiting ===== - The checkbox itself reuses the review-scene-row__* classes; only the row - layout differs because it sits outside the scene tree. */ - -.share-form__limit { - display: flex; - align-items: center; - gap: 0.7rem; - cursor: pointer; -} - -.share-form__limit-name .optional-label { - display: block; -} - -.share-form__scenes { - margin-top: 0.9rem; -} - -.review-form__scene-empty { - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.9rem; - color: var(--neutral-400); - margin: 0; - padding: 0.6rem 1rem; -} - /* ===== Review link fallback dialog ===== */ .review-link-dialog__explain { @@ -2149,615 +1833,9 @@ color: var(--neutral-600); } -/* Short viewports: give the dialog's own chrome back to the scene list */ -@media only screen and (max-height: 900px) { - .dialog--sheet { - max-height: calc(100vh - 16px); - max-height: calc(100dvh - 16px); - } - - .dialog--sheet .dialog__header, - .dialog--sheet .dialog__actions { - padding-top: 0.75rem; - padding-bottom: 0.75rem; - } - - .dialog--sheet .dialog__body { - padding: 1rem 1.25rem; - } - - .dialog--sheet .form-field:not(:last-child) { - margin-bottom: 0.85rem; - } - - .review-form__note { - min-height: 2.2rem; - } -} - @media only screen and (max-width: 600px) { .review-form__row { flex-direction: column; gap: 0; } - - /* Full-height sheet, so the list gets every pixel the phone has */ - .dialog--sheet { - width: 100%; - max-width: 100%; - height: 100vh; - height: 100dvh; - max-height: 100vh; - max-height: 100dvh; - margin: 0; - border-radius: 0; - border-left: none; - border-right: none; - } -} - -/* ======================================== - Reader Kudos (public story page) - ======================================== */ - -.story-kudos-slot { - min-height: 1px; -} - -.story-kudos { - margin-top: 3.5rem; -} - -.story-kudos--enter { - animation: slideInUp 0.5s ease-out both; -} - -/* "The End", ruled out to either side */ -.story-kudos__fin { - display: flex; - align-items: center; - gap: 1.25rem; - margin: 0 0 2.5rem; - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.85rem; - letter-spacing: 0.35em; - text-transform: uppercase; - color: var(--text-tertiary); -} - -.story-kudos__fin::before, -.story-kudos__fin::after { - content: ''; - flex: 1; - height: 1px; - background: linear-gradient(to right, transparent, var(--neutral-300)); -} - -.story-kudos__fin::after { - background: linear-gradient(to left, transparent, var(--neutral-300)); -} - -/* Lined notebook page */ -.story-kudos__card { - position: relative; - padding: 2.25rem 2.5rem 1.75rem 4rem; - background-color: var(--paper-white); - background-image: repeating-linear-gradient( - transparent, - transparent 31px, - rgba(37, 99, 235, 0.05) 31px, - rgba(37, 99, 235, 0.05) 32px - ); - border-top: 4px solid var(--accent); - border-radius: 0.75rem; - box-shadow: var(--shadow-lg), inset 0 0 0 1px rgba(0, 0, 0, 0.05); -} - -/* Red margin rule */ -.story-kudos__card::before { - content: ''; - position: absolute; - left: 2.75rem; - top: 0; - bottom: 0; - width: 2px; - background: rgba(239, 68, 68, 0.2); - pointer-events: none; -} - -.story-kudos__header { - display: flex; - align-items: center; - gap: 1rem; - margin-bottom: 1.75rem; -} - -.story-kudos__badge { - flex: none; - display: flex; - align-items: center; - justify-content: center; - width: 2.75rem; - height: 2.75rem; - border-radius: 50%; - background: var(--accent); - color: #ffffff; - font-size: 1.1rem; - box-shadow: 0 0 0 4px #fdf1e3; -} - -.story-kudos__eyebrow { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.72rem; - letter-spacing: 0.12em; - text-transform: uppercase; - color: var(--text-tertiary); - margin: 0 0 0.2rem; -} - -.story-kudos__title { - font-family: 'Kingthings Typewriter', monospace; - font-size: 1.5rem; - font-weight: normal; - line-height: 1.25; - color: var(--text-primary); - margin: 0; -} - -/* What readers loved, as a taped-on sticky note */ -.story-kudos__highlights { - position: relative; - max-width: 32rem; - margin: 0.75rem 0 2rem; - padding: 1.4rem 1.5rem 1.25rem; - background: var(--sticky-yellow); - border-radius: 2px; - box-shadow: var(--shadow-sticky); - transform: rotate(-0.6deg); -} - -.story-kudos__highlights::before { - content: ''; - position: absolute; - top: -0.7rem; - left: 50%; - width: 5.5rem; - height: 1.4rem; - transform: translateX(-50%) rotate(-2deg); - background: rgba(255, 255, 255, 0.55); - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.08); -} - -.story-kudos__lead { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.72rem; - letter-spacing: 0.08em; - text-transform: uppercase; - color: var(--neutral-700); - margin: 0 0 0.6rem; -} - -.story-kudos__stamps { - display: flex; - flex-wrap: wrap; - gap: 0.6rem; - list-style: none; - margin: 0 0 1rem; - padding: 0; -} - -.story-kudos__stamps:last-child { - margin-bottom: 0; -} - -/* Rubber stamp: double inked border with an alternating slight tilt */ -.story-kudos__stamp { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.8rem; - letter-spacing: 0.05em; - text-transform: uppercase; - color: var(--accent-dark); - border: 3px double var(--accent); - border-radius: 4px; - padding: 0.25rem 0.65rem; - transform: rotate(-1.5deg); -} - -.story-kudos__stamp:nth-child(even) { - transform: rotate(1.2deg); -} - -.story-kudos__stamp--reaction { - color: var(--primary-dark); - border-color: var(--primary); -} - -.story-kudos__form { - margin: 0; -} - -.story-kudos__signin { - display: flex; - flex-wrap: wrap; - align-items: center; - justify-content: space-between; - gap: 0.75rem 1rem; - margin-bottom: 1.75rem; - padding: 0.9rem 1.1rem; - background: #fdf1e3; - border: 1px dashed var(--accent-light); - border-radius: 0.5rem; -} - -.story-kudos__signin p { - margin: 0; - font-family: 'Lora', Georgia, serif; - font-style: italic; - color: var(--neutral-700); -} - -.story-kudos__signin-btn { - font-size: 0.9rem; - padding: 0.45rem 1.1rem; - text-decoration: none; -} - -.story-kudos__group { - border: none; - margin: 0 0 1.75rem; - padding: 0; - min-width: 0; -} - -.story-kudos__prompt { - font-family: 'Lora', Georgia, serif; - font-size: 1.1rem; - color: var(--text-primary); - padding: 0; - margin-bottom: 0.75rem; -} - -.story-kudos__hint { - font-style: italic; - font-size: 0.85rem; - color: var(--text-tertiary); - margin-left: 0.35rem; -} - -.story-kudos__count { - display: inline-block; - margin-left: 0.5rem; - padding: 0.1rem 0.55rem; - border-radius: 999px; - background: var(--neutral-100); - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.7rem; - color: var(--neutral-600); - vertical-align: middle; -} - -.story-kudos__chips { - display: flex; - flex-wrap: wrap; - gap: 0.55rem; -} - -.story-kudos__input { - position: absolute; - opacity: 0; - pointer-events: none; -} - -/* Craft chips: paper tags that take a check mark when picked */ -.story-kudos__chip { - display: inline-flex; - align-items: center; - gap: 0.4rem; - font-size: 0.85rem; - box-shadow: 0 1px 0 rgba(0, 0, 0, 0.04); -} - -.story-kudos__input:not(:disabled) + .story-kudos__chip:hover { - border-color: var(--accent-light); - color: var(--accent-dark); - transform: translateY(-1px); - box-shadow: var(--shadow-sm); -} - -.story-kudos__input:checked + .story-kudos__chip { - box-shadow: var(--shadow-sm); -} - -.story-kudos__input:checked + .story-kudos__chip::before { - content: '\f00c'; - font-family: 'Font Awesome 6 Free'; - font-weight: 900; - font-size: 0.7em; -} - -.story-kudos__input:disabled + .story-kudos__chip { - cursor: default; - opacity: 0.55; - border-color: var(--neutral-200); - color: var(--neutral-500); -} - -/* Reactions: larger tiles with an icon */ -.story-kudos__chips--reaction { - display: grid; - grid-template-columns: repeat(4, minmax(0, 1fr)); - gap: 0.75rem; -} - -.story-kudos__reaction { - display: flex; - flex-direction: column; - align-items: center; - justify-content: center; - gap: 0.55rem; - min-height: 6rem; - padding: 1rem 0.5rem 0.85rem; - text-align: center; - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.8rem; - line-height: 1.3; - color: var(--neutral-600); - background: #ffffff; - border: 1.5px solid var(--neutral-300); - border-radius: 0.6rem; - cursor: pointer; - user-select: none; - transition: all var(--transition-fast); -} - -.story-kudos__reaction-icon { - font-size: 1.5rem; - color: var(--neutral-400); - transition: all var(--transition-fast); -} - -.story-kudos__input:not(:disabled) + .story-kudos__reaction:hover { - border-color: var(--primary-light); - color: var(--primary-dark); - transform: translateY(-2px); - box-shadow: var(--shadow-md); -} - -.story-kudos__input:not(:disabled) + .story-kudos__reaction:hover .story-kudos__reaction-icon { - color: var(--primary-light); -} - -.story-kudos__input:checked + .story-kudos__reaction { - border-color: var(--primary); - background: #eff6ff; - color: var(--primary-dark); - box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.15); -} - -.story-kudos__input:checked + .story-kudos__reaction .story-kudos__reaction-icon { - color: var(--primary); - transform: scale(1.12); -} - -.story-kudos__input:focus-visible + .story-kudos__reaction { - outline: 2px solid var(--primary); - outline-offset: 3px; -} - -.story-kudos__input:disabled + .story-kudos__reaction { - cursor: default; - opacity: 0.55; -} - -.story-kudos__note { - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.95rem; - color: var(--text-secondary); - margin: 0; -} - -.story-kudos__status { - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.95rem; - color: #047857; - margin: 0 0 0.75rem; -} - -.story-kudos__status:empty { - display: none; -} - -.story-kudos__fineprint { - margin: 0; - padding-top: 0.9rem; - border-top: 1px dashed var(--neutral-200); - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.8rem; - color: var(--text-tertiary); -} - -.story-kudos__fineprint i { - margin-right: 0.3rem; -} - -@media only screen and (max-width: 560px) { - .story-kudos__card { - padding: 1.75rem 1.25rem 1.5rem 2.5rem; - } - - .story-kudos__card::before { - left: 1.4rem; - } - - .story-kudos__title { - font-size: 1.25rem; - } - - .story-kudos__chips--reaction { - grid-template-columns: repeat(2, minmax(0, 1fr)); - } -} - -/* ======================================== - Kudos panel (author story page) - ======================================== */ - -.info-panel-icon--kudos { - background: var(--accent); -} - -.kudos-tally__heading { - display: flex; - align-items: center; - gap: 0.6rem; - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.7rem; - letter-spacing: 0.08em; - text-transform: uppercase; - color: var(--text-secondary); - margin: 1.1rem 0 0.6rem; -} - -.kudos-tally__heading::after { - content: ''; - flex: 1; - border-top: 1px dashed var(--neutral-200); -} - -.kudos-tally { - display: flex; - flex-direction: column; - gap: 0.6rem; - list-style: none; - margin: 0; - padding: 0; -} - -/* Label and count on one line, a slim bar beneath */ -.kudos-tally__row { - display: grid; - grid-template-columns: 1fr auto; - align-items: baseline; - column-gap: 0.75rem; - row-gap: 0.3rem; - font-family: 'Lora', Georgia, serif; - font-size: 0.9rem; - color: var(--text-primary); -} - -.kudos-tally__label { - display: inline-flex; - align-items: center; - gap: 0.4rem; - min-width: 0; -} - -.kudos-tally__icon { - width: 1rem; - text-align: center; - font-size: 0.85rem; - color: var(--primary); -} - -.kudos-tally__public { - font-size: 0.7rem; - color: var(--accent); -} - -.kudos-tally__count { - font-family: 'Kingthings Typewriter', monospace; - font-size: 0.9rem; - color: var(--accent-dark); -} - -.kudos-tally__bar { - grid-column: 1 / -1; - height: 5px; - background: var(--neutral-100); - border-radius: 999px; - overflow: hidden; -} - -.kudos-tally__fill { - display: block; - height: 100%; - min-width: 5px; - background: linear-gradient(90deg, var(--accent-light), var(--accent)); - border-radius: 999px; -} - -.kudos-tally--reaction .kudos-tally__count { - color: var(--primary-dark); -} - -.kudos-tally--reaction .kudos-tally__fill { - background: linear-gradient(90deg, var(--primary-light), var(--primary)); -} - -.kudos-tally__legend { - margin: 1rem 0 0; - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.78rem; - color: var(--text-tertiary); -} - -.kudos-tally__legend i { - margin-right: 0.25rem; - color: var(--accent); -} - -.kudos-panel__empty { - text-align: center; - padding: 0.35rem 0.25rem 0; -} - -.kudos-panel__empty i { - display: inline-flex; - align-items: center; - justify-content: center; - width: 3rem; - height: 3rem; - border-radius: 50%; - background: #fdf1e3; - color: var(--accent-light); - font-size: 1.3rem; -} - -.kudos-panel__empty p { - margin: 0.7rem 0 0; - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.85rem; - line-height: 1.5; - color: var(--text-secondary); -} - -.kudos-panel__note { - font-family: 'Lora', Georgia, serif; - font-style: italic; - font-size: 0.8rem; - color: var(--text-tertiary); - margin: 0.5rem 0 0; -} - -/* Reuses the publish switch; text on the left, switch on the right */ -.kudos-panel__toggle { - justify-content: space-between; - margin-top: 1.1rem; - padding-top: 0.9rem; - border-top: 1px dashed var(--neutral-200); -} - -.kudos-panel__toggle-text { - font-family: 'Lora', Georgia, serif; - font-size: 0.88rem; - color: var(--text-primary); -} - -.kudos-panel__toggle .publish-toggle-track { - flex: none; } diff --git a/server/src/main/resources/assets/js/dashboard.js b/server/src/main/resources/assets/js/dashboard.js index 67d3ca1a1..41c555e09 100644 --- a/server/src/main/resources/assets/js/dashboard.js +++ b/server/src/main/resources/assets/js/dashboard.js @@ -274,41 +274,6 @@ document.addEventListener('DOMContentLoaded', function () { } }); -// ======================================== -// Account Deletion Functions -// ======================================== - -function onDeleteAccountConfirmInput(input) { - const expected = (input.dataset.email || '').trim().toLowerCase(); - const matches = input.value.trim().toLowerCase() === expected; - document.getElementById('delete-account-btn').disabled = !matches; -} - -function closeDeleteAccountDialog(event) { - // If event is provided and it's not on the overlay itself, ignore - if (event && event.target !== event.currentTarget) { - return; - } - - const overlay = document.getElementById('delete-account-dialog-overlay'); - if (overlay) { - overlay.classList.add('closing'); - setTimeout(function () { - const container = document.getElementById('delete-account-dialog-container'); - if (container) { - container.innerHTML = ''; - } - }, 200); - } -} - -// Close the delete-account dialog on Escape -document.addEventListener('keydown', function (e) { - if (e.key === 'Escape') { - closeDeleteAccountDialog(); - } -}); - // ======================================== // Bio Management Functions // ======================================== diff --git a/server/src/main/resources/assets/js/review-form-logic.js b/server/src/main/resources/assets/js/review-form-logic.js index ca8b45f39..9d138406b 100644 --- a/server/src/main/resources/assets/js/review-form-logic.js +++ b/server/src/main/resources/assets/js/review-form-logic.js @@ -47,22 +47,11 @@ function canSendReview(checkedCount, email) { return checkedCount > 0 && !!email && email.includes('@'); } -/** - * Whether a private share can be created: either it isn't limited to specific - * scenes, or at least one scene is picked. - * @param {boolean} limitEnabled - * @param {number} checkedCount - */ -function canCreateShare(limitEnabled, checkedCount) { - return !limitEnabled || checkedCount > 0; -} - if (typeof module !== 'undefined' && module.exports) { module.exports = { nextToggleState: nextToggleState, allSelected: allSelected, reviewCountLabel: reviewCountLabel, canSendReview: canSendReview, - canCreateShare: canCreateShare, }; } diff --git a/server/src/main/resources/assets/js/review-logic.js b/server/src/main/resources/assets/js/review-logic.js index e7809bb3a..ebd5277d3 100644 --- a/server/src/main/resources/assets/js/review-logic.js +++ b/server/src/main/resources/assets/js/review-logic.js @@ -107,18 +107,18 @@ function applyAccepted(text, suggestions) { * at the punctuation's source offset, so the per-run source-slice invariant * holds), and an escaped marker can neither open nor close emphasis. * - * @returns {Array<{text:string, srcStart:number, bold:boolean, italic:boolean, strike:boolean}>} + * @returns {Array<{text:string, srcStart:number, bold:boolean, italic:boolean}>} */ function parseInlineMarkdown(text) { const ESCAPABLE = '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~'; const runs = []; - function emit(str, srcStart, bold, italic, strike) { + function emit(str, srcStart, bold, italic) { if (str.length === 0) return; - runs.push({ text: str, srcStart: srcStart, bold: bold, italic: italic, strike: strike }); + runs.push({ text: str, srcStart: srcStart, bold: bold, italic: italic }); } - function isFlankableBefore(ch) { return !ch || !/[\w*_~]/.test(ch); } + function isFlankableBefore(ch) { return !ch || !/[\w*_]/.test(ch); } function findClose(marker, from, end) { let i = from; @@ -138,22 +138,20 @@ function parseInlineMarkdown(text) { return -1; } - function walk(start, end, bold, italic, strike) { + function walk(start, end, bold, italic) { let plainFrom = start; let i = start; while (i < end) { const ch = text[i]; if (ch === '\\' && i + 1 < end && ESCAPABLE.indexOf(text[i + 1]) !== -1) { - emit(text.slice(plainFrom, i), plainFrom, bold, italic, strike); - emit(text[i + 1], i + 1, bold, italic, strike); + emit(text.slice(plainFrom, i), plainFrom, bold, italic); + emit(text[i + 1], i + 1, bold, italic); i += 2; plainFrom = i; continue; } - if (ch !== '*' && ch !== '_' && ch !== '~') { i++; continue; } + if (ch !== '*' && ch !== '_') { i++; continue; } const double = text[i + 1] === ch; - // GFM strikethrough is only the doubled form; a lone `~` is literal. - if (ch === '~' && !double) { i++; continue; } const marker = double ? ch + ch : ch; const contentFrom = i + marker.length; const openOk = isFlankableBefore(text[i - 1]) && @@ -162,21 +160,15 @@ function parseInlineMarkdown(text) { const close = findClose(marker, contentFrom + 1, end); if (close === -1) { i++; continue; } - emit(text.slice(plainFrom, i), plainFrom, bold, italic, strike); - walk( - contentFrom, - close, - bold || (double && ch !== '~'), - italic || (!double && ch !== '~'), - strike || ch === '~', - ); + emit(text.slice(plainFrom, i), plainFrom, bold, italic); + walk(contentFrom, close, bold || double, italic || !double); i = close + marker.length; plainFrom = i; } - emit(text.slice(plainFrom, end), plainFrom, bold, italic, strike); + emit(text.slice(plainFrom, end), plainFrom, bold, italic); } - walk(0, text.length, false, false, false); + walk(0, text.length, false, false); return runs; } @@ -196,7 +188,6 @@ function runsForRange(runs, start, end) { srcStart: s, bold: r.bold, italic: r.italic, - strike: r.strike, }); } return out; diff --git a/server/src/main/resources/assets/js/review.js b/server/src/main/resources/assets/js/review.js index 5ac103895..5408ed510 100644 --- a/server/src/main/resources/assets/js/review.js +++ b/server/src/main/resources/assets/js/review.js @@ -78,21 +78,17 @@ function runNode(run) { const tn = document.createTextNode(run.text); nodeSrcStart.set(tn, run.srcStart); - if (!run.bold && !run.italic && !run.strike) return tn; - const span = el('span', { style: runStyle(run) }); + if (!run.bold && !run.italic) return tn; + const span = el('span', { + style: { + fontWeight: run.bold ? '700' : '', + fontStyle: run.italic ? 'italic' : '', + }, + }); span.appendChild(tn); return span; } - /** Inline styles for a parsed markdown run. */ - function runStyle(run) { - return { - fontWeight: run.bold ? '700' : '', - fontStyle: run.italic ? 'italic' : '', - textDecoration: run.strike ? 'line-through' : '', - }; - } - /** Append the styled display pieces for source range [start,end) of a paragraph. */ function appendRange(parent, paraRuns, start, end) { runsForRange(paraRuns, start, end).forEach((run) => parent.appendChild(runNode(run))); @@ -101,11 +97,8 @@ /** Append free text with its inline emphasis rendered (no source offsets — not manuscript text). */ function appendStyledText(parent, text) { parseInlineMarkdown(text).forEach((run) => { - if (!run.bold && !run.italic && !run.strike) { - parent.appendChild(document.createTextNode(run.text)); - return; - } - const span = el('span', { style: runStyle(run) }); + if (!run.bold && !run.italic) { parent.appendChild(document.createTextNode(run.text)); return; } + const span = el('span', { style: { fontWeight: run.bold ? '700' : '', fontStyle: run.italic ? 'italic' : '' } }); span.appendChild(document.createTextNode(run.text)); parent.appendChild(span); }); diff --git a/server/src/main/resources/assets/js/story.js b/server/src/main/resources/assets/js/story.js index c395bea82..870d3458e 100644 --- a/server/src/main/resources/assets/js/story.js +++ b/server/src/main/resources/assets/js/story.js @@ -296,22 +296,17 @@ document.addEventListener('keydown', function (e) { if (e.key === 'Escape') closeReviewDialog(); }); -// Scene checkbox changes: update the count and gate the submit button. -// Both the review dialog and the share dialog mark their form data-scene-select. +// Scene checkbox changes: update the count and gate the send button document.addEventListener('change', function (e) { - const form = e.target.closest('form[data-scene-select]'); - if (!form) return; - if (e.target.name === 'limitScenes') { - const scenes = form.querySelector('.share-form__scenes'); - if (scenes) scenes.hidden = !e.target.checked; - } - updateSceneSelectFormState(form); + const form = document.getElementById('review-request-form'); + if (!form || !form.contains(e.target)) return; + updateReviewFormState(form); }); document.addEventListener('input', function (e) { - const form = e.target.closest('form[data-scene-select]'); - if (!form) return; - updateSceneSelectFormState(form); + const form = document.getElementById('review-request-form'); + if (!form || !form.contains(e.target)) return; + updateReviewFormState(form); }); /** Every scene checkbox nested under a group toggle, to the next sibling at or above its depth. */ @@ -342,8 +337,8 @@ document.addEventListener('click', function (e) { toggleBoxes(groupToggleBoxes(toggle)); - const form = toggle.closest('form[data-scene-select]'); - if (form) updateSceneSelectFormState(form); + const form = document.getElementById('review-request-form'); + if (form) updateReviewFormState(form); }); // Master "Select all"/"Clear all" toggles every scene in the project @@ -352,13 +347,12 @@ document.addEventListener('click', function (e) { if (!master) return; e.preventDefault(); - const form = master.closest('form[data-scene-select]'); - if (!form) return; - const tree = form.querySelector('.review-form__scene-tree'); + const tree = document.getElementById('review-scene-tree'); if (!tree) return; toggleBoxes(Array.from(tree.querySelectorAll('.review-scene-row__check'))); - updateSceneSelectFormState(form); + const form = document.getElementById('review-request-form'); + if (form) updateReviewFormState(form); }); /** @@ -372,21 +366,22 @@ function toggleBoxes(boxes) { } /** - * Update the selected-scene count, the toggle button labels, and the submit button - * of a scene-selecting form (review request or private share). - * @param {HTMLFormElement} form - A form marked data-scene-select + * Update the selected-scene count, the toggle button labels, and the send button + * @param {HTMLFormElement} form - The review request form */ -function updateSceneSelectFormState(form) { - const allBoxes = Array.from(form.querySelectorAll('.review-form__scene-tree .review-scene-row__check')); +function updateReviewFormState(form) { + const allBoxes = Array.from(form.querySelectorAll('.review-scene-row__check')); const checked = allBoxes.filter(function (b) { return b.checked; }).length; - const counter = form.querySelector('.review-form__scene-count'); + const email = form.querySelector('#review-email'); + const sendBtn = form.querySelector('#review-send-btn'); + const counter = document.getElementById('review-scene-count'); if (counter) { counter.textContent = reviewCountLabel(checked, counter.dataset.total, counter.dataset.noneLabel || 'none selected'); } // Master toggle reads "Clear all" once everything is selected - const master = form.querySelector('.review-scene-master__toggle'); + const master = document.getElementById('review-select-all'); if (master) { const allChecked = allSelected(allBoxes.map(function (b) { return b.checked; })); master.textContent = allChecked ? master.dataset.clearLabel : master.dataset.selectLabel; @@ -399,13 +394,7 @@ function updateSceneSelectFormState(form) { toggle.textContent = allChecked ? toggle.dataset.clearLabel : toggle.dataset.selectLabel; }); - const submitBtn = form.querySelector('[data-scene-submit]'); - if (!submitBtn) return; - const email = form.querySelector('[name="reviewerEmail"]'); - if (email) { - submitBtn.disabled = !canSendReview(checked, email.value); - } else { - const limit = form.querySelector('[name="limitScenes"]'); - submitBtn.disabled = !canCreateShare(!!(limit && limit.checked), checked); + if (sendBtn) { + sendBtn.disabled = !canSendReview(checked, email ? email.value : ''); } } diff --git a/server/src/main/resources/assets/js/toast-logic.js b/server/src/main/resources/assets/js/toast-logic.js deleted file mode 100644 index 29cf97fa1..000000000 --- a/server/src/main/resources/assets/js/toast-logic.js +++ /dev/null @@ -1,30 +0,0 @@ -/** - * Pure decision logic for htmx error responses — no DOM, no globals beyond these - * functions and constants. Kept DOM-free so it can be unit-tested under Node - * while still loading as a plain browser {{#page_pre_script}} diff --git a/server/src/main/resources/templates/header.mustache b/server/src/main/resources/templates/header.mustache index cd171fea3..9862a3530 100644 --- a/server/src/main/resources/templates/header.mustache +++ b/server/src/main/resources/templates/header.mustache @@ -3,9 +3,6 @@ - {{#iosAppStoreId}} - - {{/iosAppStoreId}} {{title}} {{#metaDescription}} diff --git a/server/src/main/resources/templates/home.mustache b/server/src/main/resources/templates/home.mustache index 414e950fb..a67727c23 100644 --- a/server/src/main/resources/templates/home.mustache +++ b/server/src/main/resources/templates/home.mustache @@ -429,7 +429,7 @@ F-Droid @@ -448,7 +448,7 @@ 🍎

iOS

App Store - diff --git a/server/src/main/resources/templates/login.mustache b/server/src/main/resources/templates/login.mustache index 12e9ceb9e..c5cfcce10 100644 --- a/server/src/main/resources/templates/login.mustache +++ b/server/src/main/resources/templates/login.mustache @@ -36,17 +36,28 @@ - - {{{allowedUsersNoticeHtml}}} - {{^allowedUsersNoticeProvided}} - diff --git a/server/src/main/resources/templates/partials/access-list.mustache b/server/src/main/resources/templates/partials/access-list.mustache index bb15f26a2..5206aa88c 100644 --- a/server/src/main/resources/templates/partials/access-list.mustache +++ b/server/src/main/resources/templates/partials/access-list.mustache @@ -31,24 +31,6 @@ {{msg.story_access_no_expiry}}
{{/expiresAtFormatted}} - {{#isRestricted}} - {{#isSceneless}} - - {{msg.story_access_no_scenes_left}} - - {{/isSceneless}} - {{^isSceneless}} - - - {{sceneCount}} {{#isSingleScene}}{{msg.story_access_scene_single}}{{/isSingleScene}}{{^isSingleScene}}{{msg.story_access_scenes_suffix}}{{/isSingleScene}} - - {{/isSceneless}} - {{/isRestricted}} - {{^isRestricted}} - - {{msg.story_access_entire_story}} - - {{/isRestricted}} - -
-
-

{{msg.account_delete_dialog_devices_note}}

-

{{retentionNote}}

-

{{msg.account_delete_dialog_email_note}}

-

{{msg.account_delete_dialog_permanent_note}}

-
- {{msg.account_delete_dialog_project_count_label}} - {{projectCount}} -
-
- - -
-
-
- - -
-
- - diff --git a/server/src/main/resources/templates/partials/review-request-dialog.mustache b/server/src/main/resources/templates/partials/review-request-dialog.mustache index 8e091c633..4f72c89df 100644 --- a/server/src/main/resources/templates/partials/review-request-dialog.mustache +++ b/server/src/main/resources/templates/partials/review-request-dialog.mustache @@ -1,7 +1,7 @@
-
+

{{msg.review_dialog_title}}

@@ -68,21 +67,50 @@
-
+
{{msg.review_dialog_scenes}} {{msg.review_dialog_scenes_none}}
- {{> scene-select-tree}} +
+
+ {{msg.review_dialog_all_scenes}} + +
+ {{#sceneTree}} + {{#isGroup}} +
+ {{name}} + +
+ {{/isGroup}} + {{#isScene}} + + {{/isScene}} + {{/sceneTree}} +
-
diff --git a/server/src/main/resources/templates/partials/scene-select-tree.mustache b/server/src/main/resources/templates/partials/scene-select-tree.mustache deleted file mode 100644 index 685a78dbf..000000000 --- a/server/src/main/resources/templates/partials/scene-select-tree.mustache +++ /dev/null @@ -1,37 +0,0 @@ - -
-
- {{msg.review_dialog_all_scenes}} - -
-
- {{^sceneTree}} -

{{msg.scene_select_tree_empty}}

- {{/sceneTree}} - {{#sceneTree}} - {{#isGroup}} -
- {{name}} - -
- {{/isGroup}} - {{#isScene}} - - {{/isScene}} - {{/sceneTree}} -
-
diff --git a/server/src/main/resources/templates/partials/server-notice.mustache b/server/src/main/resources/templates/partials/server-notice.mustache index 68e4da222..f89c97943 100644 --- a/server/src/main/resources/templates/partials/server-notice.mustache +++ b/server/src/main/resources/templates/partials/server-notice.mustache @@ -1,20 +1,15 @@ {{#hasInstanceNotice}}
- {{#serverMessageHtml}} + {{#serverMessage}}
{{msg.home_servermessage}} -
{{{serverMessageHtml}}}
+
{{serverMessage}}
- {{/serverMessageHtml}} - {{#allowedUsersNotice}} + {{/serverMessage}} + {{#whitelistEnabled}}
-

{{msg.home_servermessage_allowedusers}}

+

{{msg.home_servermessage_whitelist}}

- {{/allowedUsersNotice}} - {{#allowedUsersBannerHtml}} -
- {{{allowedUsersBannerHtml}}} -
- {{/allowedUsersBannerHtml}} + {{/whitelistEnabled}}
{{/hasInstanceNotice}} diff --git a/server/src/main/resources/templates/partials/share-dialog.mustache b/server/src/main/resources/templates/partials/share-dialog.mustache index c4992ffd8..98adf1e8a 100644 --- a/server/src/main/resources/templates/partials/share-dialog.mustache +++ b/server/src/main/resources/templates/partials/share-dialog.mustache @@ -1,19 +1,15 @@ -
-
+

{{msg.story_share_private_title}}

- - + hx-swap="outerHTML" + hx-on::after-request="closeShareDialog()">
@@ -37,33 +33,12 @@ class="form-input" min="{{minDate}}">
-
- - - -
-
diff --git a/server/src/main/resources/templates/partials/story-kudos-panel.mustache b/server/src/main/resources/templates/partials/story-kudos-panel.mustache deleted file mode 100644 index 9da1f7647..000000000 --- a/server/src/main/resources/templates/partials/story-kudos-panel.mustache +++ /dev/null @@ -1,61 +0,0 @@ - diff --git a/server/src/main/resources/templates/partials/story-kudos-tally-row.mustache b/server/src/main/resources/templates/partials/story-kudos-tally-row.mustache deleted file mode 100644 index 666baa9f4..000000000 --- a/server/src/main/resources/templates/partials/story-kudos-tally-row.mustache +++ /dev/null @@ -1,9 +0,0 @@ -
  • - - {{#icon}}{{/icon}} - {{label}} - {{#isPublic}}{{/isPublic}} - - {{count}} - -
  • diff --git a/server/src/main/resources/templates/partials/story-kudos.mustache b/server/src/main/resources/templates/partials/story-kudos.mustache deleted file mode 100644 index a32d9ad06..000000000 --- a/server/src/main/resources/templates/partials/story-kudos.mustache +++ /dev/null @@ -1,80 +0,0 @@ -
    - - -
    -
    - -
    - {{^isAuthor}}

    {{msg.kudos_eyebrow}}

    {{/isAuthor}} -

    {{kudosTitle}}

    -
    -
    - - {{#hasHighlights}} -
    - {{#hasCraftHighlights}} -

    {{msg.kudos_readers_loved}}

    -
      - {{#craftHighlights}}
    • {{.}}
    • {{/craftHighlights}} -
    - {{/hasCraftHighlights}} - {{#hasReactionHighlights}} -

    {{msg.kudos_readers_said}}

    -
      - {{#reactionHighlights}}
    • {{.}}
    • {{/reactionHighlights}} -
    - {{/hasReactionHighlights}} -
    - {{/hasHighlights}} - - {{#isAuthor}} -

    {{msg.kudos_author_note}}

    - {{/isAuthor}} - - {{^isAuthor}} - - {{#isSignedOut}} -
    - {{/isSignedOut}} - {{#groups}} -
    - - {{prompt}} - {{hint}} - {{#showCount}}{{count}}{{/showCount}} - -
    - {{#chips}} - - {{#isReaction}} - - {{/isReaction}} - {{^isReaction}} - - {{/isReaction}} - {{/chips}} -
    -
    - {{/groups}} -

    {{#justSaved}} {{msg.kudos_saved}}{{/justSaved}}

    -

    - {{msg.kudos_anonymous_note}} -

    - - {{/isAuthor}} -
    -
    diff --git a/server/src/main/resources/templates/partials/story-page-content.mustache b/server/src/main/resources/templates/partials/story-page-content.mustache index 7907faa3f..ca6e5d1ad 100644 --- a/server/src/main/resources/templates/partials/story-page-content.mustache +++ b/server/src/main/resources/templates/partials/story-page-content.mustache @@ -1,4 +1,4 @@ -
    {{{storyHtml}}}
    +
    {{{storyHtml}}}
    {{#hasPagination}}
    {{/isPublished}} + +
    +
    diff --git a/server/src/main/resources/templates/partials/users.mustache b/server/src/main/resources/templates/partials/users.mustache index b30f7a4d9..d064b06f7 100644 --- a/server/src/main/resources/templates/partials/users.mustache +++ b/server/src/main/resources/templates/partials/users.mustache @@ -81,9 +81,6 @@ {{#hasPenName}} {{penName}} {{/hasPenName}} - {{#pendingDeletion}} - {{msg.admin_users_pending_deletion}} - {{/pendingDeletion}}
    @@ -98,14 +95,6 @@ {{msg.admin_users_last_sync}}: {{lastSync}} - {{#pendingDeletion}} - - {{/pendingDeletion}}
    {{/.}} diff --git a/server/src/main/resources/templates/partials/allowed-users.mustache b/server/src/main/resources/templates/partials/whitelist.mustache similarity index 57% rename from server/src/main/resources/templates/partials/allowed-users.mustache rename to server/src/main/resources/templates/partials/whitelist.mustache index 5e1b62b17..bbd920c4a 100644 --- a/server/src/main/resources/templates/partials/allowed-users.mustache +++ b/server/src/main/resources/templates/partials/whitelist.mustache @@ -3,37 +3,23 @@
    {{error}}
    {{/error}} - {{! Controls outside this fragment pull the current view state from here via hx-include. }} - - -
    - {{#hasSearch}} - - {{msg.admin_allowedusers_search_filtered_by}} {{search}} - - - {{/hasSearch}} {{#sortNewestFirst}} - {{/sortNewestFirst}} {{#sortOldestFirst}} - {{/sortOldestFirst}}
    @@ -46,13 +32,13 @@ {{#hasAccount}} {{/hasAccount}} {{^hasAccount}} {{/hasAccount}} @@ -64,7 +50,7 @@ • - {{msg.admin_allowedusers_expires_prefix}} {{expires}} + {{msg.admin_whitelist_expires_prefix}} {{expires}} {{/hasExpiry}} @@ -75,55 +61,45 @@ data-reason="{{reason}}" data-page="{{currentPage}}" data-sort-oldest-first="{{sortOldestFirst}}" - data-q="{{search}}" onclick="openEditReasonDialog(this)"> - {{msg.admin_allowedusers_edit_button}} + {{msg.admin_whitelist_edit_button}} - {{^sourceManaged}} + {{^isPatreon}} - {{/sourceManaged}} -
    + hx-confirm="Remove {{email}} from the whitelist?"> - - +
    {{/items}} {{^items}}
    - {{#hasSearch}} -

    {{msg.admin_allowedusers_search_empty}}

    - - {{/hasSearch}} - {{^hasSearch}} -

    {{msg.admin_allowedusers_empty}}

    - {{/hasSearch}} -
    +

    {{msg.admin_whitelist_empty}}

    + {{/items}} - {{#hasPages}} + {{#totalPages}} - {{/hasPages}} + {{/totalPages}} {{/whitelist}} diff --git a/server/src/main/resources/templates/publicstory.mustache b/server/src/main/resources/templates/publicstory.mustache index 4d662a2c7..28f373fd7 100644 --- a/server/src/main/resources/templates/publicstory.mustache +++ b/server/src/main/resources/templates/publicstory.mustache @@ -34,11 +34,6 @@
    {{> partials/story-page-content}}
    - {{#kudosFragmentUrl}} - {{^hasNextPage}} -
    - {{/hasNextPage}} - {{/kudosFragmentUrl}} {{/hasContent}} {{^hasContent}}
    diff --git a/server/src/main/resources/templates/setup.mustache b/server/src/main/resources/templates/setup.mustache index 49738bea5..12bdce081 100644 --- a/server/src/main/resources/templates/setup.mustache +++ b/server/src/main/resources/templates/setup.mustache @@ -13,64 +13,29 @@ {{msg.setup_admin_note}} -
    -
    - - +
    +
    + 1 + {{msg.setup_step1}}
    - -
    - - -

    {{msg.password_reset_requirements}}

    +
    + 2 + {{msg.setup_step2}}
    - -
    - - +
    + + + + {{serverAddress}}
    - - {{#error}} -
    -

    {{error}}

    -
    - {{/error}} - -
    - +
    + 3 + {{msg.setup_step3}}
    - +
    -
    -

    {{msg.setup_alt_title}}

    - -
    -
    - 1 - {{msg.setup_step1}} -
    -
    - 2 - {{msg.setup_step2}} -
    -
    - - - - {{serverAddress}} -
    -
    - 3 - {{msg.setup_step3}} -
    -
    - -
    -

    {{msg.setup_return_note}}

    -
    +
    +

    {{msg.setup_return_note}}

    diff --git a/server/src/main/resources/templates/signup.mustache b/server/src/main/resources/templates/signup.mustache deleted file mode 100644 index fc0253859..000000000 --- a/server/src/main/resources/templates/signup.mustache +++ /dev/null @@ -1,70 +0,0 @@ -{{> header}} - -
    -
    -
    - - - - - -
    -
    -
    - -{{> footer}} diff --git a/server/src/main/resources/templates/story.mustache b/server/src/main/resources/templates/story.mustache index db63ca7f7..9593d05e5 100644 --- a/server/src/main/resources/templates/story.mustache +++ b/server/src/main/resources/templates/story.mustache @@ -41,8 +41,7 @@ {{/hasScenes}} -
    +
    {{#hasContent}} {{{storyHtml}}} {{/hasContent}} @@ -118,8 +117,6 @@
    {{/hasAnyAccess}} - {{> partials/story-kudos-panel}} - +
    - -
    -
    -
    - {{> footer}} diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Account.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Account.sq index 55deb0119..0f2a0fda2 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Account.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Account.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- email and pen_name columns are declared TEXT here for SqlDelight's parser, -- and promoted to CITEXT in PostgresSchemaPostInit so comparisons and the @@ -15,7 +15,6 @@ CREATE TABLE account( bio TEXT, email_verified BOOLEAN NOT NULL DEFAULT FALSE, community_member BOOLEAN NOT NULL DEFAULT FALSE, - deleted_at TIMESTAMPTZ AS Instant, CONSTRAINT account_email_shape CHECK (email LIKE '%@%.%'), CONSTRAINT account_bio_len CHECK (bio IS NULL OR length(bio) <= 10000), CONSTRAINT account_pen_name_len CHECK (pen_name IS NULL OR length(pen_name) BETWEEN 1 AND 64) @@ -24,7 +23,6 @@ CREATE TABLE account( CREATE UNIQUE INDEX account_email_unique ON account (email); CREATE UNIQUE INDEX account_pen_name_unique ON account (pen_name) WHERE pen_name IS NOT NULL; CREATE INDEX account_community_idx ON account (id) WHERE community_member = TRUE; -CREATE INDEX account_deleted_at_idx ON account (deleted_at) WHERE deleted_at IS NOT NULL; getAllAccount: SELECT * @@ -92,7 +90,7 @@ ORDER BY created DESC LIMIT :limit OFFSET :offset; getAccountsPaginatedSortByCreated: -SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, a.deleted_at, +SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, COALESCE((SELECT MAX(p.last_sync) FROM project p WHERE p.user_id = a.id), a.last_sync) AS most_recent_sync, COALESCE((SELECT COUNT(*) FROM project p WHERE p.user_id = a.id), 0) AS project_count FROM account a @@ -101,7 +99,7 @@ ORDER BY CASE WHEN :ascending = 1 THEN a.created END ASC, LIMIT :limit OFFSET :offset; getAccountsPaginatedSortByLastSync: -SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, a.deleted_at, +SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, COALESCE((SELECT MAX(p.last_sync) FROM project p WHERE p.user_id = a.id), a.last_sync) AS most_recent_sync, COALESCE((SELECT COUNT(*) FROM project p WHERE p.user_id = a.id), 0) AS project_count FROM account a @@ -110,7 +108,7 @@ ORDER BY CASE WHEN :ascending = 1 THEN COALESCE((SELECT MAX(p.last_sync) FROM pr LIMIT :limit OFFSET :offset; getAccountsPaginatedSortByProjectCount: -SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, a.deleted_at, +SELECT a.id, a.email, a.pen_name, a.created, a.last_sync, COALESCE((SELECT MAX(p.last_sync) FROM project p WHERE p.user_id = a.id), a.last_sync) AS most_recent_sync, COALESCE((SELECT COUNT(*) FROM project p WHERE p.user_id = a.id), 0) AS project_count FROM account a @@ -119,31 +117,6 @@ ORDER BY CASE WHEN :ascending = 1 THEN COALESCE((SELECT COUNT(*) FROM project p a.created DESC LIMIT :limit OFFSET :offset; --- Admin accounts can never be soft-deleted; the guard lives in the query as --- well as the service so no caller can mark one deleted by mistake. An --- already-deleted row is left untouched, so a retry that heals a partially --- failed softDelete never extends the retention window. -markDeleted: -UPDATE account -SET deleted_at = :deletedAt -WHERE id = :userId AND is_admin = FALSE AND deleted_at IS NULL; - -restoreDeleted: -UPDATE account SET deleted_at = NULL WHERE id = :userId; - -getSoftDeletedBefore: -SELECT * -FROM account -WHERE deleted_at IS NOT NULL AND deleted_at < :cutoff; - --- Row-locked read for the hard-delete transaction, so a concurrent restore --- serializes against the purge instead of racing it. -getAccountForUpdate: -SELECT * FROM account WHERE id = :userId FOR UPDATE; - -hardDeleteAccount: -DELETE FROM account WHERE id = :userId; - updatePassword: UPDATE account SET password_hash = ? WHERE id = ?; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ApiMetric.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ApiMetric.sq index d0f1f29a8..e70e15989 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ApiMetric.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ApiMetric.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Rolled-up API request metrics. The in-memory collector accumulates requests -- and flushes them into HOUR buckets; the maintenance job later rolls HOUR diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/AuthToken.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/AuthToken.sq index abece45a4..4064d0198 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/AuthToken.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/AuthToken.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- One auth_token row per (user_id, install_id) pair. The token itself is a -- separately UNIQUE credential. This restructure (vs SQLite's PK-on-token) lets @@ -26,13 +26,10 @@ SELECT * FROM auth_token WHERE user_id = ?; --- Tokens of soft-deleted accounts are invisible here, so the bearer auth gate --- rejects them in the same round trip that validates the token. getTokenByToken: SELECT * FROM auth_token -WHERE token = ? - AND user_id IN (SELECT id FROM account WHERE deleted_at IS NULL); +WHERE token = ?; getTokenByInstallId: SELECT * diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedEntity.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedEntity.sq index 759aed105..079d2bc11 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedEntity.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedEntity.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Audit trail of entities that have been deleted; sync clients consult it to -- know what to drop locally. @@ -27,6 +27,3 @@ SELECT EXISTS( markEntityDeleted: INSERT INTO deleted_entity(user_id, project_id, entity_id) VALUES (:userId, :projectId, :id); - -deleteAllForUser: -DELETE FROM deleted_entity WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedIdea.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedIdea.sq index 039609b44..81eaf7f97 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedIdea.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedIdea.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Permanent deletion tombstones for story ideas: written when a delete lands, never -- pruned, so a stale device holding a deleted idea cannot resurrect it on sync. @@ -28,6 +28,3 @@ ON CONFLICT (user_id, uuid) DO NOTHING; hasDeletedIdea: SELECT EXISTS(SELECT 1 FROM deleted_idea WHERE user_id = :userId AND uuid = CAST(:uuid AS UUID)); - -deleteAllForUser: -DELETE FROM deleted_idea WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedProject.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedProject.sq index d8117a09b..36d1ba8a3 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedProject.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/DeletedProject.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- uuid is declared TEXT for SqlDelight's parser; promoted to UUID at runtime -- by PostgresSchemaInitializer (matches project.uuid). Callers cast bound @@ -28,6 +28,3 @@ WHERE user_id = :userId AND uuid = CAST(:uuid AS UUID); hasDeletedProject: SELECT EXISTS(SELECT 1 FROM deleted_project WHERE user_id = :userId AND uuid = CAST(:uuid AS UUID)); - -deleteAllForUser: -DELETE FROM deleted_project WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ErrorLog.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ErrorLog.sq index 9263501b6..ebadac557 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ErrorLog.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ErrorLog.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Deduplicated server-side errors. Rather than a row per occurrence, errors are -- grouped by `fingerprint` (a hash of exception type + route, optionally + user) @@ -67,6 +67,3 @@ UPDATE error_log SET notified_at = ? WHERE id = ?; deleteErrorsBefore: DELETE FROM error_log WHERE last_seen < ?; - -deleteAllForUser: -DELETE FROM error_log WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/LoginAttempt.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/LoginAttempt.sq index a754fa4fb..16c77f601 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/LoginAttempt.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/LoginAttempt.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Raw login attempts, used for brute-force visibility on the Security page. -- `email` is stored lower-cased by the repository for stable counting; it may @@ -59,7 +59,3 @@ HAVING count(*) >= ? OR count(DISTINCT email) >= ?; deleteAttemptsBefore: DELETE FROM login_attempt WHERE attempted_at < ?; - --- email is stored lower-cased by the repository; callers must lower-case the parameter. -deleteAllForEmail: -DELETE FROM login_attempt WHERE email = :email; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PasswordResetToken.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PasswordResetToken.sq index 3fffc9d43..0af2e1edb 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PasswordResetToken.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PasswordResetToken.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; CREATE TABLE password_reset_token( id BIGSERIAL PRIMARY KEY, @@ -32,6 +32,3 @@ getRecentTokenCount: SELECT COUNT(*) FROM password_reset_token WHERE user_id = ? AND created > ?; - -deleteAllForUser: -DELETE FROM password_reset_token WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Project.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Project.sq index 26be961d5..aa7948bbb 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Project.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/Project.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- uuid is declared TEXT for SqlDelight's parser; PostgresSchemaInitializer -- ALTERs it to UUID at runtime for 16-byte storage and validation. The @@ -95,6 +95,3 @@ WHERE id = :id; deleteProject: DELETE FROM project WHERE user_id = :userId AND uuid = CAST(:uuid AS UUID); - -deleteAllForUser: -DELETE FROM project WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccess.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccess.sq index de674ffa9..a11435bc8 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccess.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccess.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; CREATE TABLE project_access ( id BIGSERIAL PRIMARY KEY, @@ -38,24 +38,6 @@ insertAccess: INSERT INTO project_access(project_id, access_password, expires_at) VALUES (?, ?, ?); -insertAccessReturningId: -INSERT INTO project_access(project_id, access_password, expires_at) -VALUES (?, ?, ?) -RETURNING id; - --- Serializes share creation per project: taken inside the insert transaction so --- two concurrent creates cannot both pass the duplicate-password check. -lockProjectRow: -SELECT id FROM project WHERE id = :projectId FOR UPDATE; - -findLiveAccessByPassword: -SELECT id -FROM project_access -WHERE project_id = :projectId - AND access_password = :password - AND (expires_at IS NULL OR expires_at > :now) -LIMIT 1; - -- The SQLite `INSERT OR REPLACE` here had no UNIQUE other than PK (id auto-incr) -- so it was effectively a plain INSERT in practice; preserve that semantics. updateAccess: @@ -113,27 +95,19 @@ INNER JOIN project_access ON project.id = project_access.project_id WHERE project.uuid = CAST(:projectUuid AS UUID) AND project_access.access_password IS NULL; --- Rows predating the create-time duplicate check may share a password; --- ORDER BY id LIMIT 1 keeps the oldest one winning instead of a crash. Expired --- rows are skipped so they can never shadow a live share. Expiry compares --- against a caller-supplied :now so create and read share one clock. findProjectByPenNameProjectNameAndPassword: SELECT project.uuid AS project_uuid, project.user_id, project.name AS project_name, account.pen_name, - project_access.expires_at, - project_access.id AS access_id + project_access.expires_at FROM project INNER JOIN account ON project.user_id = account.id INNER JOIN project_access ON project.id = project_access.project_id WHERE account.pen_name = CAST(:penName AS CITEXT) AND project.name = CAST(:projectName AS CITEXT) - AND project_access.access_password = :password - AND (project_access.expires_at IS NULL OR project_access.expires_at > :now) -ORDER BY project_access.id -LIMIT 1; + AND project_access.access_password = :password; hasAnyAccessForProject: SELECT EXISTS( diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccessScene.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccessScene.sq deleted file mode 100644 index 565474f94..000000000 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectAccessScene.sq +++ /dev/null @@ -1,39 +0,0 @@ -CREATE TABLE project_access_scene ( - access_id BIGINT NOT NULL, - scene_id INTEGER NOT NULL, - PRIMARY KEY (access_id, scene_id), - FOREIGN KEY(access_id) REFERENCES project_access(id) ON DELETE CASCADE -); - -insertScene: -INSERT INTO project_access_scene(access_id, scene_id) -VALUES (?, ?); - -getSceneIdsForAccess: -SELECT scene_id -FROM project_access_scene -WHERE access_id = :accessId; - -getSceneIdsForAccessIds: -SELECT access_id, scene_id -FROM project_access_scene -WHERE access_id IN :accessIds; - -deleteForAccess: -DELETE FROM project_access_scene -WHERE access_id = :accessId; - -deleteForProject: -DELETE FROM project_access_scene -WHERE access_id IN ( - SELECT id FROM project_access WHERE project_id = :projectId -); - -deleteAllForUser: -DELETE FROM project_access_scene -WHERE access_id IN ( - SELECT project_access.id - FROM project_access - INNER JOIN project ON project_access.project_id = project.id - WHERE project.user_id = :userId -); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectData.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectData.sq index c31bb7597..a39d3f429 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectData.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ProjectData.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- updated_at was a Unix-seconds INTEGER in SQLite; promoted to TIMESTAMPTZ here. -- The migrator converts INTEGER seconds → Instant during the data copy. @@ -20,12 +20,6 @@ SELECT content, hash, updated_at FROM project_data WHERE user_id = :userId AND project_id = :projectId; --- Hash-only lookup for HTTP validators: no content transfer, no JSON parse. -getHashForProject: -SELECT hash -FROM project_data -WHERE user_id = :userId AND project_id = :projectId; - upsert: INSERT INTO project_data(user_id, project_id, content, hash, updated_at) VALUES (:userId, :projectId, :content, :hash, :updatedAt) @@ -33,6 +27,3 @@ ON CONFLICT (user_id, project_id) DO UPDATE SET content = EXCLUDED.content, hash = EXCLUDED.hash, updated_at = EXCLUDED.updated_at; - -deleteAllForUser: -DELETE FROM project_data WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PublishedStoryReader.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PublishedStoryReader.sq index da0e312a2..d379299f3 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PublishedStoryReader.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/PublishedStoryReader.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Deduplicated record of anonymous reads of published / privately-shared stories, -- backing the best-effort "unique readers" counter. There is no reader account, so @@ -76,11 +76,3 @@ ON CONFLICT (project_id) DO UPDATE SET total = published_story_reader_total.tota deleteReadersBefore: DELETE FROM published_story_reader WHERE day_bucket < ?; - -deleteAllForUser: -DELETE FROM published_story_reader -WHERE project_id IN (SELECT id FROM project WHERE user_id = :userId); - -deleteAllTotalsForUser: -DELETE FROM published_story_reader_total -WHERE project_id IN (SELECT id FROM project WHERE user_id = :userId); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewRequest.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewRequest.sq index d41f40b2d..77ffeab55 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewRequest.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewRequest.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; CREATE TABLE review_request( id BIGSERIAL PRIMARY KEY, @@ -25,13 +25,8 @@ createRequest: INSERT INTO review_request(user_id, project_id, token, reviewer_email, label, note, status, expires) VALUES (:userId, :projectId, :token, :reviewerEmail, :label, :note, :status, :expires); --- Excludes requests whose author is soft-deleted, so every tokenized reviewer --- path stops serving a deleted account's prose immediately; the links come --- back if the account is restored. getRequestByToken: -SELECT * FROM review_request -WHERE token = :token - AND user_id IN (SELECT id FROM account WHERE deleted_at IS NULL); +SELECT * FROM review_request WHERE token = :token; getRequest: SELECT * FROM review_request WHERE id = :id AND user_id = :userId; @@ -67,6 +62,3 @@ WHERE id = :id AND status IN :allowed; markResolved: UPDATE review_request SET status = :status, resolved_at = :at WHERE id = :id AND status = :expected; - -deleteAllForUser: -DELETE FROM review_request WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewScene.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewScene.sq index 0488488e5..89b0be290 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewScene.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewScene.sq @@ -67,7 +67,3 @@ SELECT review_request_id, FROM review_scene WHERE review_request_id IN :reviewRequestIds GROUP BY review_request_id; - -deleteAllForUser: -DELETE FROM review_scene -WHERE review_request_id IN (SELECT id FROM review_request WHERE user_id = :userId); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewSuggestion.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewSuggestion.sq index d2717420c..b55d7419c 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewSuggestion.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ReviewSuggestion.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; CREATE TABLE review_suggestion( id BIGSERIAL PRIMARY KEY, @@ -52,11 +52,3 @@ countSuggestionsForRequest: SELECT COUNT(*) FROM review_suggestion JOIN review_scene ON review_suggestion.review_scene_id = review_scene.id WHERE review_scene.review_request_id = :reviewRequestId; - -deleteAllForUser: -DELETE FROM review_suggestion -WHERE review_scene_id IN ( - SELECT rs.id FROM review_scene rs - JOIN review_request rr ON rr.id = rs.review_request_id - WHERE rr.user_id = :userId -); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ServerConfig.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ServerConfig.sq index 5c302244b..8613c1c3e 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ServerConfig.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/ServerConfig.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- updated_at was a Unix-seconds INTEGER in SQLite; promoted to TIMESTAMPTZ here. CREATE TABLE server_config ( diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryEntity.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryEntity.sq index 695988623..92262ae3d 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryEntity.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryEntity.sq @@ -134,6 +134,3 @@ WHERE user_id = :userId AND project_id = :projectId AND id = :id; deleteAllForProject: DELETE FROM story_entity WHERE user_id = :userId AND project_id = :projectId; - -deleteAllForUser: -DELETE FROM story_entity WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryIdea.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryIdea.sq index 86df58046..523bdf2b6 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryIdea.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryIdea.sq @@ -48,9 +48,6 @@ deleteIdea: DELETE FROM story_idea WHERE user_id = :userId AND uuid = CAST(:uuid AS UUID); -deleteAllForUser: -DELETE FROM story_idea WHERE user_id = :userId; - countEncrypted: SELECT COUNT(*) FROM story_idea WHERE cipher IS NOT NULL AND cipher != 'none'; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryKudos.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryKudos.sq deleted file mode 100644 index b48463db2..000000000 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/StoryKudos.sq +++ /dev/null @@ -1,72 +0,0 @@ -import kotlin.time.Instant; - --- Kudos readers leave on a publicly published story: one row per (story, reader, chip). --- The giver's id is only for dedup, editing picks, and purge; authors see aggregate --- counts, never who gave what. `kind` is a stable key from the KudosKind enum. -CREATE TABLE story_kudos ( - project_id BIGINT NOT NULL, - user_id BIGINT NOT NULL, - kind TEXT NOT NULL, - created_at TIMESTAMPTZ AS Instant NOT NULL DEFAULT NOW(), - CONSTRAINT story_kudos_kind_len CHECK (length(kind) BETWEEN 1 AND 32), - FOREIGN KEY(project_id) REFERENCES project(id) ON DELETE CASCADE, - FOREIGN KEY(user_id) REFERENCES account(id) ON DELETE CASCADE, - PRIMARY KEY (project_id, user_id, kind) -); - -CREATE INDEX story_kudos_user_idx ON story_kudos (user_id); - --- A row here means the author turned kudos off for the story. -CREATE TABLE story_kudos_opt_out ( - project_id BIGINT NOT NULL PRIMARY KEY, - FOREIGN KEY(project_id) REFERENCES project(id) ON DELETE CASCADE -); - -kindsForUser: -SELECT kind FROM story_kudos -WHERE project_id = :projectId AND user_id = :userId; - -insertKudos: -INSERT INTO story_kudos(project_id, user_id, kind) -VALUES (:projectId, :userId, :kind) -ON CONFLICT (project_id, user_id, kind) DO NOTHING; - -deleteKinds: -DELETE FROM story_kudos -WHERE project_id = :projectId AND user_id = :userId AND kind IN :kinds; - --- Soft-deleted givers are left out until the purge removes their rows. `kinds` is the --- current chip set, so rows for retired chips never count. -countsForProject: -SELECT k.kind, count(*) AS givers -FROM story_kudos k -JOIN account a ON a.id = k.user_id -WHERE k.project_id = :projectId AND a.deleted_at IS NULL AND k.kind IN :kinds -GROUP BY k.kind; - -giverCountForProject: -SELECT count(DISTINCT k.user_id) -FROM story_kudos k -JOIN account a ON a.id = k.user_id -WHERE k.project_id = :projectId AND a.deleted_at IS NULL AND k.kind IN :kinds; - -isOptedOut: -SELECT EXISTS(SELECT 1 FROM story_kudos_opt_out WHERE project_id = :projectId); - -optOut: -INSERT INTO story_kudos_opt_out(project_id) VALUES (:projectId) -ON CONFLICT (project_id) DO NOTHING; - -optIn: -DELETE FROM story_kudos_opt_out WHERE project_id = :projectId; - -deleteAllGivenByUser: -DELETE FROM story_kudos WHERE user_id = :userId; - -deleteAllOnUserProjects: -DELETE FROM story_kudos -WHERE project_id IN (SELECT id FROM project WHERE user_id = :userId); - -deleteAllOptOutsForUser: -DELETE FROM story_kudos_opt_out -WHERE project_id IN (SELECT id FROM project WHERE user_id = :userId); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/UserActivity.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/UserActivity.sq index 48cb35dd0..01237c9a0 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/UserActivity.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/UserActivity.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- Deduplicated record of which logged-in users were active, used for the -- "Active Users" dashboard metric. One row per (user, activity type, hour) so @@ -36,6 +36,3 @@ WHERE hour_bucket >= ?; deleteActivityBefore: DELETE FROM user_activity WHERE hour_bucket < ?; - -deleteAllForUser: -DELETE FROM user_activity WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WhiteList.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WhiteList.sq index 3bef47e01..046ebe866 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WhiteList.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WhiteList.sq @@ -1,4 +1,4 @@ -import kotlin.time.Instant; +import kotlinx.datetime.Instant; -- date_added was Unix-seconds INTEGER in SQLite; promoted to TIMESTAMPTZ here. -- email is declared TEXT for SqlDelight's parser; PostgresSchemaPostInit @@ -35,15 +35,6 @@ ON CONFLICT (email) DO UPDATE SET reason = EXCLUDED.reason, expires = EXCLUDED.expires; --- DO NOTHING rather than addToWhiteList's upsert: existing entries (Patreon, --- expiring invites) must keep their reason and expiry. -backfillFromAccounts: -INSERT INTO white_list(email, date_added, reason, expires) -SELECT a.email, ?, ?, NULL -FROM account a -WHERE a.deleted_at IS NULL -ON CONFLICT (email) DO NOTHING; - removeFromWhiteList: DELETE FROM white_list WHERE email = CAST(? AS CITEXT); @@ -52,59 +43,33 @@ getAll: SELECT * FROM white_list ORDER BY email ASC; --- Every paginated query breaks ties on email. backfillFromAccounts stamps all the rows --- it migrates with one timestamp, so date_added alone leaves LIMIT/OFFSET free to repeat --- and skip entries across pages. getPaginated: SELECT * FROM white_list -ORDER BY date_added DESC, email ASC +ORDER BY date_added DESC LIMIT ? OFFSET ?; getPaginatedOldestFirst: SELECT * FROM white_list -ORDER BY date_added ASC, email ASC +ORDER BY date_added ASC LIMIT ? OFFSET ?; getPaginatedWithAccountStatus: SELECT w.*, (a.email IS NOT NULL) AS has_account FROM white_list w LEFT JOIN account a ON w.email = a.email -ORDER BY w.date_added DESC, w.email ASC +ORDER BY w.date_added DESC LIMIT ? OFFSET ?; getPaginatedWithAccountStatusOldestFirst: SELECT w.*, (a.email IS NOT NULL) AS has_account FROM white_list w LEFT JOIN account a ON w.email = a.email -ORDER BY w.date_added ASC, w.email ASC -LIMIT ? OFFSET ?; - --- Admin email search. A wildcard match can't ride the citext equality operator, so both --- sides are narrowed to text and matched with ILIKE, which is unambiguously --- case-insensitive. The repository escapes % and _ in the admin's input before binding. -searchPaginatedWithAccountStatus: -SELECT w.*, (a.email IS NOT NULL) AS has_account -FROM white_list w -LEFT JOIN account a ON w.email = a.email -WHERE CAST(w.email AS TEXT) ILIKE ? -ORDER BY w.date_added DESC, w.email ASC -LIMIT ? OFFSET ?; - -searchPaginatedWithAccountStatusOldestFirst: -SELECT w.*, (a.email IS NOT NULL) AS has_account -FROM white_list w -LEFT JOIN account a ON w.email = a.email -WHERE CAST(w.email AS TEXT) ILIKE ? -ORDER BY w.date_added ASC, w.email ASC +ORDER BY w.date_added ASC LIMIT ? OFFSET ?; getCount: SELECT count(*) FROM white_list; -searchCount: -SELECT count(*) FROM white_list -WHERE CAST(email AS TEXT) ILIKE ?; - getByEmail: SELECT * FROM white_list WHERE email = CAST(? AS CITEXT); diff --git a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WritingActivity.sq b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WritingActivity.sq index 04456d1bd..f28c10918 100644 --- a/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WritingActivity.sq +++ b/server/src/main/sqldelight/com/darkrockstudios/apps/hammer/WritingActivity.sq @@ -20,6 +20,3 @@ INSERT INTO writing_activity(user_id, project_id, device_id, content) VALUES (:userId, :projectId, :deviceId, :content) ON CONFLICT (user_id, project_id, device_id) DO UPDATE SET content = EXCLUDED.content; - -deleteAllForUser: -DELETE FROM writing_activity WHERE user_id = :userId; diff --git a/server/src/main/sqldelight/migrations/7.sqm b/server/src/main/sqldelight/migrations/7.sqm deleted file mode 100644 index e4fa85fd4..000000000 --- a/server/src/main/sqldelight/migrations/7.sqm +++ /dev/null @@ -1,10 +0,0 @@ --- Migration 7 -> 8: soft-delete timestamp for the account-deletion retention --- window. Mirrors Account.sq for already-deployed v7 databases; fresh installs --- get this from Schema.create. --- --- The column is nullable with no default, so every existing row reads as NULL: --- not deleted, preserving current behaviour. - -ALTER TABLE account ADD COLUMN deleted_at TIMESTAMPTZ; - -CREATE INDEX account_deleted_at_idx ON account (deleted_at) WHERE deleted_at IS NOT NULL; diff --git a/server/src/main/sqldelight/migrations/8.sqm b/server/src/main/sqldelight/migrations/8.sqm deleted file mode 100644 index db0575415..000000000 --- a/server/src/main/sqldelight/migrations/8.sqm +++ /dev/null @@ -1,13 +0,0 @@ --- Migration 8 -> 9: per-share scene restriction for private shares. Mirrors --- ProjectAccessScene.sq for already-deployed v8 databases; fresh installs get --- this from Schema.create. --- --- No rows for an access id means the share exposes the entire story, so every --- existing share keeps its current behaviour. - -CREATE TABLE project_access_scene ( - access_id BIGINT NOT NULL, - scene_id INTEGER NOT NULL, - PRIMARY KEY (access_id, scene_id), - FOREIGN KEY(access_id) REFERENCES project_access(id) ON DELETE CASCADE -); diff --git a/server/src/main/sqldelight/migrations/9.sqm b/server/src/main/sqldelight/migrations/9.sqm deleted file mode 100644 index e990551c6..000000000 --- a/server/src/main/sqldelight/migrations/9.sqm +++ /dev/null @@ -1,20 +0,0 @@ --- Migration 9 -> 10: story kudos. Mirrors StoryKudos.sq for already-deployed --- databases; fresh installs get this from Schema.create. - -CREATE TABLE story_kudos ( - project_id BIGINT NOT NULL, - user_id BIGINT NOT NULL, - kind TEXT NOT NULL, - created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), - CONSTRAINT story_kudos_kind_len CHECK (length(kind) BETWEEN 1 AND 32), - FOREIGN KEY(project_id) REFERENCES project(id) ON DELETE CASCADE, - FOREIGN KEY(user_id) REFERENCES account(id) ON DELETE CASCADE, - PRIMARY KEY (project_id, user_id, kind) -); - -CREATE INDEX story_kudos_user_idx ON story_kudos (user_id); - -CREATE TABLE story_kudos_opt_out ( - project_id BIGINT NOT NULL PRIMARY KEY, - FOREIGN KEY(project_id) REFERENCES project(id) ON DELETE CASCADE -); diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ApplicationTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ApplicationTest.kt index e90f1ae07..b2eedfe1b 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ApplicationTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ApplicationTest.kt @@ -99,8 +99,6 @@ class ApplicationTest : BaseTest() { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } single { mockk() } } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ServerConfigTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ServerConfigTest.kt index c8aa6190b..1ebdc959d 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ServerConfigTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/ServerConfigTest.kt @@ -30,16 +30,6 @@ class ServerConfigTest { assertEquals(listOf("127.0.0.1", "::1"), config.bindHosts) } - @Test - fun `timezone defaults to null`() { - assertEquals(null, parse("").timezone) - } - - @Test - fun `timezone parses a zone ID`() { - assertEquals("Europe/Paris", parse("""timezone = "Europe/Paris"""").timezone) - } - @Test fun `termsOfService defaults to null`() { assertEquals(null, parse("").termsOfService) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJobTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJobTest.kt deleted file mode 100644 index 1bac92406..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionJobTest.kt +++ /dev/null @@ -1,80 +0,0 @@ -package com.darkrockstudios.apps.hammer.account - -import com.darkrockstudios.apps.hammer.AccountDeletionConfig -import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.utils.TestClock -import com.darkrockstudios.apps.hammer.utils.testAccount -import io.mockk.MockKAnnotations -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.impl.annotations.MockK -import io.mockk.slot -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.slf4j.LoggerFactory -import kotlin.test.assertEquals -import kotlin.time.Clock -import kotlin.time.Duration.Companion.days -import kotlin.time.Instant - -class AccountDeletionJobTest { - - @MockK - private lateinit var accountDeletionService: AccountDeletionService - - private lateinit var clock: TestClock - private val logger = LoggerFactory.getLogger(AccountDeletionJobTest::class.java) - - @BeforeEach - fun setup() { - MockKAnnotations.init(this, relaxUnitFun = true) - clock = TestClock(Clock.System) - } - - private fun createJob(retentionDays: Int = 30) = AccountDeletionJob( - accountDeletionService = accountDeletionService, - serverConfig = ServerConfig(accountDeletion = AccountDeletionConfig(retentionDays = retentionDays)), - clock = clock, - logger = logger, - ) - - @Test - fun `tick - hard-deletes every account past the retention window`() = runTest { - val cutoff = slot() - val due = listOf( - testAccount(userId = 1, deletedAt = clock.now() - 40.days), - testAccount(userId = 2, deletedAt = clock.now() - 31.days), - ) - coEvery { accountDeletionService.findAccountsPastRetention(capture(cutoff)) } returns due - - createJob(retentionDays = 30).tick() - - assertEquals(clock.now() - 30.days, cutoff.captured) - coVerify { accountDeletionService.hardDelete(1) } - coVerify { accountDeletionService.hardDelete(2) } - } - - @Test - fun `tick - one failing account does not starve the rest`() = runTest { - val due = listOf( - testAccount(userId = 1, deletedAt = clock.now() - 40.days), - testAccount(userId = 2, deletedAt = clock.now() - 31.days), - ) - coEvery { accountDeletionService.findAccountsPastRetention(any()) } returns due - coEvery { accountDeletionService.hardDelete(1) } throws IllegalStateException("boom") - - createJob().tick() - - coVerify { accountDeletionService.hardDelete(2) } - } - - @Test - fun `tick - nothing due is a no-op`() = runTest { - coEvery { accountDeletionService.findAccountsPastRetention(any()) } returns emptyList() - - createJob().tick() - - coVerify(exactly = 0) { accountDeletionService.hardDelete(any()) } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionServiceTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionServiceTest.kt deleted file mode 100644 index 7f00deca8..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountDeletionServiceTest.kt +++ /dev/null @@ -1,210 +0,0 @@ -package com.darkrockstudios.apps.hammer.account - -import com.darkrockstudios.apps.hammer.Account -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository -import com.darkrockstudios.apps.hammer.database.UserDataPurgeDao -import com.darkrockstudios.apps.hammer.project.ProjectSyncKey -import com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession -import com.darkrockstudios.apps.hammer.projects.ProjectsSynchronizationSession -import com.darkrockstudios.apps.hammer.syncsessionmanager.SyncSessionManager -import com.darkrockstudios.apps.hammer.utilities.isSuccess -import com.darkrockstudios.apps.hammer.utils.TestClock -import io.mockk.MockKAnnotations -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.coVerifyOrder -import io.mockk.every -import io.mockk.impl.annotations.MockK -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.time.Clock -import kotlin.time.Duration.Companion.days - -class AccountDeletionServiceTest { - - @MockK - private lateinit var accountsRepository: AccountsRepository - - @MockK - private lateinit var penNameService: PenNameService - - @MockK - private lateinit var whiteListRepository: WhiteListRepository - - @MockK - private lateinit var userDataPurgeDao: UserDataPurgeDao - - @MockK - private lateinit var projectsSyncManager: SyncSessionManager - - @MockK - private lateinit var projectSyncManager: SyncSessionManager - - private lateinit var clock: TestClock - private lateinit var service: AccountDeletionService - - private val userId = 1L - private val email = "writer@example.com" - - private fun account( - isAdmin: Boolean = false, - deletedAt: kotlin.time.Instant? = null, - ) = Account( - id = userId, - email = email, - pen_name = "Ada Lovelace", - password_hash = "hash", - cipher_secret = "secret", - created = Clock.System.now() - 128.days, - is_admin = isAdmin, - last_sync = Clock.System.now(), - bio = null, - email_verified = true, - community_member = true, - deleted_at = deletedAt, - ) - - @BeforeEach - fun setup() { - MockKAnnotations.init(this, relaxUnitFun = true) - clock = TestClock(Clock.System) - service = AccountDeletionService( - accountsRepository = accountsRepository, - penNameService = penNameService, - whiteListRepository = whiteListRepository, - userDataPurgeDao = userDataPurgeDao, - projectsSyncManager = projectsSyncManager, - projectSyncManager = projectSyncManager, - clock = clock, - ) - - coEvery { accountsRepository.forceLogout(any()) } returns true - every { projectsSyncManager.terminateSession(any()) } returns true - } - - @Test - fun `softDelete - locks the account out then releases its public presence`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account() andThen account(deletedAt = clock.now()) - - val result = service.softDelete(userId) - - assertTrue(isSuccess(result)) - coVerifyOrder { - accountsRepository.markDeleted(userId, clock.now()) - accountsRepository.forceLogout(email) - projectsSyncManager.terminateSession(userId) - projectSyncManager.terminateSessions(any()) - penNameService.releasePenName(userId) - accountsRepository.updateCommunityMember(userId, false) - } - } - - @Test - fun `softDelete - missing account fails`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns null - - val result = service.softDelete(userId) - - assertTrue(result.isFailure) - coVerify(exactly = 0) { accountsRepository.markDeleted(any(), any()) } - } - - @Test - fun `softDelete - retry on an already-deleted account re-runs the idempotent cleanup`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account(deletedAt = clock.now() - 1.days) - - val result = service.softDelete(userId) - - assertTrue(isSuccess(result)) - coVerify { penNameService.releasePenName(userId) } - coVerify { accountsRepository.forceLogout(email) } - } - - @Test - fun `softDelete - aborts before destructive steps when the flag did not land`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account() andThen account(deletedAt = null) - - val result = service.softDelete(userId) - - assertTrue(result.isFailure) - coVerify(exactly = 0) { accountsRepository.forceLogout(any()) } - coVerify(exactly = 0) { penNameService.releasePenName(any()) } - } - - @Test - fun `softDelete - admin accounts can never be deleted`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns account(isAdmin = true) - - val result = service.softDelete(userId) - - assertTrue(result.isFailure) - coVerify(exactly = 0) { accountsRepository.markDeleted(any(), any()) } - coVerify(exactly = 0) { penNameService.releasePenName(any()) } - } - - @Test - fun `restore - un-flags an existing account`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account(deletedAt = clock.now() - 1.days) - - assertTrue(service.restore(userId)) - coVerify { accountsRepository.restoreDeleted(userId) } - } - - @Test - fun `restore - missing account returns false`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns null - - assertFalse(service.restore(userId)) - coVerify(exactly = 0) { accountsRepository.restoreDeleted(any()) } - } - - @Test - fun `hardDelete - purges user data and removes the whitelist entry`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account(deletedAt = clock.now() - 31.days) - coEvery { userDataPurgeDao.purgeUserData(userId) } returns true - - service.hardDelete(userId) - - coVerify { userDataPurgeDao.purgeUserData(userId) } - coVerify { whiteListRepository.removeFromWhiteList(email) } - } - - @Test - fun `hardDelete - missing account is a no-op`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns null - - service.hardDelete(userId) - - coVerify(exactly = 0) { userDataPurgeDao.purgeUserData(any()) } - coVerify(exactly = 0) { whiteListRepository.removeFromWhiteList(any()) } - } - - @Test - fun `hardDelete - account restored since the job snapshot is left alone`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns account(deletedAt = null) - - service.hardDelete(userId) - - coVerify(exactly = 0) { userDataPurgeDao.purgeUserData(any()) } - coVerify(exactly = 0) { whiteListRepository.removeFromWhiteList(any()) } - } - - @Test - fun `hardDelete - whitelist entry kept when the purge transaction refuses`() = runTest { - coEvery { accountsRepository.getAccountOrNull(userId) } returns - account(deletedAt = clock.now() - 31.days) - coEvery { userDataPurgeDao.purgeUserData(userId) } returns false - - service.hardDelete(userId) - - coVerify(exactly = 0) { whiteListRepository.removeFromWhiteList(any()) } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutesTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutesTest.kt index 6b47398f4..062717def 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutesTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountRoutesTest.kt @@ -26,10 +26,8 @@ import com.darkrockstudios.apps.hammer.utilities.MarkdownService import com.darkrockstudios.apps.hammer.utilities.SResult import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import com.darkrockstudios.apps.hammer.utils.testAccount import io.ktor.client.plugins.contentnegotiation.ContentNegotiation import io.ktor.client.request.forms.FormDataContent -import io.ktor.client.request.get import io.ktor.client.request.header import io.ktor.client.request.post import io.ktor.client.request.setBody @@ -136,8 +134,6 @@ class AccountRoutesTest : BaseTest() { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } } } @@ -145,7 +141,7 @@ class AccountRoutesTest : BaseTest() { fun `Account - Refresh Token - No User`() = testApplication { coEvery { accountsComponent.refreshToken(USER_ID, any(), any()) - } returns SResult.failure("No valid token not found", null) + } returns SResult.failure("No valid token not found", mockk()) val mockRefreshToken = "invalid_refresh_token" application { @@ -169,36 +165,6 @@ class AccountRoutesTest : BaseTest() { } } - @Test - fun `Account - Refresh Token - pending-deletion message reaches the client`() = testApplication { - coEvery { - accountsComponent.refreshToken(USER_ID, any(), any()) - } returns SResult.failure( - "Account pending deletion", - com.darkrockstudios.apps.hammer.utilities.Msg.r("api_accounts_login_error_pending_deletion") - ) - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - createClient { - install(ContentNegotiation) { - json(json) - } - } - - makeRefreshCall(USER_ID, "any-refresh-token").apply { - assertEquals(HttpStatusCode.Unauthorized, status) - assertTrue(bodyAsText().contains("pending deletion")) - } - } - @Test fun `Account - Refresh Token`() = testApplication { val mockRefreshToken = "valid_refresh_token" @@ -300,163 +266,6 @@ class AccountRoutesTest : BaseTest() { } } - // The soft-deleted gate lives in the token query itself (AuthToken.sq hides - // tokens of deleted accounts), so at the route level a deleted account is a - // failed checkToken; the data-layer behavior is covered in AccountDaoSoftDeleteTest. - @Test - fun `Account - Test Auth - invisible token is rejected at the bearer gate`() = testApplication { - coEvery { accountsRepository.checkToken(USER_ID, "bearer-token") } returns - SResult.failure("No valid token found", null) - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makeTestAuthCall(USER_ID).apply { - assertEquals(HttpStatusCode.Unauthorized, status) - } - } - - @Test - fun `Account - Test Auth - active account passes the bearer gate`() = testApplication { - coEvery { accountsRepository.checkToken(USER_ID, "bearer-token") } returns SResult.success(USER_ID) - coEvery { accountsRepository.getAccountOrNull(USER_ID) } returns testAccount() - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makeTestAuthCall(USER_ID).apply { - assertTrue(status.isSuccess()) - } - } - - private fun stubActiveBearer() { - coEvery { accountsRepository.checkToken(USER_ID, "bearer-token") } returns SResult.success(USER_ID) - coEvery { accountsRepository.getAccountOrNull(USER_ID) } returns testAccount() - coEvery { accountsRepository.getInstallId("bearer-token") } returns INSTALL_ID - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true - } - - @Test - fun `Account - Pair Install - mints a token for the new install`() = testApplication { - stubActiveBearer() - val watchToken = Token(userId = USER_ID, auth = "watch-access", refresh = "watch-refresh") - coEvery { accountsComponent.pairInstall(USER_ID, INSTALL_ID, "watch-install") } returns - SResult.success(watchToken) - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makePairCall(USER_ID, "watch-install").apply { - assertEquals(HttpStatusCode.Created, status) - val body = json.decodeFromString(bodyAsText()) - assertEquals(watchToken, body) - } - } - - @Test - fun `Account - Pair Install - the caller's own install is a bad request`() = testApplication { - stubActiveBearer() - coEvery { accountsComponent.pairInstall(USER_ID, INSTALL_ID, INSTALL_ID) } returns - SResult.failure( - "Same install id", - com.darkrockstudios.apps.hammer.utilities.Msg.r("api_accounts_pair_error_sameinstall"), - InvalidInstallId("Install id matches the caller"), - ) - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makePairCall(USER_ID, INSTALL_ID).apply { - assertEquals(HttpStatusCode.BadRequest, status) - } - } - - @Test - fun `Account - Pair Install - missing install id is a bad request`() = testApplication { - stubActiveBearer() - - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makePairCall(USER_ID, installId = null).apply { - assertEquals(HttpStatusCode.BadRequest, status) - } - } - - @Test - fun `Account - Pair Install - requires a bearer token`() = testApplication { - application { - setupKtorTestKoin(this@AccountRoutesTest, testModule) - - configureSerialization() - configureLocalization() - configureSecurity() - configureRouting() - } - - makePairCall(USER_ID, "watch-install", bearer = null).apply { - assertEquals(HttpStatusCode.Unauthorized, status) - } - } - - private suspend fun ApplicationTestBuilder.makePairCall( - userId: Long, - installId: String?, - bearer: String? = "bearer-token", - ): HttpResponse = - client.post("/api/account/pair_install/$userId") { - bearer?.let { header(HttpHeaders.Authorization, "Bearer $it") } - header(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION) - header(HEADER_CLIENT_VERSION, BuildMetadata.APP_VERSION) - header(HttpHeaders.Accept, ContentType.Application.Json.toString()) - setBody( - FormDataContent( - Parameters.build { - installId?.let { append("installId", it) } - } - ) - ) - } - - private suspend fun ApplicationTestBuilder.makeTestAuthCall(userId: Long): HttpResponse = - client.get("/api/account/test_auth/$userId") { - header(HttpHeaders.Authorization, "Bearer bearer-token") - header(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION) - header(HEADER_CLIENT_VERSION, BuildMetadata.APP_VERSION) - header(HttpHeaders.Accept, ContentType.Application.Json.toString()) - } - private suspend fun ApplicationTestBuilder.makeCreateCall(acceptedTosVersion: String?): HttpResponse = client.post("/api/account/create") { header(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentCreateAccountTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentCreateAccountTest.kt index ed5ec97b1..b9aa9ab45 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentCreateAccountTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentCreateAccountTest.kt @@ -7,7 +7,6 @@ import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge import com.darkrockstudios.apps.hammer.base.http.Token import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.utilities.SResult -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry import io.mockk.MockKAnnotations import io.mockk.coEvery import io.mockk.coVerify @@ -52,8 +51,9 @@ class AccountsComponentCreateAccountTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) @BeforeEach @@ -66,6 +66,7 @@ class AccountsComponentCreateAccountTest { fun `Create Account - First User, skip whitelist`() = runTest { coEvery { accountsRepository.hasUsers() } returns false coEvery { accountsRepository.findAccount(any()) } returns null + coEvery { whiteListRepository.useWhiteList() } returns true coEvery { accountsRepository.createAccount( email = validEmail, @@ -83,16 +84,17 @@ class AccountsComponentCreateAccountTest { assertTrue(result is CreateAccountResult.Success) assertEquals(token, result.token) + coVerify(exactly = 0) { whiteListRepository.useWhiteList() } coVerify(exactly = 0) { whiteListRepository.isOnWhiteList(any()) } coVerify { projectsRepository.createUserData(token.userId) } } @Test - fun `Create Account - Success - Is On Allowed List`() = runTest { + fun `Create Account - Success`() = runTest { coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { accountsRepository.createAccount( email = validEmail, @@ -114,9 +116,10 @@ class AccountsComponentCreateAccountTest { } @Test - fun `Create Account - Failure - Not On Allowed List`() = runTest { + fun `Create Account - Failure - Not On Whitelist`() = runTest { coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null + coEvery { whiteListRepository.useWhiteList() } returns true coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns false coEvery { accountsRepository.createAccount( @@ -138,12 +141,37 @@ class AccountsComponentCreateAccountTest { coVerify(exactly = 0) { projectsRepository.createUserData(any()) } } + @Test + fun `Create Account - Success - Is On Whitelist`() = runTest { + coEvery { accountsRepository.hasUsers() } returns true + coEvery { accountsRepository.findAccount(any()) } returns null + coEvery { whiteListRepository.useWhiteList() } returns true + coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { + accountsRepository.createAccount( + email = validEmail, + installId = installId, + password = validPassword + ) + } returns SResult.success(token) + + val result = component().createAccount( + email = validEmail, + installId = installId, + password = validPassword, + ) + + assertTrue(result is CreateAccountResult.Success) + assertEquals(token, result.token) + coVerify { projectsRepository.createUserData(token.userId) } + } + @Test fun `Create Account - TOS enforced, no acceptance - challenges`() = runTest { val challenge = TermsOfServiceChallenge(text = "Be excellent to each other", version = "v1") coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false every { termsOfServiceRepository.challenge() } returns challenge val result = component().createAccount( @@ -164,7 +192,7 @@ class AccountsComponentCreateAccountTest { val challenge = TermsOfServiceChallenge(text = "Be excellent to each other", version = "v2") coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false every { termsOfServiceRepository.challenge() } returns challenge val result = component().createAccount( @@ -184,7 +212,7 @@ class AccountsComponentCreateAccountTest { val challenge = TermsOfServiceChallenge(text = "Be excellent to each other", version = "v1") coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false every { termsOfServiceRepository.challenge() } returns challenge coEvery { accountsRepository.createAccount( @@ -210,6 +238,7 @@ class AccountsComponentCreateAccountTest { fun `Create Account - Whitelist rejection precedes TOS challenge`() = runTest { coEvery { accountsRepository.hasUsers() } returns true coEvery { accountsRepository.findAccount(any()) } returns null + coEvery { whiteListRepository.useWhiteList() } returns true coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns false every { termsOfServiceRepository.challenge() } returns TermsOfServiceChallenge(text = "Be excellent to each other", version = "v1") diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentLoginTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentLoginTest.kt index 8edbcc0d5..bf7bce084 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentLoginTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsComponentLoginTest.kt @@ -9,7 +9,6 @@ import com.darkrockstudios.apps.hammer.projects.ProjectsRepository import com.darkrockstudios.apps.hammer.utilities.SResult import com.darkrockstudios.apps.hammer.utilities.isFailure import com.darkrockstudios.apps.hammer.utilities.isSuccess -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry import io.mockk.MockKAnnotations import io.mockk.coEvery import io.mockk.coVerify @@ -60,7 +59,6 @@ class AccountsComponentLoginTest { bio = null, email_verified = true, community_member = false, - deleted_at = null, ) @BeforeEach @@ -69,7 +67,34 @@ class AccountsComponentLoginTest { } @Test - fun `Login - Success - Valid and on the allowed list`() = runTest { + fun `Login - Success`() = runTest { + coEvery { whiteListRepository.useWhiteList() } returns false + coEvery { accountsRepository.findAccount(validEmail) } returns account + coEvery { + accountsRepository.login( + email = validEmail, + password = validPassword, + installId = installId + ) + } returns SResult.success(token) + + val comp = AccountsComponent( + accountsRepository, + whiteListRepository, + projectsRepository, + configRepository, + termsOfServiceRepository, + serverConfig + ) + val result = comp.login(validEmail, validPassword, installId) + + assertTrue(isSuccess(result)) + assertEquals(token, result.data) + } + + @Test + fun `Login - Success - Valid, whitelist enabled and one it`() = runTest { + coEvery { whiteListRepository.useWhiteList() } returns true coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true coEvery { accountsRepository.findAccount(validEmail) } returns account coEvery { @@ -84,8 +109,9 @@ class AccountsComponentLoginTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) val result = comp.login(validEmail, validPassword, installId) @@ -94,7 +120,8 @@ class AccountsComponentLoginTest { } @Test - fun `Login - Failure - Valid, but not on the allowed list`() = runTest { + fun `Login - Failure - Valid, but not on whitelist`() = runTest { + coEvery { whiteListRepository.useWhiteList() } returns true coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns false coEvery { accountsRepository.findAccount(validEmail) } returns account coEvery { @@ -109,8 +136,9 @@ class AccountsComponentLoginTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) val result = comp.login(validEmail, validPassword, installId) @@ -121,7 +149,7 @@ class AccountsComponentLoginTest { @Test fun `Login - Failure - Account not found`() = runTest { - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { accountsRepository.findAccount(validEmail) } returns null coEvery { accountsRepository.login( @@ -135,8 +163,9 @@ class AccountsComponentLoginTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) val result = comp.login(validEmail, validPassword, installId) @@ -154,8 +183,9 @@ class AccountsComponentLoginTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) val result = comp.refreshToken(unknownUserId, installId, "bad-refresh") @@ -163,30 +193,9 @@ class AccountsComponentLoginTest { assertTrue(isFailure(result)) } - @Test - fun `Refresh - soft-deleted account is rejected with the pending-deletion failure`() = runTest { - coEvery { accountsRepository.getAccountOrNull(token.userId) } returns - account.copy(deleted_at = Instant.parse("2026-07-01T00:00:00Z")) - - val comp = AccountsComponent( - accountsRepository, - whiteListRepository, - projectsRepository, - termsOfServiceRepository, - PluginRegistry(emptyList()) - ) - - val result = comp.refreshToken(token.userId, installId, "some-refresh") - - assertTrue(isFailure(result)) - assertEquals("Account pending deletion", result.error) - // The gate must short-circuit before a token could be refreshed. - coVerify(exactly = 0) { accountsRepository.refreshToken(any(), any(), any()) } - } - @Test fun `Login - Failure - Bad Login`() = runTest { - coEvery { whiteListRepository.isOnWhiteList(validEmail) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { accountsRepository.findAccount(validEmail) } returns account coEvery { accountsRepository.login( @@ -200,8 +209,9 @@ class AccountsComponentLoginTest { accountsRepository, whiteListRepository, projectsRepository, + configRepository, termsOfServiceRepository, - PluginRegistry(emptyList()) + serverConfig ) val result = comp.login(validEmail, validPassword, installId) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryTest.kt index cb0945aaa..e9c7ff9d9 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/AccountsRepositoryTest.kt @@ -92,7 +92,6 @@ class AccountsRepositoryTest : BaseTest() { bio = null, email_verified = true, community_member = false, - deleted_at = null, ) } @@ -116,52 +115,6 @@ class AccountsRepositoryTest : BaseTest() { assertEquals("${result.data.refresh}-hashed", storedToken.captured.refresh) } - @Test - fun `Pair install - stores hashed tokens under the new install`() = runTest { - val storedToken = slot() - coEvery { authTokenDao.setToken(userId, "watch-install", capture(storedToken), any()) } just Runs - val accountsRepository = AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = accountsRepository.pairInstall( - userId = userId, - callerInstallId = installId, - newInstallId = "watch-install", - ) - - assertTrue(isSuccess(result)) - assertEquals(userId, result.data.userId) - assertEquals("${result.data.auth}-hashed", storedToken.captured.auth) - assertEquals("${result.data.refresh}-hashed", storedToken.captured.refresh) - } - - @Test - fun `Pair install - refuses the caller's own install`() = runTest { - val accountsRepository = AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = accountsRepository.pairInstall( - userId = userId, - callerInstallId = installId, - newInstallId = installId, - ) - - assertTrue(result.isFailure) - coVerify(exactly = 0) { authTokenDao.setToken(any(), any(), any(), any()) } - } - - @Test - fun `Pair install - refuses a blank install`() = runTest { - val accountsRepository = AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = accountsRepository.pairInstall( - userId = userId, - callerInstallId = installId, - newInstallId = " ", - ) - - assertTrue(result.isFailure) - coVerify(exactly = 0) { authTokenDao.setToken(any(), any(), any(), any()) } - } - @Test fun `Login - Wrong password`() = runTest { coEvery { accountDao.findAccount(any()) } returns account @@ -190,53 +143,6 @@ class AccountsRepositoryTest : BaseTest() { assertTrue(result.isFailure) } - @Test - fun `Login - soft-deleted account with correct password gets the pending-deletion failure`() = runTest { - coEvery { accountDao.findAccount(any()) } returns account.copy(deleted_at = Clock.System.now()) - val accountsRepository = - AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = - accountsRepository.login(email = email, installId = installId, password = password) - - assertTrue(result.isFailure) - result as ServerResult.Failure - assertEquals("Account pending deletion", result.error) - // A locked-out account must never be issued a token. - coVerify(exactly = 0) { authTokenDao.setToken(any(), any(), any(), any()) } - } - - @Test - fun `Login - soft-deleted account with wrong password gets the generic failure`() = runTest { - coEvery { accountDao.findAccount(any()) } returns account.copy(deleted_at = Clock.System.now()) - val accountsRepository = - AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = accountsRepository.login( - email = email, - installId = installId, - password = password + "wrong" - ) - - assertTrue(result.isFailure) - result as ServerResult.Failure - // The account's deletion state must not leak to a password guesser. - assertEquals("Invalid credentials", result.error) - } - - @Test - fun `CreateAccount - soft-deleted existing account gets the pending-deletion failure`() = runTest { - coEvery { accountDao.findAccount(any()) } returns account.copy(deleted_at = Clock.System.now()) - val accountsRepository = - AccountsRepository(accountDao, authTokenDao, clock, tokenHasher, b64) - - val result = accountsRepository.createAccount(email, installId, password) - - assertTrue(result.isFailure) - result as ServerResult.Failure - assertEquals("account pending deletion", result.error) - } - @Test fun `Login - unknown account and wrong password are indistinguishable`() = runTest { coEvery { accountDao.findAccount(email) } returns account @@ -250,8 +156,8 @@ class AccountsRepositoryTest : BaseTest() { assertTrue(isFailure(wrongPassword)) assertTrue(isFailure(unknownAccount)) assertEquals( - (wrongPassword.displayMessage as? ServerMessage.Resource)?.r?.joinToString("|"), - (unknownAccount.displayMessage as? ServerMessage.Resource)?.r?.joinToString("|"), + wrongPassword.displayMessage?.r?.joinToString("|"), + unknownAccount.displayMessage?.r?.joinToString("|"), "Login must not reveal whether the account exists", ) } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/PasswordResetRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/PasswordResetRepositoryTest.kt index 8e2be3b4b..ca2ad9dee 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/PasswordResetRepositoryTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/account/PasswordResetRepositoryTest.kt @@ -8,11 +8,11 @@ import com.darkrockstudios.apps.hammer.database.AuthTokenDao import com.darkrockstudios.apps.hammer.database.PasswordResetTokenDao import com.darkrockstudios.apps.hammer.email.EmailResult import com.darkrockstudios.apps.hammer.email.EmailService -import com.darkrockstudios.apps.hammer.utilities.Argon2PasswordHasher import com.darkrockstudios.apps.hammer.utilities.isFailure import com.darkrockstudios.apps.hammer.utilities.isSuccess import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.TestClock +import de.mkammerer.argon2.Argon2Factory import io.mockk.coEvery import io.mockk.coVerify import io.mockk.mockk @@ -77,7 +77,6 @@ class PasswordResetRepositoryTest : BaseTest() { bio = null, email_verified = true, community_member = false, - deleted_at = null, ) private fun resetToken( @@ -221,7 +220,7 @@ class PasswordResetRepositoryTest : BaseTest() { val newHash = slot() coVerify(exactly = 1) { accountDao.updatePassword(userId, capture(newHash)) } assertTrue( - Argon2PasswordHasher.verify(newHash.captured, "BrandNewPass123".toCharArray()), + Argon2Factory.create().verify(newHash.captured, "BrandNewPass123".toCharArray()), "Stored hash must verify against the new password", ) coVerify(exactly = 1) { authTokenDao.deleteTokensByUserId(userId) } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponentTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponentTest.kt index 2ec897138..000541f4c 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponentTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/AdminComponentTest.kt @@ -32,7 +32,7 @@ class AdminComponentTest : BaseTest() { db.initialize() whiteListDao = WhiteListDao(db) clock = TestClock(Clock.System) - whiteListRepository = WhiteListRepository(whiteListDao, clock) + whiteListRepository = WhiteListRepository(whiteListDao, ConfigRepository(ServerConfigDao(db)), clock) setupKoin() } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepositoryTest.kt index 729b8f39b..4287eae99 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepositoryTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhiteListRepositoryTest.kt @@ -20,6 +20,8 @@ class WhiteListRepositoryTest : BaseTest() { private lateinit var db: SharedPostgresTestDatabase private lateinit var whiteListDao: WhiteListDao + private lateinit var configDao: ServerConfigDao + private lateinit var configRepository: ConfigRepository private lateinit var clock: TestClock @BeforeEach @@ -29,13 +31,41 @@ class WhiteListRepositoryTest : BaseTest() { db = SharedPostgresTestDatabase() db.initialize() whiteListDao = WhiteListDao(db) + configDao = ServerConfigDao(db) + configRepository = ConfigRepository(configDao) clock = TestClock(Clock.System) setupKoin() } - private fun createRepo() = WhiteListRepository(whiteListDao, clock) + private fun createRepo() = WhiteListRepository(whiteListDao, configRepository, clock) + + @Test + fun `useWhiteList - returns true by default`() = runTest { + val repo = createRepo() + assertTrue(repo.useWhiteList(), "Should be enabled by default") + } + + @Test + fun `setWhiteListEnabled - updates config`() = runTest { + val repo = createRepo() + + repo.setWhiteListEnabled(false) + assertFalse(repo.useWhiteList(), "Should be disabled after setting to false") + + repo.setWhiteListEnabled(true) + assertTrue(repo.useWhiteList(), "Should be enabled after setting to true") + } + + @Test + fun `setWhiteListEnabled - persists`() = runTest { + val repo1 = createRepo() + repo1.setWhiteListEnabled(false) + + val repo2 = createRepo() + assertFalse(repo2.useWhiteList(), "Should be disabled in new repo instance") + } @Test fun `getWhiteList - all`() = runTest { @@ -250,154 +280,4 @@ class WhiteListRepositoryTest : BaseTest() { assertTrue(repo.validateExpiry(clock.now() + 1.days)) assertFalse(repo.validateExpiry(clock.now() - 1.days), "A past expiry is meaningless") } - - @Test - fun `email search - matches a partial email and excludes the rest`() = runTest { - seedEmails("alice@example.com", "alicia@example.com", "bob@example.com") - - val repo = createRepo() - val result = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "alic") - - assertEquals( - listOf("alice@example.com", "alicia@example.com"), - result.map { it.email }.sorted() - ) - } - - @Test - fun `email search - matches anywhere in the address, not just the start`() = runTest { - seedEmails("someone@hammer.ink", "other@example.com") - - val repo = createRepo() - val result = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "hammer.ink") - - assertEquals(listOf("someone@hammer.ink"), result.map { it.email }) - } - - @Test - fun `email search - is case insensitive`() = runTest { - // Bypasses the repository's cleanEmail so a mixed-case row really lands in the table. - whiteListDao.addToWhiteList("Alice@Example.com", Instant.fromEpochSeconds(0), "Test") - - val repo = createRepo() - - assertEquals(1, repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "alice").size) - assertEquals(1, repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "ALICE").size) - assertEquals(1L, repo.getWhiteListCount("alice")) - } - - @Test - fun `email search - honours both sort directions`() = runTest { - whiteListDao.addToWhiteList("alice.old@example.com", Instant.fromEpochSeconds(1000), "Test") - whiteListDao.addToWhiteList("alice.new@example.com", Instant.fromEpochSeconds(9000), "Test") - whiteListDao.addToWhiteList("bob@example.com", Instant.fromEpochSeconds(5000), "Test") - - val repo = createRepo() - - val newestFirst = repo.getWhiteListWithAccountStatus(0, 10, sortOldestFirst = false, emailSearch = "alice") - val oldestFirst = repo.getWhiteListWithAccountStatus(0, 10, sortOldestFirst = true, emailSearch = "alice") - - assertEquals(listOf("alice.new@example.com", "alice.old@example.com"), newestFirst.map { it.email }) - assertEquals(listOf("alice.old@example.com", "alice.new@example.com"), oldestFirst.map { it.email }) - } - - @Test - fun `email search - count matches the filter and pages are disjoint`() = runTest { - seedEmails(*(1..15).map { "alice$it@example.com" }.toTypedArray()) - seedEmails("bob@example.com", "carol@example.com") - - val repo = createRepo() - - assertEquals(15L, repo.getWhiteListCount("alice")) - assertEquals(17L, repo.getWhiteListCount(), "An absent filter still counts everything") - - val firstPage = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "alice").map { it.email } - val secondPage = repo.getWhiteListWithAccountStatus(1, 10, emailSearch = "alice").map { it.email } - - assertEquals(10, firstPage.size) - assertEquals(5, secondPage.size) - assertTrue(firstPage.intersect(secondPage.toSet()).isEmpty(), "Pages must not overlap") - } - - @Test - fun `email search - underscore is matched literally, not as a wildcard`() = runTest { - seedEmails("a_b@example.com", "axb@example.com") - - val repo = createRepo() - val result = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "a_b") - - assertEquals(listOf("a_b@example.com"), result.map { it.email }) - } - - @Test - fun `email search - a bare percent matches nothing rather than everything`() = runTest { - seedEmails("alice@example.com", "bob@example.com") - - val repo = createRepo() - - assertEquals(0L, repo.getWhiteListCount("%")) - assertTrue(repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "%").isEmpty()) - } - - @Test - fun `email search - surrounding whitespace is ignored`() = runTest { - seedEmails("alice@example.com", "bob@example.com") - - val repo = createRepo() - val result = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = " alice ") - - assertEquals(listOf("alice@example.com"), result.map { it.email }) - } - - @Test - fun `email search - a null or blank filter lists everything`() = runTest { - seedEmails("alice@example.com", "bob@example.com") - - val repo = createRepo() - - assertEquals(2, repo.getWhiteListWithAccountStatus(0, 10, emailSearch = null).size) - assertEquals(2, repo.getWhiteListWithAccountStatus(0, 10, emailSearch = " ").size) - assertEquals(2L, repo.getWhiteListCount(" ")) - } - - @Test - fun `paging is stable when every entry shares a date_added`() = runTest { - // backfillFromAccounts stamps every migrated row with one timestamp, so the sort - // key alone can't order them and LIMIT/OFFSET needs a unique tiebreaker. - val emails = (1..15).map { "user%02d@example.com".format(it) } - emails.forEach { whiteListDao.addToWhiteList(it, Instant.fromEpochSeconds(0), "Test") } - - val repo = createRepo() - val firstPage = repo.getWhiteListWithAccountStatus(0, 10).map { it.email } - val secondPage = repo.getWhiteListWithAccountStatus(1, 10).map { it.email } - - assertEquals(emails.take(10), firstPage, "Ties break on email, so paging is deterministic") - assertEquals(emails.drop(10), secondPage) - assertEquals(emails, firstPage + secondPage, "Every entry appears exactly once") - } - - @Test - fun `filtered paging is stable when every entry shares a date_added`() = runTest { - val emails = (1..15).map { "alice%02d@example.com".format(it) } - emails.forEach { whiteListDao.addToWhiteList(it, Instant.fromEpochSeconds(0), "Test") } - - val repo = createRepo() - val firstPage = repo.getWhiteListWithAccountStatus(0, 10, emailSearch = "alice").map { it.email } - val secondPage = repo.getWhiteListWithAccountStatus(1, 10, emailSearch = "alice").map { it.email } - - assertEquals(emails, firstPage + secondPage, "Every match appears exactly once across pages") - } - - @Test - fun `emailSearchPattern - wraps in wildcards and escapes LIKE metacharacters`() { - assertEquals("%alice%", WhiteListRepository.emailSearchPattern("alice")) - assertEquals("%alice%", WhiteListRepository.emailSearchPattern(" alice ")) - assertEquals("%a\\_b%", WhiteListRepository.emailSearchPattern("a_b")) - assertEquals("%50\\%%", WhiteListRepository.emailSearchPattern("50%")) - assertEquals("%a\\\\b%", WhiteListRepository.emailSearchPattern("a\\b")) - } - - private suspend fun seedEmails(vararg emails: String) { - emails.forEach { whiteListDao.addToWhiteList(it, Instant.fromEpochSeconds(0), "Test") } - } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhitelistExpiryJobTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhitelistExpiryJobTest.kt index 993290aee..b54891af2 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhitelistExpiryJobTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/admin/WhitelistExpiryJobTest.kt @@ -44,7 +44,7 @@ class WhitelistExpiryJobTest : BaseTest() { accountDao = AccountDao(db) authTokenDao = AuthTokenDao(db) clock = TestClock(Clock.System) - whiteListRepository = WhiteListRepository(whiteListDao, clock) + whiteListRepository = WhiteListRepository(whiteListDao, ConfigRepository(ServerConfigDao(db)), clock) accountsRepository = AccountsRepository( accountDao = accountDao, authTokenDao = authTokenDao, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/AccountDaoSoftDeleteTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/AccountDaoSoftDeleteTest.kt deleted file mode 100644 index 31ddf8375..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/AccountDaoSoftDeleteTest.kt +++ /dev/null @@ -1,107 +0,0 @@ -package com.darkrockstudios.apps.hammer.database - -import com.darkrockstudios.apps.hammer.base.http.Token -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.utils.BaseTest -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertNull -import kotlin.time.Clock -import kotlin.time.Duration.Companion.days - -class AccountDaoSoftDeleteTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private lateinit var accountDao: AccountDao - private lateinit var authTokenDao: AuthTokenDao - - @BeforeEach - override fun setup() { - super.setup() - - db = SharedPostgresTestDatabase() - db.initialize() - accountDao = AccountDao(db) - authTokenDao = AuthTokenDao(db) - - setupKoin() - } - - @Test - fun `markDeleted - flags a regular account`() = runTest { - val userId = accountDao.createAccount("writer@example.com", "hash", "secret", isAdmin = false) - - accountDao.markDeleted(userId, Clock.System.now()) - - assertNotNull(accountDao.getAccount(userId)?.deleted_at) - } - - @Test - fun `markDeleted - refuses admin accounts at the data layer`() = runTest { - val userId = accountDao.createAccount("admin@example.com", "hash", "secret", isAdmin = true) - - accountDao.markDeleted(userId, Clock.System.now()) - - assertNull( - accountDao.getAccount(userId)?.deleted_at, - "The markDeleted query itself must refuse admin rows", - ) - } - - @Test - fun `markDeleted - retry keeps the original deletion time`() = runTest { - val userId = accountDao.createAccount("retry@example.com", "hash", "secret", isAdmin = false) - // Millisecond precision so the value round-trips Postgres' microsecond columns exactly. - val now = Clock.System.now() - val firstDeletion = kotlin.time.Instant.fromEpochMilliseconds(now.toEpochMilliseconds()) - 5.days - - accountDao.markDeleted(userId, firstDeletion) - accountDao.markDeleted(userId, Clock.System.now()) - - assertEquals(firstDeletion, accountDao.getAccount(userId)?.deleted_at) - } - - @Test - fun `auth tokens of a soft-deleted account are invisible to the bearer gate`() = runTest { - val userId = accountDao.createAccount("locked-out@example.com", "hash", "secret", isAdmin = false) - authTokenDao.setToken( - userId = userId, - installId = "install-1", - token = Token(userId = userId, auth = "auth-locked", refresh = "refresh-locked"), - expires = Clock.System.now() + 30.days, - ) - assertNotNull(authTokenDao.getTokenByAuthToken("auth-locked")) - - accountDao.markDeleted(userId, Clock.System.now()) - assertNull(authTokenDao.getTokenByAuthToken("auth-locked")) - - accountDao.restoreDeleted(userId) - assertNotNull(authTokenDao.getTokenByAuthToken("auth-locked")) - } - - @Test - fun `restoreDeleted - un-flags a soft-deleted account`() = runTest { - val userId = accountDao.createAccount("writer2@example.com", "hash", "secret", isAdmin = false) - accountDao.markDeleted(userId, Clock.System.now()) - - accountDao.restoreDeleted(userId) - - assertNull(accountDao.getAccount(userId)?.deleted_at) - } - - @Test - fun `getSoftDeletedBefore - returns only accounts past the cutoff`() = runTest { - val now = Clock.System.now() - val oldId = accountDao.createAccount("old@example.com", "hash", "secret", isAdmin = false) - val recentId = accountDao.createAccount("recent@example.com", "hash", "secret", isAdmin = false) - accountDao.markDeleted(oldId, now - 40.days) - accountDao.markDeleted(recentId, now - 2.days) - - val due = accountDao.getSoftDeletedBefore(now - 30.days) - - assertEquals(listOf(oldId), due.map { it.id }) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDaoTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDaoTest.kt index a57b4778a..938da80cd 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDaoTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/ProjectAccessDaoTest.kt @@ -7,10 +7,7 @@ import org.junit.jupiter.api.BeforeEach import org.junit.jupiter.api.Test import kotlin.test.assertEquals import kotlin.test.assertFalse -import kotlin.test.assertNotNull -import kotlin.test.assertNull import kotlin.test.assertTrue -import kotlin.time.Clock class ProjectAccessDaoTest : BaseTest() { @@ -29,12 +26,6 @@ class ProjectAccessDaoTest : BaseTest() { setupKoin() } - private suspend fun insertShare( - projectId: Long, - password: String, - sceneIds: Collection = emptyList(), - ): Long? = dao.insertAccessWithScenes(projectId, password, null, sceneIds, Clock.System.now()) - @Test fun `deleteAccessById does not delete an access row belonging to another project`() = runTest { dao.insertAccess(victimProjectId, "victim-secret", null) @@ -56,91 +47,4 @@ class ProjectAccessDaoTest : BaseTest() { assertTrue(deleted) assertEquals(0, dao.getAllAccessForProject(victimProjectId).size) } - - @Test - fun `insertAccessWithScenes persists the access row and its scene ids`() = runTest { - val accessId = assertNotNull(insertShare(victimProjectId, "secret", listOf(3, 7, 12))) - - assertEquals(accessId, dao.getAllAccessForProject(victimProjectId).single().id) - assertEquals(listOf(3, 7, 12), dao.getSceneIdsForAccess(accessId).sorted()) - } - - @Test - fun `insertAccessWithScenes with no scenes creates an unrestricted share`() = runTest { - val accessId = assertNotNull(insertShare(victimProjectId, "secret")) - - assertEquals(emptyList(), dao.getSceneIdsForAccess(accessId)) - } - - @Test - fun `insertAccessWithScenes refuses a password already used by a live share`() = runTest { - assertNotNull(insertShare(victimProjectId, "secret")) - - val second = insertShare(victimProjectId, "secret", listOf(1)) - - assertNull(second, "a live duplicate must not insert") - assertEquals(1, dao.getAllAccessForProject(victimProjectId).size) - } - - @Test - fun `insertAccessWithScenes allows reusing the password of an expired share`() = runTest { - // Raw insert: the expires-after-published CHECK bars seeding an already-expired - // row through the queries. - db.executeAsync( - "INSERT INTO project_access(project_id, access_password, published_at, expires_at) " + - "VALUES ($victimProjectId, 'secret', '2019-01-01T00:00:00Z', '2020-01-01T00:00:00Z')" - ) - - val accessId = insertShare(victimProjectId, "secret", listOf(1)) - - assertNotNull(accessId, "an expired share must not block its password") - } - - @Test - fun `insertAccessWithScenes allows the same password on a different project`() = runTest { - assertNotNull(insertShare(victimProjectId, "secret")) - - assertNotNull(insertShare(attackerProjectId, "secret")) - } - - @Test - fun `getSceneIdsForAccessIds maps only limited shares`() = runTest { - val limitedId = assertNotNull(insertShare(victimProjectId, "limited", listOf(1, 2, 3))) - val unrestrictedId = assertNotNull(insertShare(victimProjectId, "unrestricted")) - - val idsByAccess = dao.getSceneIdsForAccessIds(listOf(limitedId, unrestrictedId)) - - assertEquals(mapOf(limitedId to setOf(1, 2, 3)), idsByAccess) - } - - @Test - fun `deleteAccessById removes the scene rows of its share`() = runTest { - val accessId = assertNotNull(insertShare(victimProjectId, "secret", listOf(1, 2))) - - val deleted = dao.deleteAccessById(accessId, victimProjectId) - - assertTrue(deleted) - assertEquals(emptyList(), dao.getSceneIdsForAccess(accessId)) - } - - @Test - fun `deleteAccessById from a foreign project leaves scene rows intact`() = runTest { - val accessId = assertNotNull(insertShare(victimProjectId, "secret", listOf(1, 2))) - - val deleted = dao.deleteAccessById(accessId, attackerProjectId) - - assertFalse(deleted) - assertEquals(listOf(1, 2), dao.getSceneIdsForAccess(accessId).sorted()) - } - - @Test - fun `deleteAccess removes every share and scene row of the project`() = runTest { - val accessId = assertNotNull(insertShare(victimProjectId, "secret", listOf(1, 2))) - - dao.deleteAccess(victimProjectId) - - assertEquals(0, dao.getAllAccessForProject(victimProjectId).size) - // FK enforcement is off in this harness, so orphans would survive a cascade-only delete. - assertEquals(emptyList(), dao.getSceneIdsForAccess(accessId)) - } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDaoTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDaoTest.kt deleted file mode 100644 index 01f5a1a9e..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/database/UserDataPurgeDaoTest.kt +++ /dev/null @@ -1,53 +0,0 @@ -package com.darkrockstudios.apps.hammer.database - -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.utils.BaseTest -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import kotlin.test.assertFalse -import kotlin.test.assertNotNull -import kotlin.test.assertNull -import kotlin.test.assertTrue -import kotlin.time.Clock - -class UserDataPurgeDaoTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private lateinit var accountDao: AccountDao - private lateinit var purgeDao: UserDataPurgeDao - - @BeforeEach - override fun setup() { - super.setup() - - db = SharedPostgresTestDatabase() - db.initialize() - accountDao = AccountDao(db) - purgeDao = UserDataPurgeDao(db) - - setupKoin() - } - - @Test - fun `purgeUserData - deletes a soft-deleted account`() = runTest { - val userId = accountDao.createAccount("purge-me@example.com", "hash", "secret", isAdmin = false) - accountDao.markDeleted(userId, Clock.System.now()) - - assertTrue(purgeDao.purgeUserData(userId)) - assertNull(accountDao.getAccount(userId)) - } - - @Test - fun `purgeUserData - refuses an account that is not soft-deleted`() = runTest { - val userId = accountDao.createAccount("keep-me@example.com", "hash", "secret", isAdmin = false) - - assertFalse(purgeDao.purgeUserData(userId), "A restored account must never be purged") - assertNotNull(accountDao.getAccount(userId)) - } - - @Test - fun `purgeUserData - missing account returns false`() = runTest { - assertFalse(purgeDao.purgeUserData(999_999L)) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/AllowedUsersBackfillMigrationTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/AllowedUsersBackfillMigrationTest.kt deleted file mode 100644 index cf8115c63..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/AllowedUsersBackfillMigrationTest.kt +++ /dev/null @@ -1,142 +0,0 @@ -package com.darkrockstudios.apps.hammer.datamigrator - -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.ServerConfigKey -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository -import com.darkrockstudios.apps.hammer.database.AccountDao -import com.darkrockstudios.apps.hammer.database.ServerConfigDao -import com.darkrockstudios.apps.hammer.database.WhiteListDao -import com.darkrockstudios.apps.hammer.datamigrator.migrations.AllowedUsersBackfillMigration -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.utils.BaseTest -import com.darkrockstudios.apps.hammer.utils.TestClock -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertNull -import kotlin.time.Clock -import kotlin.time.Duration.Companion.days -import kotlin.time.Instant - -class AllowedUsersBackfillMigrationTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private lateinit var accountDao: AccountDao - private lateinit var whiteListDao: WhiteListDao - private lateinit var configRepository: ConfigRepository - private lateinit var repository: WhiteListRepository - private lateinit var migration: AllowedUsersBackfillMigration - private lateinit var clock: TestClock - - @BeforeEach - override fun setup() { - super.setup() - - db = SharedPostgresTestDatabase() - db.initialize() - accountDao = AccountDao(db) - whiteListDao = WhiteListDao(db) - configRepository = ConfigRepository(ServerConfigDao(db)) - clock = TestClock(Clock.System) - repository = WhiteListRepository(whiteListDao, clock) - migration = AllowedUsersBackfillMigration(repository, configRepository) - - setupKoin() - } - - private val legacyFlag = ServerConfigKey.boolean("whitelist_enabled", true) - - private suspend fun legacyWhitelistWasDisabled() { - configRepository.set(legacyFlag, false) - } - - @Test - fun `migrate - skips the backfill when the legacy whitelist was enforcing`() = runTest { - // A missing white_list row on an enforcing server means access was revoked - // (expired invite, lapsed patron, manual removal); it must stay revoked. - configRepository.set(legacyFlag, true) - accountDao.createAccount("revoked@example.com", "hash", "secret", isAdmin = false) - - migration.migrate() - - assertNull(whiteListDao.getByEmail("revoked@example.com")) - } - - @Test - fun `migrate - skips the backfill when no legacy flag row exists`() = runTest { - // The old toggle defaulted to enabled, so an absent row means enforcing. - accountDao.createAccount("alice@example.com", "hash", "secret", isAdmin = false) - - migration.migrate() - - assertNull(whiteListDao.getByEmail("alice@example.com")) - } - - @Test - fun `migrate - adds non-deleted accounts with default reason and no expiry`() = runTest { - legacyWhitelistWasDisabled() - accountDao.createAccount("alice@example.com", "hash", "secret", isAdmin = false) - accountDao.createAccount("admin@example.com", "hash", "secret", isAdmin = true) - - migration.migrate() - - val alice = whiteListDao.getByEmail("alice@example.com") - assertNotNull(alice) - assertEquals(WhiteListRepository.REASON_EXISTING_ACCOUNT, alice.reason) - assertNull(alice.expires) - assertNotNull(whiteListDao.getByEmail("admin@example.com")) - } - - @Test - fun `migrate - excludes soft-deleted accounts`() = runTest { - legacyWhitelistWasDisabled() - val userId = accountDao.createAccount("gone@example.com", "hash", "secret", isAdmin = false) - accountDao.markDeleted(userId, clock.now()) - - migration.migrate() - - assertNull(whiteListDao.getByEmail("gone@example.com")) - } - - @Test - fun `migrate - keeps an existing entry's reason and expiry`() = runTest { - legacyWhitelistWasDisabled() - // Whole seconds: Postgres stores microseconds, JVM Instants carry nanoseconds. - val expiry = Instant.fromEpochSeconds((clock.now() + 30.days).epochSeconds) - whiteListDao.addToWhiteList("patron@example.com", clock.now(), "Patreon", expiry) - accountDao.createAccount("patron@example.com", "hash", "secret", isAdmin = false) - - migration.migrate() - - val entry = whiteListDao.getByEmail("patron@example.com") - assertNotNull(entry) - assertEquals("Patreon", entry.reason) - assertEquals(expiry, entry.expires) - } - - @Test - fun `migrate - running twice adds nothing new`() = runTest { - legacyWhitelistWasDisabled() - accountDao.createAccount("alice@example.com", "hash", "secret", isAdmin = false) - - migration.migrate() - migration.migrate() - - assertEquals(1L, whiteListDao.getWhiteListCount()) - } - - @Test - fun `via DataMigrator - a removed email is not re-added once complete`() = runTest { - legacyWhitelistWasDisabled() - accountDao.createAccount("alice@example.com", "hash", "secret", isAdmin = false) - val migrator = DataMigrator(configRepository).apply { addMigration(migration) } - - migrator.runMigrations() - repository.removeFromWhiteList("alice@example.com") - migrator.runMigrations() - - assertNull(whiteListDao.getByEmail("alice@example.com")) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigratorTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigratorTest.kt deleted file mode 100644 index 5cdba9131..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/datamigrator/DataMigratorTest.kt +++ /dev/null @@ -1,78 +0,0 @@ -package com.darkrockstudios.apps.hammer.datamigrator - -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.ServerConfigKey -import com.darkrockstudios.apps.hammer.database.ServerConfigDao -import com.darkrockstudios.apps.hammer.datamigrator.migrations.DataMigration -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.utils.BaseTest -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class DataMigratorTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private lateinit var configRepository: ConfigRepository - - private class CountingMigration(override val id: String) : DataMigration { - var runs = 0 - override suspend fun migrate() { - runs++ - } - } - - @BeforeEach - override fun setup() { - super.setup() - - db = SharedPostgresTestDatabase() - db.initialize() - configRepository = ConfigRepository(ServerConfigDao(db)) - - setupKoin() - } - - private fun markerKey(id: String) = ServerConfigKey.boolean("datamigration_${id}_complete", false) - - @Test - fun `runMigrations - runs an unmarked migration and sets its marker`() = runTest { - val migration = CountingMigration("test_migration") - val migrator = DataMigrator(configRepository).apply { addMigration(migration) } - - migrator.runMigrations() - - assertEquals(1, migration.runs) - assertTrue(configRepository.get(markerKey(migration.id))) - } - - @Test - fun `runMigrations - skips a completed migration on later runs`() = runTest { - val migration = CountingMigration("test_migration") - val migrator = DataMigrator(configRepository).apply { addMigration(migration) } - - migrator.runMigrations() - migrator.runMigrations() - - assertEquals(1, migration.runs) - } - - @Test - fun `runMigrations - a failing migration propagates and leaves its marker unset`() = runTest { - val failing = object : DataMigration { - override val id = "failing_migration" - override suspend fun migrate() = error("migration failure") - } - val migrator = DataMigrator(configRepository).apply { addMigration(failing) } - - assertFailsWith { - migrator.runMigrations() - } - - assertFalse(configRepository.get(markerKey(failing.id))) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountErrorCodeTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountErrorCodeTest.kt deleted file mode 100644 index cf1191d77..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountErrorCodeTest.kt +++ /dev/null @@ -1,122 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.base.http.ApiErrorCode -import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_HEADER -import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_VERSION -import com.darkrockstudios.apps.hammer.base.http.HttpResponseError -import com.darkrockstudios.apps.hammer.base.validate.PasswordValidator -import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest -import com.darkrockstudios.apps.hammer.utils.SERVER_EMPTY_NO_WHITELIST -import com.darkrockstudios.apps.hammer.utils.createTestServer -import io.ktor.client.request.* -import io.ktor.client.request.forms.* -import io.ktor.client.statement.* -import io.ktor.http.* -import kotlinx.coroutines.runBlocking -import kotlinx.serialization.json.Json -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -/** - * Every failure the account routes can answer with, mapped to the status and - * [ApiErrorCode] a client branches on. A wrong status here is what made a rejected - * signup indistinguishable from a real conflict (#835). - */ -class AccountErrorCodeTest : EndToEndTest() { - - @Test - fun `Create Account - an existing email is a 409 naming the conflict`(): Unit = runBlocking { - startEmptyServer() - - val first = createAccount("taken@example.com", VALID_PASSWORD) - assertEquals(HttpStatusCode.Created, first.status) - - val second = createAccount("taken@example.com", VALID_PASSWORD) - - assertEquals(HttpStatusCode.Conflict, second.status) - assertEquals(ApiErrorCode.ACCOUNT_EXISTS, second.errorCode()) - } - - @Test - fun `Create Account - an email pending deletion is a 409, not a plain conflict`(): Unit = runBlocking { - startEmptyServer() - - assertEquals(HttpStatusCode.Created, createAccount("leaving@example.com", VALID_PASSWORD).status) - // Soft delete keeps the row, which reserves the email for the retention window. - database().executeAsync("UPDATE account SET deleted_at = NOW() WHERE email = 'leaving@example.com'") - - val response = createAccount("leaving@example.com", VALID_PASSWORD) - - assertEquals(HttpStatusCode.Conflict, response.status) - assertEquals(ApiErrorCode.ACCOUNT_PENDING_DELETION, response.errorCode()) - } - - @Test - fun `Create Account - a malformed email is a 400`(): Unit = runBlocking { - startEmptyServer() - - val response = createAccount("not-an-email", VALID_PASSWORD) - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals(ApiErrorCode.INVALID_EMAIL, response.errorCode()) - } - - @Test - fun `Create Account - a short password is a 400 naming the rule`(): Unit = runBlocking { - startEmptyServer() - - val response = createAccount("short@example.com", "x".repeat(PasswordValidator.MIN_LENGTH - 1)) - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals(ApiErrorCode.PASSWORD_TOO_SHORT, response.errorCode()) - } - - @Test - fun `Refresh Token - an unknown token is a 401 the client can act on`(): Unit = runBlocking { - startEmptyServer() - - assertEquals(HttpStatusCode.Created, createAccount("refresh@example.com", VALID_PASSWORD).status) - - val response = client().post(api("account/refresh_token/1")) { - headers { append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) } - setBody( - FormDataContent( - Parameters.build { - append("installId", INSTALL_ID) - append("refreshToken", "not-a-real-refresh-token") - } - ) - ) - } - - assertEquals(HttpStatusCode.Unauthorized, response.status) - assertEquals(ApiErrorCode.TOKEN_INVALID, response.errorCode()) - } - - private suspend fun startEmptyServer() { - createTestServer(SERVER_EMPTY_NO_WHITELIST, fileSystem, database()) - doStartServer() - } - - private suspend fun createAccount(email: String, password: String): HttpResponse = - client().post(api("account/create")) { - headers { append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) } - setBody( - FormDataContent( - Parameters.build { - append("email", email) - append("password", password) - append("installId", INSTALL_ID) - } - ) - ) - } - - private suspend fun HttpResponse.errorCode(): String? = - Json.decodeFromString(bodyAsText()).errorCode - - companion object { - private const val VALID_PASSWORD = "password123!@#" - private const val INSTALL_ID = "fake-install-id" - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountTest.kt index cd8106622..028647678 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AccountTest.kt @@ -1,15 +1,11 @@ package com.darkrockstudios.apps.hammer.e2e -import com.darkrockstudios.apps.hammer.base.http.ApiErrorCode import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_HEADER import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_VERSION -import com.darkrockstudios.apps.hammer.base.http.HttpResponseError import com.darkrockstudios.apps.hammer.base.http.Token import com.darkrockstudios.apps.hammer.base.http.createTokenBase64 -import com.darkrockstudios.apps.hammer.base.validate.PasswordValidator import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest import com.darkrockstudios.apps.hammer.utils.SERVER_CONFIG_ONE -import com.darkrockstudios.apps.hammer.utils.SERVER_EMPTY_NO_WHITELIST import com.darkrockstudios.apps.hammer.utils.SERVER_EMPTY_YES_WHITELIST import com.darkrockstudios.apps.hammer.utils.createTestServer import io.ktor.client.request.* @@ -78,7 +74,7 @@ class AccountTest : EndToEndTest() { ) } - assertEquals(HttpStatusCode.Forbidden, response.status) + assertEquals(HttpStatusCode.Conflict, response.status) assertNull( database().serverDatabase.accountQueries.findAccount("test2@example.com").executeAsOneOrNull(), "A whitelist-rejected signup must not persist an account", @@ -139,58 +135,6 @@ class AccountTest : EndToEndTest() { } } - @Test - fun `Create Account - password outside the policy is a 400 naming the rule`(): Unit = runBlocking { - createTestServer(SERVER_EMPTY_NO_WHITELIST, fileSystem, database()) - doStartServer() - client().apply { - val response = post(api("account/create")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - } - setBody( - FormDataContent( - Parameters.build { - append("email", "toolong@example.com") - append("password", "x".repeat(PasswordValidator.MAX_LENGTH + 1)) - append("installId", "fake-install-id") - } - ) - ) - } - - assertEquals(HttpStatusCode.BadRequest, response.status) - val error = Json.decodeFromString(response.bodyAsText()) - assertEquals(ApiErrorCode.PASSWORD_TOO_LONG, error.errorCode) - } - } - - @Test - fun `Login - whitelist rejection is a 403, not a credential failure`(): Unit = runBlocking { - createTestServer(SERVER_CONFIG_ONE, fileSystem, database()) - doStartServer() - client().apply { - val response = post(api("account/login")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - } - setBody( - FormDataContent( - Parameters.build { - append("email", "notonthelist@example.com") - append("password", "password123!@#") - append("installId", "fake-install-id") - } - ) - ) - } - - assertEquals(HttpStatusCode.Forbidden, response.status) - val error = Json.decodeFromString(response.bodyAsText()) - assertEquals(ApiErrorCode.NOT_WHITELISTED, error.errorCode) - } - } - @Test fun `Login - First User - Bad Password`(): Unit = runBlocking { createTestServer(SERVER_CONFIG_ONE, fileSystem, database()) @@ -212,8 +156,6 @@ class AccountTest : EndToEndTest() { } assertEquals(HttpStatusCode.Unauthorized, response.status) - val error = Json.decodeFromString(response.bodyAsText()) - assertEquals(ApiErrorCode.INVALID_CREDENTIALS, error.errorCode) } } } \ No newline at end of file diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistExpiryPageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistExpiryPageTest.kt index 10ddbf525..7f85ad963 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistExpiryPageTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistExpiryPageTest.kt @@ -3,11 +3,7 @@ package com.darkrockstudios.apps.hammer.e2e import com.darkrockstudios.apps.hammer.e2e.util.E2eTestData import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest import com.darkrockstudios.apps.hammer.e2e.util.TestAccount -import com.darkrockstudios.apps.hammer.plugin.AllowedUsersSource -import com.darkrockstudios.apps.hammer.plugin.NoticeSlot -import com.darkrockstudios.apps.hammer.plugin.ServerPlugin -import com.darkrockstudios.apps.hammer.utilities.Msg -import io.ktor.server.application.ApplicationCall +import com.darkrockstudios.apps.hammer.patreon.PatreonSyncService import io.ktor.client.HttpClient import io.ktor.client.plugins.cookies.HttpCookies import io.ktor.client.request.get @@ -36,19 +32,6 @@ import kotlin.time.Clock */ class AdminWhitelistExpiryPageTest : EndToEndTest() { - // A minimal syncing source, standing in for integrations that own their whitelist entries. - private class TestSource : AllowedUsersSource { - override val id = SOURCE_REASON - override suspend fun isActive() = true - override suspend fun notice(call: ApplicationCall, slot: NoticeSlot): String? = null - override suspend fun rejectionMessage(): Msg? = null - } - - override val serverPlugins = super.serverPlugins + object : ServerPlugin { - override val id = SOURCE_REASON - override fun allowedUsersSource(): AllowedUsersSource = TestSource() - } - private val email = "admin@test.com" private val password = "password123!@#" @@ -72,7 +55,7 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { } private suspend fun HttpClient.addEntry(target: String, preset: String, date: String = ""): String { - val response = post(route("admin/allowed-users/add")) { + val response = post(route("admin/whitelist/add")) { header("HX-Request", "true") contentType(ContentType.Application.FormUrlEncoded) setBody( @@ -183,7 +166,7 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { authed.addEntry("edit@example.com", "never") assertNull(storedExpiry("edit@example.com")) - val set = authed.post(route("admin/allowed-users/edit-expiry")) { + val set = authed.post(route("admin/whitelist/edit-expiry")) { header("HX-Request", "true") contentType(ContentType.Application.FormUrlEncoded) setBody("email=${URLEncoder.encode("edit@example.com", "UTF-8")}&expiryPreset=7") @@ -191,7 +174,7 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { assertEquals(HttpStatusCode.OK, set.status) assertNotNull(storedExpiry("edit@example.com"), "Expiry should have been set") - val clear = authed.post(route("admin/allowed-users/edit-expiry")) { + val clear = authed.post(route("admin/whitelist/edit-expiry")) { header("HX-Request", "true") contentType(ContentType.Application.FormUrlEncoded) setBody("email=${URLEncoder.encode("edit@example.com", "UTF-8")}&expiryPreset=never") @@ -212,7 +195,7 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { authed.addEntry("ext@example.com", "never") database().serverDatabase.whiteListQueries.updateExpiry(current, "ext@example.com") - val resp = authed.post(route("admin/allowed-users/edit-expiry")) { + val resp = authed.post(route("admin/whitelist/edit-expiry")) { header("HX-Request", "true") contentType(ContentType.Application.FormUrlEncoded) setBody("email=${URLEncoder.encode("ext@example.com", "UTF-8")}&expiryPreset=30") @@ -240,7 +223,7 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { authed.addEntry("lapsed2@example.com", "never") database().serverDatabase.whiteListQueries.updateExpiry(past, "lapsed2@example.com") - val resp = authed.post(route("admin/allowed-users/edit-expiry")) { + val resp = authed.post(route("admin/whitelist/edit-expiry")) { header("HX-Request", "true") contentType(ContentType.Application.FormUrlEncoded) setBody("email=${URLEncoder.encode("lapsed2@example.com", "UTF-8")}&expiryPreset=30") @@ -264,26 +247,26 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { .single { it.contains(target) } @Test - fun `source-managed entries render without an expiry control but others keep one`(): Unit = runBlocking { + fun `patreon entries render without an expiry control but others keep one`(): Unit = runBlocking { doStartServer() seed() database().serverDatabase.whiteListQueries.addToWhiteList( "patron@example.com", Clock.System.now(), - SOURCE_REASON, + PatreonSyncService.WHITELIST_REASON, null, ) login().use { authed -> - val body = authed.get(route("admin/allowed-users/user-fragment")) { + val body = authed.get(route("admin/whitelist/user-fragment")) { header("HX-Request", "true") }.bodyAsText() assertContains(body, "patron@example.com") assertFalse( rowFor(body, "patron@example.com").contains("edit-expiry-btn"), - "Source-owned entries must not offer an expiry control", + "Patreon-owned entries must not offer an expiry control", ) assertContains( rowFor(body, email), @@ -327,114 +310,4 @@ class AdminWhitelistExpiryPageTest : EndToEndTest() { user.close() } } - - private suspend fun HttpClient.postFragment(action: String, body: String): String { - val response = post(route("admin/allowed-users/$action")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody(body) - } - assertEquals(HttpStatusCode.OK, response.status) - return response.bodyAsText() - } - - @Test - fun `add validation errors re-render the fragment and create no entry`(): Unit = runBlocking { - doStartServer() - seed() - - login().use { authed -> - assertContains(authed.postFragment("add", "email="), "Email address is required") - assertContains(authed.postFragment("add", "email=not-an-email"), "Invalid email address format") - assertContains( - authed.postFragment("add", "email=valid%40example.com&reason=${"x".repeat(40)}"), - "Reason must be 32 characters or less", - ) - assertContains( - authed.postFragment("add", "email=valid%40example.com&expiryPreset=-5"), - "Expiry date must be a valid date in the future", - ) - - val emails = database().serverDatabase.whiteListQueries.getAll().executeAsList().map { it.email } - assertFalse(emails.contains("valid@example.com"), "A rejected submission must not create an entry") - } - } - - @Test - fun `edit-reason updates the entry and validates its input`(): Unit = runBlocking { - doStartServer() - seed() - - login().use { authed -> - authed.addEntry("writer@example.com", "never") - - val body = authed.postFragment("edit-reason", "email=writer%40example.com&reason=Proofreader") - assertContains(body, "Proofreader") - assertEquals( - "Proofreader", - database().serverDatabase.whiteListQueries.getAll().executeAsList() - .single { it.email == "writer@example.com" }.reason, - ) - - assertContains( - authed.postFragment("edit-reason", "email=&reason=Whatever"), - "Email address is required", - ) - assertContains( - authed.postFragment("edit-reason", "email=writer%40example.com&reason=${"x".repeat(40)}"), - "Reason must be 32 characters or less", - ) - } - } - - @Test - fun `edit-expiry validates its input`(): Unit = runBlocking { - doStartServer() - seed() - - login().use { authed -> - authed.addEntry("writer@example.com", "never") - - assertContains( - authed.postFragment("edit-expiry", "email="), - "Email address is required", - ) - assertContains( - authed.postFragment("edit-expiry", "email=writer%40example.com&expiryPreset=-5"), - "Expiry date must be a valid date in the future", - ) - } - } - - @Test - fun `old whitelist url permanently redirects to the allowed users page`(): Unit = runBlocking { - doStartServer() - seed() - - HttpClient { - install(HttpCookies) - followRedirects = false - }.use { authed -> - val loginResponse = authed.post(route("login")) { - contentType(ContentType.Application.FormUrlEncoded) - setBody( - "email=${URLEncoder.encode(email, "UTF-8")}" + - "&password=${URLEncoder.encode(password, "UTF-8")}" - ) - } - assertEquals(HttpStatusCode.Found, loginResponse.status) - - val redirect = authed.get(route("admin/whitelist")) - assertEquals(HttpStatusCode.MovedPermanently, redirect.status) - assertEquals("/admin/allowed-users", redirect.headers["Location"]) - - val page = authed.get(route("admin/allowed-users")) - assertEquals(HttpStatusCode.OK, page.status) - assertContains(page.bodyAsText(), "Allowed Users") - } - } - - private companion object { - const val SOURCE_REASON = "TestSync" - } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistSearchPageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistSearchPageTest.kt deleted file mode 100644 index 98c4d4441..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/AdminWhitelistSearchPageTest.kt +++ /dev/null @@ -1,332 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.E2eTestData -import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest -import com.darkrockstudios.apps.hammer.e2e.util.TestAccount -import io.ktor.client.HttpClient -import io.ktor.client.plugins.cookies.HttpCookies -import io.ktor.client.request.get -import io.ktor.client.request.header -import io.ktor.client.request.post -import io.ktor.client.request.setBody -import io.ktor.client.statement.bodyAsText -import io.ktor.http.ContentType -import io.ktor.http.HttpStatusCode -import io.ktor.http.contentType -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import java.net.URLEncoder -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.time.Clock - -/** - * Drives the allowed-users email search over real HTTP, so the query's trip through the - * route, the repository and the rendered fragment is exercised end to end. - */ -class AdminWhitelistSearchPageTest : EndToEndTest() { - - private val email = "admin@test.com" - private val password = "password123!@#" - - private fun seed() = runBlocking { - E2eTestData.createAccount(TestAccount(email, password, isAdmin = true), database()) - addEntries(email) - } - - private fun addEntries(vararg emails: String) { - emails.forEach { - database().serverDatabase.whiteListQueries - .addToWhiteList(it, Clock.System.now(), "Beta tester", null) - } - } - - private suspend fun login(): HttpClient { - val authed = HttpClient { install(HttpCookies) } - val response = authed.post(route("login")) { - contentType(ContentType.Application.FormUrlEncoded) - setBody( - "email=${URLEncoder.encode(email, "UTF-8")}" + - "&password=${URLEncoder.encode(password, "UTF-8")}" - ) - } - assertEquals(HttpStatusCode.Found, response.status) - return authed - } - - private suspend fun HttpClient.fragment(query: String = ""): String { - val response = get(route("admin/allowed-users/user-fragment$query")) { - header("HX-Request", "true") - } - assertEquals(HttpStatusCode.OK, response.status) - return response.bodyAsText() - } - - private suspend fun HttpClient.postFragment(action: String, body: String): String { - val response = post(route("admin/allowed-users/$action")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody(body) - } - assertEquals(HttpStatusCode.OK, response.status) - return response.bodyAsText() - } - - @Test - fun `a search filters the list to matching emails`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com", "alicia@example.com", "bob@example.com") - - login().use { authed -> - val body = authed.fragment("?q=alic") - - assertContains(body, "alice@example.com") - assertContains(body, "alicia@example.com") - assertFalse(body.contains("bob@example.com"), "Non-matching entries must be filtered out") - } - } - - @Test - fun `no search lists everything`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com", "bob@example.com") - - login().use { authed -> - val body = authed.fragment() - - assertContains(body, "alice@example.com") - assertContains(body, "bob@example.com") - } - } - - @Test - fun `pagination is scoped to the filtered set`(): Unit = runBlocking { - doStartServer() - seed() - addEntries(*(1..15).map { "alice$it@example.com" }.toTypedArray()) - addEntries("bob@example.com") - - login().use { authed -> - val firstPage = authed.fragment("?q=alice") - val secondPage = authed.fragment("?q=alice&page=1") - - assertContains(firstPage, "of 2", message = "15 matches over a page size of 10 is two pages") - assertEquals(10, firstPage.split("class=\"whitelist-entry\"").size - 1) - assertEquals(5, secondPage.split("class=\"whitelist-entry\"").size - 1) - assertFalse(secondPage.contains("bob@example.com"), "The filter must survive paging") - } - } - - @Test - fun `the sort and pagination controls carry the query forward`(): Unit = runBlocking { - doStartServer() - seed() - addEntries(*(1..15).map { "alice$it@example.com" }.toTypedArray()) - - login().use { authed -> - val body = authed.fragment("?q=alice") - - assertContains(body, "sortOldestFirst=true&q=alice") - assertContains(body, "page=1&sortOldestFirst=false&q=alice") - } - } - - @Test - fun `the remove form carries the query so the filter survives a removal`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com", "alicia@example.com", "bob@example.com") - - login().use { authed -> - val listed = authed.fragment("?q=alic") - assertContains(listed, "name=\"q\" value=\"alic\"") - - val afterRemove = authed.postFragment( - "remove", - "email=${URLEncoder.encode("alicia@example.com", "UTF-8")}&page=0&sortOldestFirst=false&q=alic" - ) - - assertContains(afterRemove, "alice@example.com") - assertFalse(afterRemove.contains("alicia@example.com"), "The removed entry should be gone") - assertFalse(afterRemove.contains("bob@example.com"), "The filter must survive the removal") - } - } - - @Test - fun `editing a reason keeps the filtered view`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com", "bob@example.com") - - login().use { authed -> - val body = authed.postFragment( - "edit-reason", - "email=${URLEncoder.encode("alice@example.com", "UTF-8")}&reason=Friend&page=0&sortOldestFirst=false&q=alice" - ) - - assertContains(body, "alice@example.com") - assertContains(body, "Friend") - assertFalse(body.contains("bob@example.com"), "The filter must survive the edit") - } - } - - @Test - fun `adding returns the unfiltered first page so the new entry is visible`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("bob@example.com") - - login().use { authed -> - val body = authed.postFragment( - "add", - "email=${URLEncoder.encode("carol@example.com", "UTF-8")}" + - "&reason=Beta+tester&expiryPreset=never&expiryDate=&page=3&q=alice" - ) - - assertContains(body, "carol@example.com", message = "The new entry must be visible") - assertContains(body, "bob@example.com", message = "The add response is deliberately unfiltered") - assertFalse(body.contains("whitelist-controls__filter"), "No filter chip should render") - } - } - - @Test - fun `a search with no matches renders its own empty state`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com") - - login().use { authed -> - val body = authed.fragment("?q=nobody") - - assertContains(body, "No allowed users match that email.") - assertFalse( - body.contains("No allowed users yet"), - "The add-your-first empty state is wrong when a filter is active", - ) - } - } - - @Test - fun `an active filter is surfaced with a clear control`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com") - - login().use { authed -> - assertContains(authed.fragment("?q=alice"), "whitelist-controls__filter") - assertFalse( - authed.fragment().contains("whitelist-controls__filter"), - "An unfiltered list should show no filter chip", - ) - } - } - - @Test - fun `a search with no matches renders no pagination bar`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com") - - login().use { authed -> - val body = authed.fragment("?q=nobody") - - assertFalse( - body.contains("class=\"pagination\""), - "Zero matches means zero pages, so no pagination bar should render", - ) - } - } - - @Test - fun `the fragment exposes its sort state so a search can preserve it`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com") - - login().use { authed -> - assertContains( - authed.fragment("?sortOldestFirst=true"), - "id=\"whitelist-sort-state\"", - ) - assertContains( - authed.fragment("?sortOldestFirst=true"), - "name=\"sortOldestFirst\" value=\"true\"", - ) - } - } - - @Test - fun `a rejected add keeps the admin's filter and page`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com", "bob@example.com") - - login().use { authed -> - val body = authed.postFragment( - "add", - "email=not-an-email&reason=Beta+tester&expiryPreset=never&expiryDate=&page=0&sortOldestFirst=false&q=alice" - ) - - assertContains(body, "Invalid email address format") - assertContains(body, "alice@example.com") - assertFalse( - body.contains("bob@example.com"), - "A validation error is not an add, so the admin's filter must survive it", - ) - } - } - - @Test - fun `a successful add signals the client to reset the form`(): Unit = runBlocking { - doStartServer() - seed() - - login().use { authed -> - val ok = authed.post(route("admin/allowed-users/add")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody( - "email=${URLEncoder.encode("carol@example.com", "UTF-8")}" + - "&reason=Beta+tester&expiryPreset=never&expiryDate=&q=alice" - ) - } - assertEquals(HttpStatusCode.OK, ok.status) - assertEquals( - "whitelist-added", - ok.headers["HX-Trigger"], - "Only a real add may tell the client to clear the form and search", - ) - - val rejected = authed.post(route("admin/allowed-users/add")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody("email=not-an-email&reason=Beta+tester&expiryPreset=never&expiryDate=&q=alice") - } - assertEquals(HttpStatusCode.OK, rejected.status) - assertEquals(null, rejected.headers["HX-Trigger"], "A rejected add must not signal a reset") - } - } - - @Test - fun `a query containing markup is escaped in both the body and the reflected links`(): Unit = runBlocking { - doStartServer() - seed() - addEntries("alice@example.com") - - login().use { authed -> - val hostile = "" - val body = authed.fragment("?q=${URLEncoder.encode(hostile, "UTF-8")}") - - assertFalse(body.contains(""), "Raw markup must never be reflected") - assertContains(body, "<script>") - assertTrue( - body.contains("q=%3Cscript%3E"), - "The query must be URL encoded where it is reflected into an hx-get", - ) - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/BehindProxyTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/BehindProxyTest.kt deleted file mode 100644 index fc49e3a93..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/BehindProxyTest.kt +++ /dev/null @@ -1,99 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.EncryptionConfig -import com.darkrockstudios.apps.hammer.EncryptionMode -import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_HEADER -import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_VERSION -import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest -import com.darkrockstudios.apps.hammer.utils.SERVER_CONFIG_ONE -import com.darkrockstudios.apps.hammer.utils.createTestServer -import io.ktor.client.request.* -import io.ktor.client.request.forms.* -import io.ktor.http.* -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals - -/** - * The login rate limiter keys on the connecting address. Behind a proxy every request carries - * the proxy's, so `trustProxyForwarding` decides whether one client can exhaust the bucket for - * everyone. - */ -class BehindProxyTest : EndToEndTest() { - - override val serverConfig = ServerConfig( - encryption = EncryptionConfig(EncryptionMode.AES), - trustProxyForwarding = true, - ) - - @Test - fun `a forwarded client address gets its own rate limit bucket`(): Unit = runBlocking { - createTestServer(SERVER_CONFIG_ONE, fileSystem, database()) - doStartServer() - - // Exhaust the window from one forwarded address. - repeat(RATE_LIMIT) { attempt -> - val response = failedLogin(forwardedFor = "203.0.113.10") - assertEquals( - HttpStatusCode.Unauthorized, - response.status, - "Attempt ${attempt + 1} should still be inside the window", - ) - } - assertEquals( - HttpStatusCode.TooManyRequests, - failedLogin(forwardedFor = "203.0.113.10").status, - "The exhausted address must be limited", - ) - - assertEquals( - HttpStatusCode.Unauthorized, - failedLogin(forwardedFor = "203.0.113.99").status, - "A different forwarded address must not inherit the first one's exhausted bucket", - ) - } - - @Test - fun `a client-supplied entry ahead of the proxy's cannot claim a fresh bucket`(): Unit = runBlocking { - createTestServer(SERVER_CONFIG_ONE, fileSystem, database()) - doStartServer() - - // The proxy appends what it saw to whatever arrived, so only the trailing entry is - // its own observation. Everything before it is the client's to invent. - repeat(RATE_LIMIT) { attempt -> - val response = failedLogin(forwardedFor = "9.9.9.$attempt, 203.0.113.10") - assertEquals( - HttpStatusCode.Unauthorized, - response.status, - "Attempt ${attempt + 1} should still be inside the window", - ) - } - - assertEquals( - HttpStatusCode.TooManyRequests, - failedLogin(forwardedFor = "1.1.1.1, 203.0.113.10").status, - "A forged leading entry must not escape the bucket the proxy's entry earned", - ) - } - - private suspend fun failedLogin(forwardedFor: String) = client().post(api("account/login")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append(HttpHeaders.XForwardedFor, forwardedFor) - } - setBody( - FormDataContent( - Parameters.build { - append("email", "test@example.com") - append("password", "definitely-not-the-password") - append("installId", "fake-install-id") - } - ) - ) - } - - private companion object { - const val RATE_LIMIT = 10 - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardBioTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardBioTest.kt index 7e3ed9a97..79028c280 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardBioTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardBioTest.kt @@ -3,8 +3,12 @@ package com.darkrockstudios.apps.hammer.e2e import ch.qos.logback.classic.Level import ch.qos.logback.classic.spi.ILoggingEvent import ch.qos.logback.core.AppenderBase -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest +import com.darkrockstudios.apps.hammer.e2e.util.E2eTestData +import com.darkrockstudios.apps.hammer.e2e.util.EndToEndTest +import com.darkrockstudios.apps.hammer.e2e.util.TestAccount +import io.ktor.client.HttpClient import io.ktor.client.plugins.compression.ContentEncoding +import io.ktor.client.plugins.cookies.HttpCookies import io.ktor.client.request.header import io.ktor.client.request.post import io.ktor.client.request.setBody @@ -21,6 +25,7 @@ import java.util.concurrent.CopyOnWriteArrayList import kotlin.test.assertContains import kotlin.test.assertEquals import kotlin.test.assertTrue +import kotlin.time.Clock /** * Saving a bio renders a fragment large enough for the Compression plugin to rewrite the response, @@ -29,7 +34,7 @@ import kotlin.test.assertTrue * The failure this guards against surfaces only in the log: the response is already written by the * time the handler's coroutine resumes, so a crash there leaves the client with a healthy 200. */ -class DashboardBioTest : WebEndToEndTest() { +class DashboardBioTest : EndToEndTest() { private val email = "author@test.com" private val password = "password123!@#" @@ -54,12 +59,35 @@ class DashboardBioTest : WebEndToEndTest() { errorCollector.stop() } + private fun seed() = runBlocking { + E2eTestData.createAccount(TestAccount(email, password), database()) + database().serverDatabase.whiteListQueries + .addToWhiteList(email, Clock.System.now(), "Test author", null) + val account = database().serverDatabase.accountQueries.findAccount(email).executeAsOne() + database().serverDatabase.accountQueries.updatePenName("Test Author", account.id) + } + + private suspend fun login(): HttpClient { + val authed = HttpClient { + install(HttpCookies) + install(ContentEncoding) { gzip() } + } + val response = authed.post(route("login")) { + contentType(ContentType.Application.FormUrlEncoded) + setBody( + "email=${URLEncoder.encode(email, "UTF-8")}" + + "&password=${URLEncoder.encode(password, "UTF-8")}" + ) + } + assertEquals(HttpStatusCode.Found, response.status) + return authed + } + @Test fun `saving a bio renders the section and a toast without failing the handler`(): Unit = runBlocking { doStartServer() - seedWhitelistedAccount(email, password, penName = "Test Author") - // Compression is what makes the send pipeline suspend, which is the point of this test. - val authed = login(email, password) { install(ContentEncoding) { gzip() } } + seed() + val authed = login() collectServerErrors() val bio = "I write stories about the sea. ".repeat(30) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardErrorToastTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardErrorToastTest.kt deleted file mode 100644 index 723ca8585..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/DashboardErrorToastTest.kt +++ /dev/null @@ -1,63 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest -import com.darkrockstudios.apps.hammer.frontend.utils.SWAP_ERROR_HEADER -import io.ktor.client.HttpClient -import io.ktor.client.request.header -import io.ktor.client.request.post -import io.ktor.client.request.setBody -import io.ktor.client.statement.HttpResponse -import io.ktor.client.statement.bodyAsText -import io.ktor.http.ContentType -import io.ktor.http.HttpStatusCode -import io.ktor.http.contentType -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.test.assertContains -import kotlin.test.assertEquals - -/** - * The dashboard's rejection paths answer with an error status and an out-of-band toast. htmx - * discards the body of a 4xx unless the response says otherwise, so without these headers the - * user gets no feedback at all. - */ -class DashboardErrorToastTest : WebEndToEndTest() { - - private val email = "author@test.com" - private val password = "password123!@#" - - private suspend fun HttpClient.postForm(path: String, body: String): HttpResponse = - post(route(path)) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody(body) - } - - @Test - fun `a rejected pen name answers with a toast htmx will swap`(): Unit = runBlocking { - doStartServer() - seedWhitelistedAccount(email, password) - val authed = login(email, password) - - val response = authed.postForm("dashboard/penname", "penName=") - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - // The form targets the displayed pen name; an empty error body must not wipe it. - assertEquals("none", response.headers["HX-Reswap"]) - assertContains(response.bodyAsText(), "toast-error") - } - - @Test - fun `a mismatched deletion confirmation answers with a toast htmx will swap`(): Unit = runBlocking { - doStartServer() - seedWhitelistedAccount(email, password) - val authed = login(email, password) - - val response = authed.postForm("dashboard/delete-account", "confirmEmail=someone@else.com") - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - assertContains(response.bodyAsText(), "toast-error") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/HomePageNoticeTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/HomePageNoticeTest.kt deleted file mode 100644 index 93292997a..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/HomePageNoticeTest.kt +++ /dev/null @@ -1,41 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest -import io.ktor.client.HttpClient -import io.ktor.client.request.get -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpStatusCode -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse - -class HomePageNoticeTest : WebEndToEndTest() { - - private val noticeText = "Accounts on this server are by invitation." - - @Test - fun `home page shows the allowed users notice when a contact email is configured`(): Unit = runBlocking { - doStartServer() - seedWhitelistedAccount("admin@test.com", "password123!@#") - database().serverDatabase.serverConfigQueries.upsertConfig("contact_email", "admin@test.com") - - HttpClient().use { web -> - val response = web.get(route("")) - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), noticeText) - } - } - - @Test - fun `home page omits the notice without a contact email`(): Unit = runBlocking { - doStartServer() - seedWhitelistedAccount("admin@test.com", "password123!@#") - - HttpClient().use { web -> - val body = web.get(route("")).bodyAsText() - assertFalse(body.contains(noticeText)) - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/LoginPageSecurityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/LoginPageSecurityTest.kt deleted file mode 100644 index 193e2c23c..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/LoginPageSecurityTest.kt +++ /dev/null @@ -1,100 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest -import io.ktor.client.request.post -import io.ktor.client.request.setBody -import io.ktor.client.statement.HttpResponse -import io.ktor.client.statement.bodyAsText -import io.ktor.http.ContentType -import io.ktor.http.HttpStatusCode -import io.ktor.http.contentType -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import java.net.URLEncoder -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertNull -import kotlin.test.assertTrue - -/** - * The web login form feeds the same security audit trail as the API's - * `/account/login`, and it audits what the server actually allowed: a sign-in the - * whitelist turns away is a failure even though the password was right. - */ -class LoginPageSecurityTest : WebEndToEndTest() { - - private val email = "author@test.com" - private val password = "password123!@#" - - @Test - fun `the web login form records both a successful and a failed attempt`(): Unit = runBlocking { - doStartServer() - seedWhitelistedAccount(email, password, penName = "Test Author") - - login(email, password) - val failed = postLogin(email, "wrong-password") - - assertEquals(HttpStatusCode.OK, failed.status, "A rejected sign-in re-renders the login form") - assertContains(failed.bodyAsText(), "): Unit = runBlocking { - createTestServer(SERVER_EMPTY_NO_WHITELIST, fileSystem, database()) - - // Allowed Users is always enforced, and only the first account (the bootstrap - // admin) is exempt, so every other address has to be on the list to get in. - passwords.indices.forEach { index -> - database().executeAsync( - "INSERT INTO white_list(email, date_added) VALUES ('user$index@example.com', NOW())" - ) - } - - doStartServer() - - val failures = mutableListOf() - - passwords.forEachIndexed { index, (name, password) -> - val email = "user$index@example.com" - - val created = client().post(api("account/create")) { - headers { append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) } - setBody( - FormDataContent( - Parameters.build { - append("email", email) - append("password", password) - append("installId", "fake-install-id") - } - ) - ) - } - if (created.status != HttpStatusCode.Created) { - failures += "$name: create -> ${created.status} ${created.bodyAsText()}" - return@forEachIndexed - } - - val loggedIn = client().post(api("account/login")) { - headers { append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) } - setBody( - FormDataContent( - Parameters.build { - append("email", email) - append("password", password) - append("installId", "fake-install-id") - } - ) - ) - } - if (loggedIn.status != HttpStatusCode.OK) { - failures += "$name (len=${password.length}): login -> ${loggedIn.status} ${loggedIn.bodyAsText()}" - } - } - - assertEquals(emptyList(), failures.toList(), "Round trip failures") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/ProjectsTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/ProjectsTest.kt index 6900fe5fe..db6d9bfcf 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/ProjectsTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/ProjectsTest.kt @@ -365,92 +365,4 @@ class ProjectsTest : EndToEndTest() { assertEquals(HttpStatusCode.OK, endSyncResponse2.status) } } - - @Test - fun `Project Sync - Rename onto a name another project still holds is a conflict`(): Unit = runBlocking { - val database = database() - createTestServer(SERVER_EMPTY_NO_WHITELIST, fileSystem, database) - TestDataSet1.createFullDataset(database, encryptor()) - val userId = 1L - val authToken = createAuthToken(userId, "test-install-id", database = database, tokenHasher = tokenHasher()) - doStartServer() - - client().apply { - val beginSyncResponse = get(api("projects/$userId/begin_sync")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - } - } - assertEquals(HttpStatusCode.OK, beginSyncResponse.status) - val syncId = beginSyncResponse.body().syncId - - val occupiedName = "Occupied Project" - val createResponse = get(api("projects/$userId/create")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - } - parameter("projectName", occupiedName) - } - assertEquals(HttpStatusCode.OK, createResponse.status) - val occupyingProjectId = createResponse.body().projectId - - val renameResponse = get(api("projects/$userId/rename")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - } - parameter("projectId", TestDataSet1.project1.uuid) - parameter("projectName", occupiedName) - } - assertEquals(HttpStatusCode.Conflict, renameResponse.status) - - // Every client sends its device locale, and this key has no translation yet. - val translatedRenameResponse = get(api("projects/$userId/rename")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - append(HttpHeaders.AcceptLanguage, "de") - } - parameter("projectId", TestDataSet1.project1.uuid) - parameter("projectName", occupiedName) - } - assertEquals(HttpStatusCode.Conflict, translatedRenameResponse.status) - - // Freeing the name first is what the client's delete-before-rename ordering guarantees. - val deleteResponse = get(api("projects/$userId/delete")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - } - parameter("projectId", occupyingProjectId.id) - } - assertEquals(HttpStatusCode.OK, deleteResponse.status) - - val retryRenameResponse = get(api("projects/$userId/rename")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - } - parameter("projectId", TestDataSet1.project1.uuid) - parameter("projectName", occupiedName) - } - assertEquals(HttpStatusCode.OK, retryRenameResponse.status) - - val endSyncResponse = get(api("projects/$userId/end_sync")) { - headers { - append(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - append("Authorization", "Bearer ${authToken.auth}") - append(HEADER_SYNC_ID, syncId) - } - } - assertEquals(HttpStatusCode.OK, endSyncResponse.status) - } - } } \ No newline at end of file diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/PublicStoryPageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/PublicStoryPageTest.kt index c8e669b2d..3515ba919 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/PublicStoryPageTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/PublicStoryPageTest.kt @@ -52,81 +52,14 @@ class PublicStoryPageTest : EndToEndTest() { ) } - private fun grantAccess(password: String?, sceneIds: List = emptyList()) { - val queries = database().serverDatabase - val accessId = queries.projectAccessQueries.insertAccessReturningId( + private fun grantAccess(password: String?) { + database().serverDatabase.projectAccessQueries.insertAccess( project_id = projectRowId(), access_password = password, expires_at = null, - ).executeAsOne() - sceneIds.forEach { sceneId -> - queries.projectAccessSceneQueries.insertScene(access_id = accessId, scene_id = sceneId) - } - } - - private fun seedSecondScene() = runBlocking { - E2eTestData.insertEntity( - userId = userId, - projectId = projectRowId(), - entity = E2eTestData.createTestScene(2), - testDatabase = database(), - contentEncryptor = encryptor(), ) } - private fun seedProjectData(content: String) { - database().serverDatabase.projectDataQueries.upsert( - userId = userId, - projectId = projectRowId(), - content = content, - hash = "test-hash", - updatedAt = kotlin.time.Clock.System.now(), - ) - } - - @Test - fun `a story with a declared language is served with that language`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - seedProjectData("""{"language":"fr"}""") - // JSON-LD is only emitted for indexable pages, which require a community author. - database().serverDatabase.accountQueries.updateCommunityMember(community_member = true, id = userId) - - val body = client().get(storyPath()).bodyAsText() - - assertTrue(body.contains(" - // With zero accounts the server is in setup mode: everything redirects to /setup - val dashboard = web.get(route("dashboard")) - assertEquals(HttpStatusCode.Found, dashboard.status) - assertEquals("/setup", dashboard.headers["Location"]) - - val response = web.postSetupForm("admin@test.com", "password123", "password123") - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/admin", response.headers["Location"]) - - val account = database().serverDatabase.accountQueries - .findAccount("admin@test.com").executeAsOne() - assertTrue(account.is_admin) - - // The session cookie set by the POST authorizes the admin dashboard - val admin = web.get(route("admin")) - assertEquals(HttpStatusCode.OK, admin.status) - } - } - } - - @Test - fun `setup mode ends after the first account is created`() { - doStartServer() - - runBlocking { - webClient().use { web -> - val created = web.postSetupForm("admin@test.com", "password123", "password123") - assertEquals(HttpStatusCode.Found, created.status) - - val setupAgain = web.get(route("setup")) - assertEquals(HttpStatusCode.Found, setupAgain.status) - assertEquals("/", setupAgain.headers["Location"]) - - // A stale or double-submitted form is bounced to login, not processed - webClient().use { fresh -> - val resubmit = fresh.postSetupForm("other@test.com", "password123", "password123") - assertEquals(HttpStatusCode.Found, resubmit.status) - assertEquals("/login", resubmit.headers["Location"]) - } - assertNull( - database().serverDatabase.accountQueries - .findAccount("other@test.com").executeAsOneOrNull() - ) - } - } - } - - @Test - fun `mismatched passwords re-render the form with an error and create no account`() { - doStartServer() - - runBlocking { - webClient().use { web -> - val response = web.postSetupForm("admin@test.com", "password123", "different456") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "Passwords do not match") - assertNull( - database().serverDatabase.accountQueries - .findAccount("admin@test.com").executeAsOneOrNull() - ) - } - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/SignupFlowTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/SignupFlowTest.kt deleted file mode 100644 index 4c32da717..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/SignupFlowTest.kt +++ /dev/null @@ -1,84 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest -import io.ktor.client.HttpClient -import io.ktor.client.plugins.cookies.HttpCookies -import io.ktor.client.request.forms.submitForm -import io.ktor.client.request.get -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpStatusCode -import io.ktor.http.parameters -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNull -import kotlin.time.Clock - -class SignupFlowTest : WebEndToEndTest() { - - private fun webClient() = HttpClient { - install(HttpCookies) - followRedirects = false - } - - private suspend fun HttpClient.postSignupForm( - email: String, - password: String, - confirmPassword: String, - ) = submitForm( - url = route("signup"), - formParameters = parameters { - append("email", email) - append("password", password) - append("confirmPassword", confirmPassword) - } - ) - - @Test - fun `an allowed email can self-register and lands on the dashboard`() { - doStartServer() - seedWhitelistedAccount("admin@test.com", "password123!@#") - runBlocking { - database().serverDatabase.whiteListQueries - .addToWhiteList("newbie@test.com", Clock.System.now(), "Test invite", null) - - webClient().use { web -> - val page = web.get(route("signup")) - assertEquals(HttpStatusCode.OK, page.status) - assertContains(page.bodyAsText(), "action=\"/signup\"") - - val response = web.postSignupForm("newbie@test.com", "password123!@#", "password123!@#") - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/dashboard", response.headers["Location"]) - - val account = database().serverDatabase.accountQueries - .findAccount("newbie@test.com").executeAsOne() - assertFalse(account.is_admin, "A self-registered account must not be admin") - - // The session cookie set by the POST authorizes the dashboard - val dashboard = web.get(route("dashboard")) - assertEquals(HttpStatusCode.OK, dashboard.status) - } - } - } - - @Test - fun `a non-allowed email is rejected and no account is created`() { - doStartServer() - seedWhitelistedAccount("admin@test.com", "password123!@#") - runBlocking { - webClient().use { web -> - val response = web.postSignupForm("stranger@test.com", "password123!@#", "password123!@#") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "not allowed on this server") - assertNull( - database().serverDatabase.accountQueries - .findAccount("stranger@test.com").executeAsOneOrNull() - ) - } - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/StoryKudosTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/StoryKudosTest.kt deleted file mode 100644 index 5e66622a0..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/e2e/StoryKudosTest.kt +++ /dev/null @@ -1,265 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e - -import com.darkrockstudios.apps.hammer.e2e.util.E2eTestData -import com.darkrockstudios.apps.hammer.e2e.util.TestProject -import com.darkrockstudios.apps.hammer.e2e.util.WebEndToEndTest -import com.darkrockstudios.apps.hammer.frontend.utils.ProjectName -import com.darkrockstudios.apps.hammer.frontend.utils.SWAP_ERROR_HEADER -import io.ktor.client.HttpClient -import io.ktor.client.request.get -import io.ktor.client.request.header -import io.ktor.client.request.post -import io.ktor.client.request.setBody -import io.ktor.client.statement.HttpResponse -import io.ktor.client.statement.bodyAsText -import io.ktor.http.ContentType -import io.ktor.http.HttpHeaders -import io.ktor.http.HttpStatusCode -import io.ktor.http.contentType -import kotlinx.coroutines.runBlocking -import org.junit.jupiter.api.Test -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.uuid.Uuid - -class StoryKudosTest : WebEndToEndTest() { - - private val authorEmail = "jane@test.com" - private val readerEmail = "reader@test.com" - private val password = "password123!@#" - private val penName = "JaneAuthor" - private val projectNameText = "Insurgency" - private val projectUuid = Uuid.random() - private val segment = ProjectName.projectSegment(projectNameText, projectUuid.toString()) - - private fun storyPath(query: String = ""): String = route("a/$penName/$segment$query") - private fun kudosPath(): String = route("a/$penName/$segment/kudos") - - private fun accountId(email: String): Long = - database().serverDatabase.accountQueries.findAccount(email).executeAsOne().id - - private fun projectRowId(): Long = - database().serverDatabase.projectQueries.findProjectByName(accountId(authorEmail), projectNameText) - .executeAsOne().id - - private fun seedStory() = runBlocking { - seedWhitelistedAccount(authorEmail, password, penName = penName) - seedWhitelistedAccount(readerEmail, password) - val authorId = accountId(authorEmail) - E2eTestData.createProject(TestProject(name = projectNameText, uuid = projectUuid, userId = authorId), database()) - E2eTestData.insertEntity( - userId = authorId, - projectId = projectRowId(), - entity = E2eTestData.createTestScene(1), - testDatabase = database(), - contentEncryptor = encryptor(), - ) - } - - private fun grantAccess(password: String?) { - database().serverDatabase.projectAccessQueries.insertAccess( - project_id = projectRowId(), - access_password = password, - expires_at = null, - ) - } - - private suspend fun HttpClient.getFragment(): HttpResponse = - get(kudosPath()) { header("HX-Request", "true") } - - private suspend fun HttpClient.postPicks(vararg kinds: String): HttpResponse = - post(kudosPath()) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody(kinds.joinToString("&") { "kind=$it" }) - } - - private fun savedPicks(): Set = - database().serverDatabase.storyKudosQueries - .kindsForUser(projectRowId(), accountId(readerEmail)) - .executeAsList().toSet() - - @Test - fun `a public story page loads the kudos section but a private share does not`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = "secret") - val privateShare = client().get(storyPath("?p=secret")).bodyAsText() - assertContains(privateShare, "story-content") - assertFalse(privateShare.contains("story-kudos-slot")) - - grantAccess(password = null) - assertContains(client().get(storyPath()).bodyAsText(), "story-kudos-slot") - } - - @Test - fun `a signed-out reader sees disabled chips and a sign-in prompt`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - val response = client().getFragment() - - assertEquals(HttpStatusCode.OK, response.status) - assertEquals("no-store", response.headers[HttpHeaders.CacheControl]) - val body = response.bodyAsText() - assertContains(body, "story-kudos__signin") - assertContains(body, "fieldset class=\"story-kudos__group\" disabled") - } - - @Test - fun `a signed-in reader's picks are saved and rendered checked`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - login(readerEmail, password).use { reader -> - val response = reader.postPicks("prose", "moved_me") - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "value=\"prose\" checked") - assertContains(body, "value=\"moved_me\" checked") - assertEquals(setOf("prose", "moved_me"), savedPicks()) - - reader.postPicks("plot") - assertEquals(setOf("plot"), savedPicks()) - } - } - - @Test - fun `once four craft chips are picked the rest are locked`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - login(readerEmail, password).use { reader -> - val body = reader.postPicks("prose", "plot", "pacing", "ending").bodyAsText() - - assertContains(body, "value=\"voice\" disabled") - assertContains(body, "value=\"prose\" checked") - assertFalse(body.contains("value=\"prose\" checked disabled")) - assertFalse(body.contains("value=\"moved_me\" disabled")) - } - } - - @Test - fun `over-cap picks are rejected and leave the saved picks alone`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - login(readerEmail, password).use { reader -> - reader.postPicks("prose") - val response = reader.postPicks("prose", "voice", "plot", "pacing", "ending") - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals(setOf("prose"), savedPicks()) - // The rejected state is replaced by the saved one, with an error toast. - val body = response.bodyAsText() - assertContains(body, "value=\"prose\" checked") - assertFalse(body.contains("value=\"voice\" checked")) - assertContains(body, "toast-error") - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - } - } - - @Test - fun `a signed-out post saves nothing and re-renders the sign-in prompt`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - val body = client().postPicks("prose").bodyAsText() - - assertContains(body, "story-kudos__signin") - assertContains(body, "toast-info") - assertFalse(body.contains("value=\"prose\" checked")) - assertEquals(0L, database().serverDatabase.storyKudosQueries.giverCountForProject(projectRowId(), listOf("prose")).executeAsOne()) - } - - @Test - fun `the author sees a note instead of chips and cannot kudo their own story`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - - login(authorEmail, password).use { author -> - val fragment = author.getFragment().bodyAsText() - assertContains(fragment, "story-kudos__note") - assertFalse(fragment.contains("story-kudos__form")) - - assertEquals(HttpStatusCode.Forbidden, author.postPicks("prose").status) - } - } - - @Test - fun `private shares and opted-out stories serve no kudos`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = "secret") - - assertEquals(HttpStatusCode.NoContent, client().getFragment().status) - - grantAccess(password = null) - database().serverDatabase.storyKudosQueries.optOut(projectRowId()) - - assertEquals(HttpStatusCode.NoContent, client().getFragment().status) - login(readerEmail, password).use { reader -> - val response = reader.postPicks("prose") - assertEquals(HttpStatusCode.Conflict, response.status) - assertContains(response.bodyAsText(), "fieldset class=\"story-kudos__group\" disabled") - assertEquals(emptySet(), savedPicks()) - } - } - - @Test - fun `publishing swaps in the kudos panel and a single giver reads singular`(): Unit = runBlocking { - doStartServer() - seedStory() - - login(authorEmail, password).use { author -> - val unpublished = author.get(route("story/$segment")).bodyAsText() - assertContains(unpublished, "id=\"kudos-panel\" hidden") - - val publish = author.post(route("story/$segment/publish")) { header("HX-Request", "true") } - val body = publish.bodyAsText() - assertContains(body, "id=\"kudos-panel\" hx-swap-oob=\"true\"") - assertContains(body, "Let readers leave kudos") - } - - login(readerEmail, password).use { it.postPicks("prose") } - login(authorEmail, password).use { author -> - assertContains(author.get(route("story/$segment")).bodyAsText(), "reader left kudos") - } - } - - @Test - fun `the author can turn kudos off and back on from the story page`(): Unit = runBlocking { - doStartServer() - seedStory() - grantAccess(password = null) - val queries = database().serverDatabase.storyKudosQueries - - login(authorEmail, password).use { author -> - assertContains(author.get(route("story/$segment")).bodyAsText(), "id=\"kudos-panel\"") - - val off = author.post(route("story/$segment/kudos-enabled")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody("") - } - assertEquals(HttpStatusCode.OK, off.status) - assertTrue(queries.isOptedOut(projectRowId()).executeAsOne()) - - author.post(route("story/$segment/kudos-enabled")) { - header("HX-Request", "true") - contentType(ContentType.Application.FormUrlEncoded) - setBody("enabled=true") - } - assertFalse(queries.isOptedOut(projectRowId()).executeAsOne()) - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/AdminSecurityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/AdminSecurityTest.kt index 29ef61a61..4f0c25c13 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/AdminSecurityTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/AdminSecurityTest.kt @@ -5,22 +5,16 @@ import com.darkrockstudios.apps.hammer.account.AccountsRepository import com.darkrockstudios.apps.hammer.admin.WhiteListRepository import com.darkrockstudios.apps.hammer.frontend.data.UserSession import com.darkrockstudios.apps.hammer.frontend.utils.adminOnly -import com.darkrockstudios.apps.hammer.frontend.utils.authenticatedOnly import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin import io.ktor.client.request.cookie import io.ktor.client.request.get -import io.ktor.client.request.header import io.ktor.client.request.post import io.ktor.client.statement.bodyAsText -import io.ktor.htmx.HxRequestHeaders -import io.ktor.htmx.HxResponseHeaders -import io.ktor.http.ContentType import io.ktor.http.HttpStatusCode import io.ktor.http.parseServerSetCookieHeader import io.ktor.server.application.install import io.ktor.server.auth.Authentication -import io.ktor.server.plugins.statuspages.StatusPages import io.ktor.server.response.respondText import io.ktor.server.routing.get import io.ktor.server.routing.post @@ -35,7 +29,6 @@ import io.mockk.coEvery import io.mockk.mockk import org.junit.jupiter.api.Test import org.koin.dsl.module -import kotlin.test.assertContains import kotlin.test.assertEquals import kotlin.time.Clock @@ -56,7 +49,6 @@ class AdminSecurityTest : BaseTest() { bio = null, email_verified = true, community_member = false, - deleted_at = null, ) private fun ApplicationTestBuilder.configureApp() { @@ -96,7 +88,7 @@ class AdminSecurityTest : BaseTest() { @Test fun `cookie claiming admin is denied when the database says not admin`() = testApplication { coEvery { accountRepo.getAccount(7) } returns account(admin = false) - coEvery { whitelistRepo.isOnWhiteList(any()) } returns true + coEvery { whitelistRepo.useWhiteList() } returns false coEvery { accountRepo.isAdmin(7) } returns false configureApp() @@ -109,97 +101,10 @@ class AdminSecurityTest : BaseTest() { assertEquals("/unauthorized", response.headers["Location"]) } - @Test - fun `an htmx request from a non-admin is redirected like any other`() = testApplication { - coEvery { accountRepo.getAccount(7) } returns account(admin = false) - coEvery { whitelistRepo.isOnWhiteList(any()) } returns true - coEvery { accountRepo.isAdmin(7) } returns false - - configureApp() - val noRedirect = createClient { followRedirects = false } - val (name, value) = adminClaimingCookie() - - val response = noRedirect.get("/admin-area") { - cookie(name, value) - header(HxRequestHeaders.Request, "true") - } - - assertEquals(HttpStatusCode.Forbidden, response.status) - assertEquals("/unauthorized", response.headers[HxResponseHeaders.Redirect]) - } - - /** - * StatusPages answers a 401 with the whole unauthorized page, replacing whatever the plugin - * wrote. Redirecting by header rather than by body is what makes the denial survive that, so - * this pins both halves: the page comes back, and the redirect still reaches htmx. - */ - @Test - fun `an htmx request with no session is redirected even though StatusPages rewrites the body`() = - testApplication { - application { - setupKtorTestKoin( - this@AdminSecurityTest, - module { - single { accountRepo } - single { whitelistRepo } - } - ) - install(Sessions) { cookie(COOKIE_USER_SESSION) } - install(Authentication) { frontendAuthentication(accountRepo, whitelistRepo) } - install(StatusPages) { - status(HttpStatusCode.Unauthorized) { call, _ -> - call.respondText( - "FULL-UNAUTHORIZED-PAGE", - ContentType.Text.Html, - HttpStatusCode.Unauthorized - ) - } - } - routing { - authenticatedOnly { - get("/private") { call.respondText("private ok") } - } - } - } - - val noRedirect = createClient { followRedirects = false } - val response = noRedirect.get("/private") { header(HxRequestHeaders.Request, "true") } - - assertEquals(HttpStatusCode.Unauthorized, response.status) - assertEquals("/login", response.headers[HxResponseHeaders.Redirect]) - assertContains(response.bodyAsText(), "FULL-UNAUTHORIZED-PAGE") - } - - @Test - fun `a browser request with no session is redirected to login`() = testApplication { - application { - setupKtorTestKoin( - this@AdminSecurityTest, - module { - single { accountRepo } - single { whitelistRepo } - } - ) - install(Sessions) { cookie(COOKIE_USER_SESSION) } - install(Authentication) { frontendAuthentication(accountRepo, whitelistRepo) } - routing { - authenticatedOnly { - get("/private") { call.respondText("private ok") } - } - } - } - - val noRedirect = createClient { followRedirects = false } - val response = noRedirect.get("/private") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/login", response.headers["Location"]) - } - @Test fun `admin per the database reaches the admin route`() = testApplication { coEvery { accountRepo.getAccount(7) } returns account(admin = true) - coEvery { whitelistRepo.isOnWhiteList(any()) } returns true + coEvery { whitelistRepo.useWhiteList() } returns false coEvery { accountRepo.isAdmin(7) } returns true configureApp() diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FormatSyncDateTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FormatSyncDateTest.kt index 313f37b31..913ef82ca 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FormatSyncDateTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FormatSyncDateTest.kt @@ -2,6 +2,7 @@ package com.darkrockstudios.apps.hammer.frontend import com.darkrockstudios.apps.hammer.frontend.utils.SYNC_DATE_PATTERN import com.darkrockstudios.apps.hammer.frontend.utils.formatInstant +import com.darkrockstudios.apps.hammer.frontend.utils.formatPatreonDate import com.darkrockstudios.apps.hammer.frontend.utils.formatSyncDate import org.junit.jupiter.api.Test import java.time.Month @@ -110,4 +111,11 @@ class FormatSyncDateTest { assertEquals("", result) } + @Test + fun `formatPatreonDate handles ISO 8601 format`() { + val result = formatPatreonDate("2024-03-15T14:30:00Z") + + assertTrue(result.matches(syncDateFormat), "Result was: $result") + assertTrue(result.startsWith(monthShort(Month.MARCH)), "Result was: $result") + } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FrontendAuthenticationTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FrontendAuthenticationTest.kt index fcc7800c8..172a17c3e 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FrontendAuthenticationTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/FrontendAuthenticationTest.kt @@ -39,12 +39,7 @@ class FrontendAuthenticationTest { private val accountRepo: AccountsRepository = mockk() private val whitelistRepo: WhiteListRepository = mockk() - private fun account( - userId: Long, - email: String, - isAdmin: Boolean = false, - deletedAt: kotlin.time.Instant? = null, - ) = Account( + private fun account(userId: Long, email: String, isAdmin: Boolean = false) = Account( id = userId, email = email, password_hash = "hash", @@ -56,7 +51,6 @@ class FrontendAuthenticationTest { bio = null, email_verified = true, community_member = false, - deleted_at = deletedAt, ) private fun ApplicationTestBuilder.configureApp() { @@ -94,6 +88,7 @@ class FrontendAuthenticationTest { @Test fun `non-whitelisted user is challenged when whitelist enabled`() = testApplication { coEvery { accountRepo.getAccount(7) } returns account(7, "user@example.com") + coEvery { whitelistRepo.useWhiteList() } returns true coEvery { whitelistRepo.isOnWhiteList("user@example.com") } returns false configureApp() @@ -109,6 +104,7 @@ class FrontendAuthenticationTest { @Test fun `whitelisted user reaches protected route`() = testApplication { coEvery { accountRepo.getAccount(7) } returns account(7, "user@example.com") + coEvery { whitelistRepo.useWhiteList() } returns true coEvery { whitelistRepo.isOnWhiteList("user@example.com") } returns true configureApp() @@ -124,6 +120,7 @@ class FrontendAuthenticationTest { @Test fun `unknown user id is challenged not server error`() = testApplication { coEvery { accountRepo.getAccount(7) } throws AccountNotFound(7) + coEvery { whitelistRepo.useWhiteList() } returns true configureApp() val noRedirect = createClient { followRedirects = false } @@ -140,6 +137,7 @@ class FrontendAuthenticationTest { @Test fun `session is unauthorized when not whitelisted`() = runBlocking { coEvery { accountRepo.getAccount(7) } returns account(7, "user@example.com") + coEvery { whitelistRepo.useWhiteList() } returns true coEvery { whitelistRepo.isOnWhiteList("user@example.com") } returns false val session = UserSession(userId = 7, username = "user@example.com", isAdmin = false) @@ -149,6 +147,7 @@ class FrontendAuthenticationTest { @Test fun `session is unauthorized when account is missing`() = runBlocking { coEvery { accountRepo.getAccount(7) } throws AccountNotFound(7) + coEvery { whitelistRepo.useWhiteList() } returns true val session = UserSession(userId = 7, username = "user@example.com", isAdmin = false) assertFalse(sessionIsAuthorized(session, accountRepo, whitelistRepo)) @@ -157,33 +156,17 @@ class FrontendAuthenticationTest { @Test fun `admin session bypasses the whitelist`() = runBlocking { coEvery { accountRepo.getAccount(7) } returns account(7, "admin@example.com", isAdmin = true) + coEvery { whitelistRepo.useWhiteList() } returns true coEvery { whitelistRepo.isOnWhiteList("admin@example.com") } returns false val session = UserSession(userId = 7, username = "admin@example.com", isAdmin = true) assertTrue(sessionIsAuthorized(session, accountRepo, whitelistRepo)) } - @Test - fun `session is unauthorized when account is pending deletion`() = runBlocking { - coEvery { accountRepo.getAccount(7) } returns - account(7, "user@example.com", deletedAt = Clock.System.now()) - - val session = UserSession(userId = 7, username = "user@example.com", isAdmin = false) - assertFalse(sessionIsAuthorized(session, accountRepo, whitelistRepo)) - } - - @Test - fun `soft-deleted admin session is unauthorized despite admin bypass`() = runBlocking { - coEvery { accountRepo.getAccount(7) } returns - account(7, "admin@example.com", isAdmin = true, deletedAt = Clock.System.now()) - - val session = UserSession(userId = 7, username = "admin@example.com", isAdmin = true) - assertFalse(sessionIsAuthorized(session, accountRepo, whitelistRepo)) - } - @Test fun `session is authorized when whitelisted`() = runBlocking { coEvery { accountRepo.getAccount(7) } returns account(7, "user@example.com") + coEvery { whitelistRepo.useWhiteList() } returns true coEvery { whitelistRepo.isOnWhiteList("user@example.com") } returns true val session = UserSession(userId = 7, username = "user@example.com", isAdmin = false) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePageTest.kt deleted file mode 100644 index 95d21f9f1..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/HomePageTest.kt +++ /dev/null @@ -1,127 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.admin.AdminServerConfig -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.plugins.configureLocalization -import com.darkrockstudios.apps.hammer.plugins.configureTemplating -import com.darkrockstudios.apps.hammer.utilities.MarkdownService -import com.darkrockstudios.apps.hammer.utils.BaseTest -import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import io.ktor.client.request.get -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpStatusCode -import io.ktor.server.application.install -import io.ktor.server.routing.routing -import io.ktor.server.sessions.Sessions -import io.ktor.server.sessions.cookie -import io.ktor.server.testing.ApplicationTestBuilder -import io.ktor.server.testing.testApplication -import io.mockk.coEvery -import io.mockk.mockk -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse - -class HomePageTest : BaseTest() { - - private val configRepository: ConfigRepository = mockk() - - private fun ApplicationTestBuilder.configureApp() { - application { - setupKtorTestKoin( - this@HomePageTest, - module { - single { configRepository } - } - ) - configureTemplating() - configureLocalization() - install(Sessions) { - cookie(COOKIE_USER_SESSION) - } - routing { - homePage(configRepository, MarkdownService()) - } - } - } - - private fun mockPageModelDependencies(serverMessage: String) { - coEvery { configRepository.get(AdminServerConfig.SERVER_MESSAGE) } returns serverMessage - coEvery { configRepository.get(AdminServerConfig.CONTACT_EMAIL) } returns "" - coEvery { configRepository.get(AdminServerConfig.ABOUT_SERVER) } returns "" - coEvery { configRepository.get(AdminServerConfig.DEFAULT_LOCALE) } returns "en" - } - - private suspend fun ApplicationTestBuilder.getHome() = - createClient { followRedirects = false }.get("/") - - @Test - fun `GET renders a link in the server message as an anchor`() = testApplication { - mockPageModelDependencies("Read the [status page](https://status.example.com) before syncing.") - configureApp() - - val response = getHome() - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "href=\"https://status.example.com\"") - assertContains(body, "status page") - assertFalse(body.contains("[status page]"), "The link syntax is rendered, not shown literally") - } - - @Test - fun `GET renders emphasis in the server message`() = testApplication { - mockPageModelDependencies("Syncing is **down** until _noon_.") - configureApp() - - val body = getHome().bodyAsText() - - assertContains(body, "down") - assertContains(body, "noon") - } - - @Test - fun `GET sanitizes markup authored in the server message`() = testApplication { - mockPageModelDependencies("Careful and [x](javascript:alert(1))") - configureApp() - - val body = getHome().bodyAsText() - - assertFalse(body.contains("alert"), "Script content never reaches the page") - assertFalse(body.contains("javascript:"), "Unsafe link protocols are stripped") - } - - @Test - fun `GET without a server message renders no notice band`() = testApplication { - mockPageModelDependencies("") - configureApp() - - val body = getHome().bodyAsText() - - assertFalse(body.contains("instance-band"), "The band is absent when nothing is configured") - } - - @Test - fun `GET renders no notice band when the whole message sanitizes away`() = testApplication { - mockPageModelDependencies("") - configureApp() - - val body = getHome().bodyAsText() - - assertFalse(body.contains("instance-band"), "An empty band is worse than no band") - } - - @Test - fun `GET offers the iOS app through a smart app banner`() = testApplication { - mockPageModelDependencies("") - configureApp() - - val body = getHome().bodyAsText() - - assertContains(body, "") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringChartLabelsTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringChartLabelsTest.kt deleted file mode 100644 index 82e39edcc..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/MonitoringChartLabelsTest.kt +++ /dev/null @@ -1,71 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.database.ReaderDay -import com.darkrockstudios.apps.hammer.monitoring.DailyActiveUsers -import com.darkrockstudios.apps.hammer.monitoring.TimeSeriesPoint -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import java.time.ZoneId -import java.time.ZoneOffset -import java.util.TimeZone -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertTrue -import kotlin.time.Instant - -/** - * Daily chart buckets are floored to the UTC day upstream, so their labels have to be rendered in - * UTC no matter what zone the server is configured for. Every case here uses a server zone behind - * UTC, where a naive local-zone label would land on the previous date. - */ -class MonitoringChartLabelsTest { - - private lateinit var originalZone: TimeZone - - // UTC midnight, which is Aug 16 in New York. - private val utcDay = Instant.parse("2026-08-17T00:00:00Z") - - @BeforeEach - fun setServerZoneBehindUtc() { - originalZone = TimeZone.getDefault() - TimeZone.setDefault(TimeZone.getTimeZone("America/New_York")) - } - - @AfterEach - fun restoreZone() { - TimeZone.setDefault(originalZone) - } - - @Test - fun `active users chart labels the UTC day`() { - val json = buildActiveUsersChart(listOf(DailyActiveUsers(day = utcDay, sync = 3L, web = 5L))) - - assertTrue(json.contains("Aug 17"), json) - assertFalse(json.contains("Aug 16"), json) - } - - @Test - fun `readers chart labels the UTC day`() { - val json = buildReadersChart(listOf(ReaderDay(day = utcDay, count = 7L))) - - assertTrue(json.contains("Aug 17"), json) - assertFalse(json.contains("Aug 16"), json) - } - - @Test - fun `traffic chart labels the UTC day`() { - val point = TimeSeriesPoint(bucketStart = utcDay, requests = 10L, errors = 1L, p95Ms = 200L) - - val json = buildTrafficChart(listOf(point)) - - assertTrue(json.contains("Aug 17"), json) - assertFalse(json.contains("Aug 16"), json) - } - - @Test - fun `daily buckets are labeled in UTC and hourly buckets in the server zone`() { - assertEquals(ZoneOffset.UTC, chartLabelZone(hourly = false)) - assertEquals(ZoneId.of("America/New_York"), chartLabelZone(hourly = true)) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPageTest.kt deleted file mode 100644 index 810c4a7a2..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SetupPageTest.kt +++ /dev/null @@ -1,234 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.ServerConfig -import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.admin.AdminServerConfig -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.base.http.Token -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT -import com.darkrockstudios.apps.hammer.plugins.configureLocalization -import com.darkrockstudios.apps.hammer.plugins.configureTemplating -import com.darkrockstudios.apps.hammer.projects.ProjectsRepository -import com.darkrockstudios.apps.hammer.utilities.Msg -import com.darkrockstudios.apps.hammer.utilities.SResult -import com.darkrockstudios.apps.hammer.utils.BaseTest -import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import io.ktor.client.request.forms.submitForm -import io.ktor.client.request.get -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpStatusCode -import io.ktor.http.parameters -import io.ktor.server.application.install -import io.ktor.server.plugins.ratelimit.RateLimit -import io.ktor.server.plugins.ratelimit.RateLimitName -import io.ktor.server.routing.routing -import io.ktor.server.sessions.Sessions -import io.ktor.server.sessions.cookie -import io.ktor.server.testing.ApplicationTestBuilder -import io.ktor.server.testing.testApplication -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.mockk -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertNull -import kotlin.time.Duration.Companion.seconds - -class SetupPageTest : BaseTest() { - - private val accountsRepository: AccountsRepository = mockk() - private val projectsRepository: ProjectsRepository = mockk() - private val configRepository: ConfigRepository = mockk() - - private fun ApplicationTestBuilder.configureApp() { - application { - setupKtorTestKoin( - this@SetupPageTest, - module { - single { accountsRepository } - single { projectsRepository } - single { configRepository } - } - ) - configureTemplating() - configureLocalization() - install(RateLimit) { - register(RateLimitName(LOGIN_RATE_LIMIT)) { - rateLimiter(limit = 1_000_000, refillPeriod = 1.seconds) - } - } - install(Sessions) { - cookie(COOKIE_USER_SESSION) - } - routing { - setupPage(ServerConfig()) - } - } - } - - private fun mockPageModelDependencies() { - coEvery { configRepository.get(AdminServerConfig.ABOUT_SERVER) } returns "" - coEvery { configRepository.get(AdminServerConfig.DEFAULT_LOCALE) } returns "en" - } - - private suspend fun ApplicationTestBuilder.postSetupForm( - email: String, - password: String, - confirmPassword: String, - ) = createClient { followRedirects = false }.submitForm( - url = "/setup", - formParameters = parameters { - append("email", email) - append("password", password) - append("confirmPassword", confirmPassword) - } - ) - - @Test - fun `GET renders the admin account form while no users exist`() = testApplication { - coEvery { accountsRepository.hasUsers() } returns false - mockPageModelDependencies() - configureApp() - - val response = createClient { followRedirects = false }.get("/setup") - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "action=\"/setup\"") - assertContains(body, "name=\"email\"") - assertContains(body, "name=\"confirmPassword\"") - } - - @Test - fun `GET redirects home once users exist`() = testApplication { - coEvery { accountsRepository.hasUsers() } returns true - configureApp() - - val response = createClient { followRedirects = false }.get("/setup") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/", response.headers["Location"]) - } - - @Test - fun `POST creates the admin account, sets a session, and redirects to the admin dashboard`() = - testApplication { - val token = Token(userId = 1, auth = "auth", refresh = "refresh") - coEvery { accountsRepository.hasUsers() } returns false - coEvery { - accountsRepository.createAccount("admin@test.com", "web", "password123") - } returns SResult.success(token) - coEvery { projectsRepository.createUserData(1) } returns Unit - coEvery { accountsRepository.isAdmin(1) } returns true - configureApp() - - val response = postSetupForm("admin@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/admin", response.headers["Location"]) - val setCookie = response.headers["Set-Cookie"] - assertNotNull(setCookie) - assertContains(setCookie, COOKIE_USER_SESSION) - coVerify(exactly = 1) { accountsRepository.createAccount("admin@test.com", "web", "password123") } - coVerify(exactly = 1) { projectsRepository.createUserData(1) } - } - - @Test - fun `POST with mismatched passwords re-renders with an error and never creates an account`() = - testApplication { - coEvery { accountsRepository.hasUsers() } returns false - mockPageModelDependencies() - configureApp() - - val response = postSetupForm("admin@test.com", "password123", "different456") - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "Passwords do not match") - assertContains(body, "value=\"admin@test.com\"") - coVerify(exactly = 0) { accountsRepository.createAccount(any(), any(), any()) } - } - - @Test - fun `POST with empty fields re-renders with an error`() = testApplication { - coEvery { accountsRepository.hasUsers() } returns false - mockPageModelDependencies() - configureApp() - - val response = postSetupForm("", "", "") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "Please fill in all fields") - coVerify(exactly = 0) { accountsRepository.createAccount(any(), any(), any()) } - } - - @Test - fun `POST surfaces the repository's invalid email message and skips user data creation`() = - testApplication { - coEvery { accountsRepository.hasUsers() } returns false - coEvery { accountsRepository.createAccount(any(), any(), any()) } returns SResult.failure( - "invalid email", - Msg.r("api_accounts_create_error_invalidemail"), - ) - mockPageModelDependencies() - configureApp() - - val response = postSetupForm("not-an-email", "password123", "password123") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "Invalid e-mail address") - coVerify(exactly = 0) { projectsRepository.createUserData(any()) } - } - - @Test - fun `POST surfaces the repository's short password message`() = testApplication { - coEvery { accountsRepository.hasUsers() } returns false - coEvery { accountsRepository.createAccount(any(), any(), any()) } returns SResult.failure( - "password failure", - Msg.r("api_accounts_create_error_password_tooshort"), - ) - mockPageModelDependencies() - configureApp() - - val response = postSetupForm("admin@test.com", "short", "short") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "Password too short") - } - - @Test - fun `POST after a user already exists redirects to login without creating anything`() = - testApplication { - coEvery { accountsRepository.hasUsers() } returns true - configureApp() - - val response = postSetupForm("admin@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/login", response.headers["Location"]) - assertNull(response.headers["Set-Cookie"]) - coVerify(exactly = 0) { accountsRepository.createAccount(any(), any(), any()) } - } - - @Test - fun `POST that loses the creation race to another account does not grant an admin session`() = - testApplication { - val token = Token(userId = 2, auth = "auth", refresh = "refresh") - coEvery { accountsRepository.hasUsers() } returns false - coEvery { - accountsRepository.createAccount("second@test.com", "web", "password123") - } returns SResult.success(token) - coEvery { projectsRepository.createUserData(2) } returns Unit - coEvery { accountsRepository.isAdmin(2) } returns false - configureApp() - - val response = postSetupForm("second@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/dashboard", response.headers["Location"]) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPageTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPageTest.kt deleted file mode 100644 index 22211dbe7..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SignupPageTest.kt +++ /dev/null @@ -1,340 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend - -import com.darkrockstudios.apps.hammer.account.AccountsComponent -import com.darkrockstudios.apps.hammer.account.AccountsRepository -import com.darkrockstudios.apps.hammer.account.CreateAccountResult -import com.darkrockstudios.apps.hammer.account.TermsOfServiceRepository -import com.darkrockstudios.apps.hammer.admin.AdminServerConfig -import com.darkrockstudios.apps.hammer.admin.ConfigRepository -import com.darkrockstudios.apps.hammer.admin.WhiteListRepository -import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge -import com.darkrockstudios.apps.hammer.base.http.Token -import com.darkrockstudios.apps.hammer.frontend.data.UserSession -import com.darkrockstudios.apps.hammer.monitoring.SecurityRepository -import com.darkrockstudios.apps.hammer.plugins.LOGIN_RATE_LIMIT -import com.darkrockstudios.apps.hammer.plugins.configureLocalization -import com.darkrockstudios.apps.hammer.plugins.configureTemplating -import com.darkrockstudios.apps.hammer.utilities.Msg -import com.darkrockstudios.apps.hammer.utilities.SResult -import com.darkrockstudios.apps.hammer.utils.BaseTest -import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import com.darkrockstudios.apps.hammer.utils.testAccount -import io.ktor.client.request.forms.submitForm -import io.ktor.client.request.cookie -import io.ktor.client.request.get -import io.ktor.client.request.header -import io.ktor.client.request.post -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpHeaders -import io.ktor.http.HttpStatusCode -import io.ktor.http.parameters -import io.ktor.http.parseServerSetCookieHeader -import io.ktor.server.application.install -import io.ktor.server.plugins.ratelimit.RateLimit -import io.ktor.server.plugins.ratelimit.RateLimitName -import io.ktor.server.response.respondText -import io.ktor.server.routing.post -import io.ktor.server.routing.routing -import io.ktor.server.sessions.Sessions -import io.ktor.server.sessions.cookie -import io.ktor.server.sessions.sessions -import io.ktor.server.sessions.set -import io.ktor.server.testing.ApplicationTestBuilder -import io.ktor.server.testing.testApplication -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.every -import io.mockk.mockk -import org.junit.jupiter.api.Test -import org.koin.dsl.module -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNotNull -import kotlin.time.Duration.Companion.seconds - -class SignupPageTest : BaseTest() { - - private val accountsComponent: AccountsComponent = mockk() - private val accountsRepository: AccountsRepository = mockk() - private val whiteListRepository: WhiteListRepository = mockk() - private val termsOfServiceRepository: TermsOfServiceRepository = mockk() - private val configRepository: ConfigRepository = mockk() - private val securityRepository: SecurityRepository = mockk(relaxUnitFun = true) - - private fun ApplicationTestBuilder.configureApp() { - application { - setupKtorTestKoin( - this@SignupPageTest, - module { - single { accountsRepository } - single { configRepository } - } - ) - configureTemplating() - configureLocalization() - install(RateLimit) { - register(RateLimitName(LOGIN_RATE_LIMIT)) { - rateLimiter(limit = 1_000_000, refillPeriod = 1.seconds) - } - } - install(Sessions) { - cookie(COOKIE_USER_SESSION) - } - routing { - signupPage( - accountsComponent, - accountsRepository, - whiteListRepository, - termsOfServiceRepository, - configRepository, - securityRepository, - ) - post("/test-login") { - call.sessions.set( - UserSession(userId = 7, username = "user@example.com", isAdmin = false) - ) - call.respondText("ok") - } - } - } - } - - private fun mockPageModelDependencies(contactEmail: String = "") { - coEvery { configRepository.get(AdminServerConfig.ABOUT_SERVER) } returns "" - coEvery { configRepository.get(AdminServerConfig.DEFAULT_LOCALE) } returns "en" - coEvery { configRepository.get(AdminServerConfig.CONTACT_EMAIL) } returns contactEmail - every { termsOfServiceRepository.challenge() } returns null - } - - private suspend fun ApplicationTestBuilder.postSignupForm( - email: String, - password: String, - confirmPassword: String, - tosAccepted: Boolean = false, - acceptedTosVersion: String? = null, - acceptLanguage: String? = null, - ) = createClient { followRedirects = false }.submitForm( - url = "/signup", - formParameters = parameters { - append("email", email) - append("password", password) - append("confirmPassword", confirmPassword) - if (tosAccepted) append("tosAccepted", "true") - if (acceptedTosVersion != null) append("acceptedTosVersion", acceptedTosVersion) - } - ) { - if (acceptLanguage != null) header(HttpHeaders.AcceptLanguage, acceptLanguage) - } - - @Test - fun `GET renders the signup form without a ToS block when no terms are configured`() = testApplication { - mockPageModelDependencies() - configureApp() - - val response = createClient { followRedirects = false }.get("/signup") - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "action=\"/signup\"") - assertContains(body, "name=\"email\"") - assertContains(body, "name=\"confirmPassword\"") - assertFalse(body.contains("tosAccepted"), "No ToS checkbox without configured terms") - } - - @Test - fun `GET carries no smart app banner outside the home page`() = testApplication { - mockPageModelDependencies() - configureApp() - - val body = createClient { followRedirects = false }.get("/signup").bodyAsText() - - assertFalse(body.contains("apple-itunes-app"), "Only the home page advertises the app") - } - - @Test - fun `GET renders the ToS checkbox and version when terms are configured`() = testApplication { - mockPageModelDependencies() - every { termsOfServiceRepository.challenge() } returns - TermsOfServiceChallenge(text = "Be excellent", version = "v1") - configureApp() - - val body = createClient { followRedirects = false }.get("/signup").bodyAsText() - - assertContains(body, "name=\"tosAccepted\"") - assertContains(body, "name=\"acceptedTosVersion\" value=\"v1\"") - } - - @Test - fun `GET with an authorized session redirects to the dashboard`() = testApplication { - coEvery { accountsRepository.getAccount(7) } returns testAccount() - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true - configureApp() - - val client = createClient { followRedirects = false } - val setCookie = client.post("/test-login").headers["Set-Cookie"]!! - val cookie = parseServerSetCookieHeader(setCookie) - - val response = client.get("/signup") { cookie(cookie.name, cookie.value) } - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/dashboard", response.headers["Location"]) - } - - @Test - fun `POST creates the account, records the attempt, sets a session, and redirects`() = testApplication { - val token = Token(userId = 5, auth = "auth", refresh = "refresh") - mockPageModelDependencies() - coEvery { - accountsComponent.createAccount("writer@test.com", "web", "password123", null) - } returns CreateAccountResult.Success(token) - coEvery { accountsRepository.isAdmin(5) } returns false - configureApp() - - val response = postSignupForm("writer@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.Found, response.status) - assertEquals("/dashboard", response.headers["Location"]) - val setCookie = response.headers["Set-Cookie"] - assertNotNull(setCookie) - assertContains(setCookie, COOKIE_USER_SESSION) - coVerify(exactly = 1) { - securityRepository.recordLoginAttempt("writer@test.com", any(), true) - } - } - - @Test - fun `POST with mismatched passwords re-renders and never reaches the component`() = testApplication { - mockPageModelDependencies() - configureApp() - - val response = postSignupForm("writer@test.com", "password123", "different456") - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "Passwords do not match") - assertContains(body, "value=\"writer@test.com\"") - coVerify(exactly = 0) { accountsComponent.createAccount(any(), any(), any(), any()) } - coVerify(exactly = 0) { securityRepository.recordLoginAttempt(any(), any(), any()) } - } - - @Test - fun `POST with empty fields re-renders with an error`() = testApplication { - mockPageModelDependencies() - configureApp() - - val response = postSignupForm("", "", "") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "Please fill in all fields") - coVerify(exactly = 0) { accountsComponent.createAccount(any(), any(), any(), any()) } - } - - @Test - fun `POST for a not-allowed email re-renders the rejection and records a failed attempt`() = testApplication { - mockPageModelDependencies() - coEvery { - accountsComponent.createAccount("stranger@test.com", "web", "password123", null) - } returns CreateAccountResult.Failure( - SResult.failure( - "User not on whitelist", - Msg.r("api_allowedusers_rejected"), - ) - ) - coEvery { accountsComponent.checkIfWhiteListRejected("stranger@test.com") } returns true - configureApp() - - val response = postSignupForm("stranger@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "not allowed on this server") - coVerify(exactly = 1) { - securityRepository.recordLoginAttempt("stranger@test.com", any(), false) - } - } - - @Test - fun `POST for a not-allowed email falls back to English when the locale lacks the message`() = testApplication { - mockPageModelDependencies() - coEvery { - accountsComponent.createAccount("stranger@test.com", "web", "password123", null) - } returns CreateAccountResult.Failure( - SResult.failure( - "User not on whitelist", - Msg.r("api_allowedusers_rejected"), - ) - ) - coEvery { accountsComponent.checkIfWhiteListRejected("stranger@test.com") } returns true - configureApp() - - // "xx" resolves to the deliberately incomplete test-resource bundle - // (Messages_xx.properties); real locales are kept complete by Crowdin. - val response = postSignupForm( - "stranger@test.com", "password123", "password123", - acceptLanguage = "xx", - ) - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "not allowed on this server") - } - - @Test - fun `POST with configured terms but an unchecked box is blocked before the component`() = testApplication { - mockPageModelDependencies() - every { termsOfServiceRepository.challenge() } returns - TermsOfServiceChallenge(text = "Be excellent", version = "v1") - configureApp() - - val response = postSignupForm("writer@test.com", "password123", "password123") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "must accept the Terms of Service") - coVerify(exactly = 0) { accountsComponent.createAccount(any(), any(), any(), any()) } - } - - @Test - fun `POST with the box checked passes the accepted version to the component`() = testApplication { - val token = Token(userId = 5, auth = "auth", refresh = "refresh") - mockPageModelDependencies() - every { termsOfServiceRepository.challenge() } returns - TermsOfServiceChallenge(text = "Be excellent", version = "v1") - coEvery { - accountsComponent.createAccount("writer@test.com", "web", "password123", "v1") - } returns CreateAccountResult.Success(token) - coEvery { accountsRepository.isAdmin(5) } returns false - configureApp() - - val response = postSignupForm( - "writer@test.com", "password123", "password123", - tosAccepted = true, acceptedTosVersion = "v1", - ) - - assertEquals(HttpStatusCode.Found, response.status) - coVerify(exactly = 1) { - accountsComponent.createAccount("writer@test.com", "web", "password123", "v1") - } - } - - @Test - fun `POST that races a ToS change re-renders carrying the new version`() = testApplication { - mockPageModelDependencies() - every { termsOfServiceRepository.challenge() } returns - TermsOfServiceChallenge(text = "Be excellent, v2 edition", version = "v2") - coEvery { - accountsComponent.createAccount("writer@test.com", "web", "password123", "v1") - } returns CreateAccountResult.TermsRequired( - TermsOfServiceChallenge(text = "Be excellent, v2 edition", version = "v2") - ) - configureApp() - - val response = postSignupForm( - "writer@test.com", "password123", "password123", - tosAccepted = true, acceptedTosVersion = "v1", - ) - - assertEquals(HttpStatusCode.OK, response.status) - val body = response.bodyAsText() - assertContains(body, "must accept the Terms of Service") - assertContains(body, "name=\"acceptedTosVersion\" value=\"v2\"") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SitemapRoutesTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SitemapRoutesTest.kt index d84841ed9..9eb16b3a5 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SitemapRoutesTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/SitemapRoutesTest.kt @@ -4,15 +4,15 @@ import com.darkrockstudios.apps.hammer.ServerConfig import com.darkrockstudios.apps.hammer.database.CommunityAuthor import com.darkrockstudios.apps.hammer.database.CommunityFeedStory import com.darkrockstudios.apps.hammer.frontend.utils.ProjectName -import io.ktor.client.request.* -import io.ktor.http.* -import io.ktor.server.routing.* -import io.ktor.server.testing.* +import io.ktor.client.request.get +import io.ktor.http.HttpStatusCode +import io.ktor.server.routing.routing +import io.ktor.server.testing.testApplication import io.mockk.mockk +import kotlinx.datetime.Instant import org.junit.jupiter.api.Test import kotlin.test.assertContains import kotlin.test.assertEquals -import kotlin.time.Instant class SitemapRoutesTest { diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/MessageBundleParityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/MessageBundleParityTest.kt deleted file mode 100644 index 1296a3b5e..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/MessageBundleParityTest.kt +++ /dev/null @@ -1,118 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend.utils - -import org.junit.jupiter.api.Test -import java.io.File -import java.util.Properties -import kotlin.test.assertTrue -import kotlin.test.fail - -/** - * English is the fallback every other locale resolves through, so a key that is - * looked up but absent from its English bundle throws MissingResourceException at - * request time instead of degrading to untranslated text. Kotlin call sites resolve - * only the default Messages bundle; templates read the msg map, which also merges - * plugin-declared bundles. - * - * Parity is asserted against the keys the server actually references rather than - * against the translation files, which Crowdin owns and which carry strings that - * have outlived their use in the templates. - */ -class MessageBundleParityTest { - - private val kotlinSources = File("src/main/kotlin") - private val templates = File("src/main/resources/templates") - - private val callSitePatterns = listOf( - Regex("""Msg\.r\(\s*"([^"]+)""""), - Regex("""\bmsg\(\s*"([^"]+)""""), - Regex("""\bmsg\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*"([^"]+)""""), - Regex("""localizedMsg\(\s*[^,]+,\s*"([^"]+)""""), - ) - private val templatePattern = Regex("""\{\{[{&]?\s*msg\.([A-Za-z0-9_]+)""") - - private val i18nDir = File("src/main/resources/i18n") - - private fun loadProperties(file: File): Properties { - val properties = Properties() - file.reader(Charsets.UTF_8).use { properties.load(it) } - return properties - } - - private fun englishBundleFiles(): List = - i18nDir.listFiles { f -> f.name.endsWith("_en.properties") }.orEmpty().toList() - - /** Kotlin call sites resolve only the default bundle, so they get no plugin-bundle credit. */ - private fun coreEnglishKeys(): Set = - loadProperties(File(i18nDir, "Messages_en.properties")).stringPropertyNames() - - /** Templates read the msg map, which merges plugin bundles, so the union applies. */ - private fun allEnglishKeys(): Set = - englishBundleFiles().flatMapTo(mutableSetOf()) { loadProperties(it).stringPropertyNames() } - - private fun filesUnder(root: File, extension: String): List = - root.walkTopDown().filter { it.isFile && it.extension == extension }.toList() - - private fun sourceReferences(): Map { - val references = mutableMapOf() - filesUnder(kotlinSources, "kt").forEach { file -> - val text = file.readText() - callSitePatterns.forEach { pattern -> - pattern.findAll(text).forEach { match -> - val key = match.groupValues[1] - // Interpolated keys are assembled at runtime and cannot be resolved here. - if (!key.contains('$')) references.putIfAbsent(key, file.name) - } - } - } - return references - } - - private fun templateReferences(): Map { - val references = mutableMapOf() - filesUnder(templates, "mustache").forEach { file -> - val text = file.readText() - templatePattern.findAll(text).forEach { match -> - references.putIfAbsent(match.groupValues[1], file.name) - } - } - return references - } - - @Test - fun `every referenced message key resolves in English`() { - assertTrue(kotlinSources.isDirectory, "Kotlin sources not found at ${kotlinSources.absolutePath}") - assertTrue(templates.isDirectory, "Templates not found at ${templates.absolutePath}") - - val sourceRefs = sourceReferences() - val templateRefs = templateReferences() - // A regex that quietly stops matching would turn this into a vacuous pass. - val total = sourceRefs.size + templateRefs.size - assertTrue(total > 200, "Only found $total message references; the scan is broken") - - val coreKeys = coreEnglishKeys() - val allKeys = allEnglishKeys() - val missing = sourceRefs.filterKeys { it !in coreKeys } + - templateRefs.filterKeys { it !in allKeys } - - if (missing.isNotEmpty()) { - val report = missing.toSortedMap().entries.joinToString("\n") { (key, source) -> " $key (used by $source)" } - fail( - "The English bundles are the fallback and must carry every key the server looks up.\n" + - "$report\n" + - "If a Crowdin sync rewrote the English source file, restore the dropped keys." - ) - } - } - - @Test - fun `every English key resolves to a non-blank value`() { - val blank = englishBundleFiles().flatMap { file -> - val properties = loadProperties(file) - properties.stringPropertyNames() - .filter { properties.getProperty(it).isNullOrBlank() } - .map { "${file.name}: $it" } - } - - assertTrue(blank.isEmpty(), "English keys with blank values: ${blank.sorted()}") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/RespondInValuePositionTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/RespondInValuePositionTest.kt index b21feb70e..f59f2150f 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/RespondInValuePositionTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/RespondInValuePositionTest.kt @@ -17,15 +17,18 @@ import kotlin.test.assertEquals import kotlin.test.assertTrue /** - * Ktor's `respond*` functions are tail-call suspend functions that return the send pipeline's final - * subject rather than Unit. Before Kotlin 2.4.20 (KT-87499) a respond in *value position*, the last - * expression of an exhaustive `when` with no `else` inside a route handler, made the compiler cast - * that subject to Unit, and the handler died with a ClassCastException once the pipeline suspended. + * Ktor's `respond*` functions are tail-call suspend functions: they return the send pipeline's final + * subject (a `CompressedReadChannelResponse` once Compression has run) rather than Unit. A respond in + * *value position* — the last expression of an exhaustive `when` with no `else` inside a route + * handler — makes the compiler cast that subject to Unit, and the handler dies with a + * ClassCastException once the pipeline suspends. * - * The shape is invisible in source review, so this scans the compiled route handlers for the - * coercion the compiler used to emit (`throwOnFailure` on the resumed value, then `checkcast - * kotlin/Unit`). [valuePositionFixtureRoutes] compiles the shape so the second test can pin the fix: - * if a Kotlin upgrade brings the cast back, it fails there before any real handler does. + * The shape is invisible in source review: adding an `else`, or wrapping in `if/else`, is safe, while + * a trailing `return@post` is not. So this scans the compiled route handlers instead, looking for the + * coercion the compiler emits (`throwOnFailure` on the resumed value, then `checkcast kotlin/Unit`). + * + * [unsafeFixtureRoutes] is a positive control. If a Kotlin upgrade changes this codegen, the detector + * stops firing on the fixture and this test fails rather than silently passing forever. */ class RespondInValuePositionTest { @@ -60,19 +63,18 @@ class RespondInValuePositionTest { } @Test - fun `a respond result in value position is discarded, not cast to Unit`() { + fun `the detector still recognises the unsafe shape`() { assertTrue(testClasses.exists(), "Compiled test classes not found at $testClasses") - val fixture = routeHandlers(testClasses).filter { it.name.contains("valuePositionFixtureRoutes") } - assertTrue( - fixture.isNotEmpty(), - "The fixture route handler was not found. The handler filter has probably stopped matching." - ) + val detected = routeHandlers(testClasses) + .filter { it.coercesResumedValueToUnit() } + .map { it.name } - assertEquals( - emptyList(), fixture.filter { it.coercesResumedValueToUnit() }.map { it.name }, - "The compiler casts a discarded respond result to Unit again (KT-87499), so every exhaustive " + - "`when` that responds from value position is unsafe. Re-derive the pattern from `javap -c`." + assertTrue( + detected.any { it.contains("unsafeFixtureRoutes") }, + "The detector no longer flags the known-unsafe fixture, so it can no longer protect the " + + "main source set. Kotlin's codegen for this shape has likely changed — re-derive the " + + "pattern from `javap -c` before trusting this test again. Flagged: $detected" ) } @@ -111,10 +113,10 @@ private enum class FixtureOutcome { Saved, Rejected } private fun pickOutcome() = FixtureOutcome.Saved /** - * An exhaustive `when` with no `else` whose branches each end in a respond, the shape KT-87499 - * miscompiled. Never registered on a real route; it exists to be compiled. + * Positive control for [RespondInValuePositionTest]: an exhaustive `when` with no `else` whose + * branches each end in a respond. Never registered on a real route — it exists to be compiled. */ -internal fun Route.valuePositionFixtureRoutes() { +internal fun Route.unsafeFixtureRoutes() { post("/fixture") { when (pickOutcome()) { FixtureOutcome.Saved -> respondToast("saved") diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLdTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLdTest.kt index d54328418..46209ac94 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLdTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/SeoJsonLdTest.kt @@ -52,21 +52,6 @@ class SeoJsonLdTest { assertEquals("Jane Doe", obj["author"]!!.jsonObject["name"]!!.jsonPrimitive.content) } - @Test - fun `story article carries inLanguage when set`() { - val obj = parse( - storyArticleJsonLd( - title = "Untitled", - url = "https://hammer.ink/a/x/y", - authorName = "X", - authorUrl = "https://hammer.ink/a/x", - inLanguage = "fr", - ), - ) - - assertEquals("fr", obj["inLanguage"]!!.jsonPrimitive.content) - } - @Test fun `website node carries name and url`() { val obj = parse(webSiteJsonLd(name = "Hammer", url = "https://hammer.ink/", description = "A writing tool.")) @@ -90,7 +75,6 @@ class SeoJsonLdTest { ), ) assertNull(article["wordCount"]) - assertNull(article["inLanguage"]) } @Test diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastResponseTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastResponseTest.kt deleted file mode 100644 index 9a46dd7d1..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/frontend/utils/ToastResponseTest.kt +++ /dev/null @@ -1,156 +0,0 @@ -package com.darkrockstudios.apps.hammer.frontend.utils - -import io.ktor.client.request.get -import io.ktor.client.statement.bodyAsText -import io.ktor.http.HttpStatusCode -import io.ktor.server.routing.get -import io.ktor.server.routing.routing -import io.ktor.server.testing.testApplication -import org.junit.jupiter.api.Test -import kotlin.test.assertContains -import kotlin.test.assertEquals -import kotlin.test.assertNull - -/** - * htmx drops the body of a 4xx response, out-of-band toast and all, so an error toast only reaches - * the user if the response opts back in with [SWAP_ERROR_HEADER]. The client-side handler in - * toast.js keys off exactly what is asserted here. - */ -class ToastResponseTest { - - @Test - fun `a toast-only error response is marked swappable`() = testApplication { - application { - routing { - get("/error-toast") { - respondToast("nope", Toast.Error, HttpStatusCode.BadRequest) - } - } - } - - val response = client.get("/error-toast") - - assertEquals(HttpStatusCode.BadRequest, response.status) - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - assertContains(response.bodyAsText(), "toast-error") - } - - @Test - fun `an error response with no content leaves the target alone`() = testApplication { - application { - routing { - get("/error-toast") { - respondHtmlWithToast( - content = "", - message = "nope", - toast = Toast.Error, - status = HttpStatusCode.BadRequest - ) - } - } - } - - val response = client.get("/error-toast") - - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - assertEquals("none", response.headers["HX-Reswap"]) - } - - @Test - fun `an error response of only whitespace leaves the target alone`() = testApplication { - application { - routing { - get("/error-toast") { - // What a template of all-conditional sections renders to when none of them match. - respondHtmlWithToast( - content = "\n", - message = "nope", - toast = Toast.Error, - status = HttpStatusCode.BadRequest - ) - } - } - } - - val response = client.get("/error-toast") - - assertEquals("none", response.headers["HX-Reswap"]) - } - - @Test - fun `an error response carrying content still swaps into the target`() = testApplication { - application { - routing { - get("/error-toast") { - respondHtmlWithToast( - content = "

    replacement

    ", - message = "nope", - toast = Toast.Error, - status = HttpStatusCode.BadRequest - ) - } - } - } - - val response = client.get("/error-toast") - - assertEquals("true", response.headers[SWAP_ERROR_HEADER]) - assertNull(response.headers["HX-Reswap"]) - assertContains(response.bodyAsText(), "

    replacement

    ") - } - - @Test - fun `successful toast responses are left untouched`() = testApplication { - application { - routing { - get("/ok-toast") { - respondToast("saved", Toast.Success) - } - get("/ok-content") { - respondHtmlWithToast(content = "", message = "saved") - } - } - } - - listOf("/ok-toast", "/ok-content").forEach { path -> - val response = client.get(path) - - assertEquals(HttpStatusCode.OK, response.status, path) - assertNull(response.headers[SWAP_ERROR_HEADER], path) - assertNull(response.headers["HX-Reswap"], path) - } - } - - /** - * The client half of the contract is a string literal in a JS asset, so a rename here would - * leave every Kotlin test passing while error toasts silently stopped appearing again. - */ - @Test - fun `the client keys off the same header name`() { - val script = checkNotNull(javaClass.getResource("/assets/js/toast-logic.js")) { - "toast-logic.js is not on the classpath" - }.readText() - - assertContains(script, "'$SWAP_ERROR_HEADER'") - } - - @Test - fun `rendered template responses carry the toast`() = testApplication { - application { - routing { - get("/template") { - respondTemplateWithToast( - templatePath = "partials/server-notice.mustache", - model = mapOf("hasInstanceNotice" to false), - message = "saved" - ) - } - } - } - - val response = client.get("/template") - - assertEquals(HttpStatusCode.OK, response.status) - assertContains(response.bodyAsText(), "toast-success") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepositoryTest.kt deleted file mode 100644 index 999a13b3b..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/kudos/StoryKudosRepositoryTest.kt +++ /dev/null @@ -1,184 +0,0 @@ -package com.darkrockstudios.apps.hammer.kudos - -import com.darkrockstudios.apps.hammer.database.AccountDao -import com.darkrockstudios.apps.hammer.database.StoryKudosDao -import com.darkrockstudios.apps.hammer.database.UserDataPurgeDao -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.kudos.KudosKind.CHARACTERS -import com.darkrockstudios.apps.hammer.kudos.KudosKind.DIALOGUE -import com.darkrockstudios.apps.hammer.kudos.KudosKind.ENDING -import com.darkrockstudios.apps.hammer.kudos.KudosKind.MADE_ME_LAUGH -import com.darkrockstudios.apps.hammer.kudos.KudosKind.MADE_ME_THINK -import com.darkrockstudios.apps.hammer.kudos.KudosKind.MOVED_ME -import com.darkrockstudios.apps.hammer.kudos.KudosKind.PLOT -import com.darkrockstudios.apps.hammer.kudos.KudosKind.PROSE -import com.darkrockstudios.apps.hammer.utils.BaseTest -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import java.io.File -import java.util.Properties -import kotlin.test.assertEquals -import kotlin.test.assertTrue -import kotlin.time.Clock -import kotlin.uuid.Uuid - -class StoryKudosRepositoryTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private lateinit var accountDao: AccountDao - private lateinit var repo: StoryKudosRepository - - private var authorId = 0L - private var projectId = 0L - private val readers = mutableListOf() - - @BeforeEach - override fun setup() { - super.setup() - db = SharedPostgresTestDatabase() - db.initialize() - setupKoin() - - accountDao = AccountDao(db) - repo = StoryKudosRepository(StoryKudosDao(db)) - - readers.clear() - authorId = createAccount("author@example.com") - repeat(4) { i -> readers += createAccount("reader$i@example.com") } - projectId = createProject(authorId, "Insurgency") - } - - private fun createAccount(email: String): Long { - val queries = db.serverDatabase.accountQueries - queries.createAccount(email, "hash", "secret", false) - return queries.findAccount(email).executeAsOne().id - } - - private fun createProject(userId: Long, name: String): Long { - val queries = db.serverDatabase.projectQueries - queries.createProject(userId = userId, name = name, uuid = Uuid.random().toString()) - return queries.findProjectByName(userId, name).executeAsOne().id - } - - private suspend fun pick(readerId: Long, vararg kinds: KudosKind): SetPicksResult = - repo.setPicks(projectId, authorId, readerId, kinds.toSet()) - - @Test - fun `a new pick set replaces the previous one`() = runTest { - val reader = readers[0] - pick(reader, PROSE, PLOT, MOVED_ME) - pick(reader, PROSE, ENDING) - - assertEquals(setOf(PROSE, ENDING), repo.picksFor(projectId, reader)) - } - - @Test - fun `craft picks are capped at four`() = runTest { - val reader = readers[0] - - assertTrue(pick(reader, PROSE, PLOT, ENDING, DIALOGUE) is SetPicksResult.Saved) - assertEquals(SetPicksResult.OverCap, pick(reader, PROSE, PLOT, ENDING, DIALOGUE, CHARACTERS)) - assertEquals(setOf(PROSE, PLOT, ENDING, DIALOGUE), repo.picksFor(projectId, reader)) - } - - @Test - fun `picking a second reaction swaps it in for the first`() = runTest { - val reader = readers[0] - pick(reader, PROSE, MOVED_ME) - - val result = pick(reader, PROSE, MOVED_ME, MADE_ME_LAUGH) - - assertEquals(SetPicksResult.Saved(setOf(PROSE, MADE_ME_LAUGH)), result) - assertEquals(setOf(PROSE, MADE_ME_LAUGH), repo.picksFor(projectId, reader)) - } - - @Test - fun `two brand new reactions at once are rejected`() = runTest { - assertEquals(SetPicksResult.OverCap, pick(readers[0], MOVED_ME, MADE_ME_LAUGH)) - } - - @Test - fun `an author cannot give kudos to their own story`() = runTest { - assertEquals(SetPicksResult.OwnStory, repo.setPicks(projectId, authorId, authorId, setOf(PROSE))) - assertEquals(0L, repo.tally(projectId).givers) - } - - @Test - fun `an opted-out story accepts no kudos until re-enabled`() = runTest { - repo.setEnabled(projectId, enabled = false) - assertEquals(SetPicksResult.Disabled, pick(readers[0], PROSE)) - - repo.setEnabled(projectId, enabled = true) - assertTrue(pick(readers[0], PROSE) is SetPicksResult.Saved) - } - - @Test - fun `public highlights need three readers and are ranked by count`() = runTest { - pick(readers[0], PROSE, PLOT, MOVED_ME) - pick(readers[1], PROSE, PLOT, MOVED_ME) - pick(readers[2], PROSE, PLOT, MADE_ME_THINK) - pick(readers[3], PROSE, ENDING) - - val tally = repo.tally(projectId) - - assertEquals(4L, tally.givers) - assertEquals(listOf(PROSE, PLOT), tally.publicHighlights(KudosGroup.CRAFT)) - assertEquals(emptyList(), tally.publicHighlights(KudosGroup.REACTION)) - assertEquals( - listOf(MOVED_ME to 2L, MADE_ME_THINK to 1L), - tally.ranked(KudosGroup.REACTION), - ) - } - - @Test - fun `soft-deleted givers drop out of the tally`() = runTest { - pick(readers[0], PROSE) - pick(readers[1], PROSE) - accountDao.markDeleted(readers[1], Clock.System.now()) - - val tally = repo.tally(projectId) - - assertEquals(1L, tally.givers) - assertEquals(mapOf(PROSE to 1L), tally.counts) - } - - @Test - fun `stored keys that are no longer chips are ignored`() = runTest { - db.serverDatabase.storyKudosQueries.insertKudos(projectId, readers[0], "twist") - pick(readers[1], PROSE) - - val tally = repo.tally(projectId) - assertEquals(mapOf(PROSE to 1L), tally.counts) - assertEquals(1L, tally.givers) - assertEquals(emptySet(), repo.picksFor(projectId, readers[0])) - } - - @Test - fun `purging an account removes kudos it gave and kudos on its stories`() = runTest { - val otherProject = createProject(readers[0], "Reader's Story") - pick(readers[0], PROSE) - repo.setPicks(otherProject, readers[0], readers[1], setOf(PLOT)) - repo.setEnabled(otherProject, enabled = false) - - accountDao.markDeleted(readers[0], Clock.System.now()) - UserDataPurgeDao(db).purgeUserData(readers[0]) - - val remaining = db.serverDatabase.storyKudosQueries - assertEquals(emptySet(), remaining.kindsForUser(projectId, readers[0]).executeAsList().toSet()) - assertEquals(emptySet(), remaining.kindsForUser(otherProject, readers[1]).executeAsList().toSet()) - assertEquals(false, remaining.isOptedOut(otherProject).executeAsOne()) - } - - @Test - fun `every chip has a stable short key and an English label`() { - val english = Properties().apply { - File("src/main/resources/i18n/Messages_en.properties").reader(Charsets.UTF_8).use { load(it) } - } - val keys = KudosKind.entries.map { it.key } - - assertEquals(keys.size, keys.toSet().size) - assertTrue(keys.all { it.length in 1..32 }) - assertEquals(emptyList(), KudosKind.entries.filter { english.getProperty(it.messageKey) == null }) - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringAlertTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringAlertTest.kt index 4245f5c95..a7edab686 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringAlertTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringAlertTest.kt @@ -54,12 +54,7 @@ class MonitoringAlertTest : BaseTest() { configRepository = ConfigRepository(ServerConfigDao(db)), metricsRepository = MetricsRepository(ApiMetricDao(db)), errorRepository = errorRepository, - securityRepository = SecurityRepository( - LoginAttemptDao(db), - MonitoringState(), - LoggerFactory.getLogger("test"), - clock, - ), + securityRepository = SecurityRepository(LoginAttemptDao(db), clock), collector = MetricsCollector(clock), userActivityCollector = UserActivityCollector(clock), userActivityRepository = UserActivityRepository(UserActivityDao(db)), diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringExportRouteTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringExportRouteTest.kt index feda3540c..8778dbe76 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringExportRouteTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringExportRouteTest.kt @@ -63,6 +63,8 @@ class MonitoringExportRouteTest { projectsSyncManager = mockk>(relaxed = true), projectSyncManager = mockk>(relaxed = true), clock = clock, + patreonFeatureEnabled = false, + emailFeatureEnabled = false, ) } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringIgnoreRouteTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringIgnoreRouteTest.kt index 5782b0ed4..89f9ab8a8 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringIgnoreRouteTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringIgnoreRouteTest.kt @@ -63,6 +63,8 @@ class MonitoringIgnoreRouteTest : BaseTest() { relaxed = true ), clock = clock, + patreonFeatureEnabled = false, + emailFeatureEnabled = false, ) } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringMaintenanceJobLifecycleTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringMaintenanceJobLifecycleTest.kt index 6d81edca5..fa1c8384e 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringMaintenanceJobLifecycleTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/MonitoringMaintenanceJobLifecycleTest.kt @@ -111,12 +111,7 @@ class MonitoringMaintenanceJobLifecycleTest { configRepository = configRepository, metricsRepository = MetricsRepository(ApiMetricDao(db)), errorRepository = ErrorRepository(ErrorLogDao(db), clock), - securityRepository = SecurityRepository( - LoginAttemptDao(db), - MonitoringState(), - LoggerFactory.getLogger("test"), - clock, - ), + securityRepository = SecurityRepository(LoginAttemptDao(db), clock), collector = MetricsCollector(clock), userActivityCollector = UserActivityCollector(clock), userActivityRepository = UserActivityRepository(UserActivityDao(db)), diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityAlertEmailTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityAlertEmailTest.kt index 618f29e64..5be527c1f 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityAlertEmailTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityAlertEmailTest.kt @@ -49,12 +49,7 @@ class SecurityAlertEmailTest : BaseTest() { } private fun job(email: FakeEmailService): Pair { - val securityRepository = SecurityRepository( - LoginAttemptDao(db), - MonitoringState(), - LoggerFactory.getLogger("test"), - clock, - ) + val securityRepository = SecurityRepository(LoginAttemptDao(db), clock) val maintenance = MonitoringMaintenanceJob( configRepository = ConfigRepository(ServerConfigDao(db)), metricsRepository = MetricsRepository(ApiMetricDao(db)), diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepositoryTest.kt deleted file mode 100644 index 01d09d372..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/SecurityRepositoryTest.kt +++ /dev/null @@ -1,68 +0,0 @@ -package com.darkrockstudios.apps.hammer.monitoring - -import com.darkrockstudios.apps.hammer.database.LoginAttemptDao -import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase -import com.darkrockstudios.apps.hammer.utils.BaseTest -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test -import org.slf4j.LoggerFactory -import kotlin.test.assertEquals -import kotlin.test.assertNull -import kotlin.time.Clock - -/** - * The monitoring toggles are enforced by the repository, so every login route - * honors them without repeating the checks. - */ -class SecurityRepositoryTest : BaseTest() { - - private lateinit var db: SharedPostgresTestDatabase - private val clock = Clock.System - - @BeforeEach - override fun setup() { - super.setup() - db = SharedPostgresTestDatabase() - db.initialize() - setupKoin() - } - - private fun repository(config: MonitoringConfig): SecurityRepository { - val state = MonitoringState().apply { update(config) } - return SecurityRepository(LoginAttemptDao(db), state, LoggerFactory.getLogger("test"), clock) - } - - private fun recorded() = db.serverDatabase.loginAttemptQueries.getRecentAttempts(10, 0).executeAsList() - - @Test - fun `login tracking off records nothing`() = runTest { - repository(MonitoringConfig(enabled = true, trackLoginAttempts = false)) - .recordLoginAttempt("author@test.com", "203.0.113.7", success = false) - - assertEquals(0, recorded().size) - } - - @Test - fun `storing IPs off keeps the attempt but drops the address`() = runTest { - repository(MonitoringConfig(enabled = true, trackLoginAttempts = true, storeLoginIp = false)) - .recordLoginAttempt("author@test.com", "203.0.113.7", success = false) - - val attempt = recorded().single() - assertEquals("author@test.com", attempt.email) - assertNull(attempt.ip_address, "The operator disabled IP capture") - } - - @Test - fun `emails are lower-cased and blank ones stored as null`() = runTest { - val repository = repository(MonitoringConfig(enabled = true, trackLoginAttempts = true)) - - repository.recordLoginAttempt(" Author@Test.com ", null, success = true) - repository.recordLoginAttempt(" ", null, success = false) - - val attempts = recorded() - assertEquals(2, attempts.size) - assertEquals("author@test.com", attempts.single { it.success }.email) - assertNull(attempts.single { !it.success }.email, "Blank emails must not become an empty-string account") - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/UserActivityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/UserActivityTest.kt index c08e9be86..94d388fe9 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/UserActivityTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/monitoring/UserActivityTest.kt @@ -159,12 +159,7 @@ class UserActivityTest : BaseTest() { configRepository = configRepository, metricsRepository = MetricsRepository(ApiMetricDao(db)), errorRepository = ErrorRepository(ErrorLogDao(db), clock), - securityRepository = SecurityRepository( - LoginAttemptDao(db), - MonitoringState(), - LoggerFactory.getLogger("test"), - clock, - ), + securityRepository = SecurityRepository(LoginAttemptDao(db), clock), collector = MetricsCollector(clock), userActivityCollector = collector, userActivityRepository = repository, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClientTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClientTest.kt new file mode 100644 index 000000000..ca8fbbf67 --- /dev/null +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonApiClientTest.kt @@ -0,0 +1,131 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.utils.BaseTest +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.slf4j.LoggerFactory +import kotlin.test.assertFalse +import kotlin.test.assertTrue + +class PatreonApiClientTest : BaseTest() { + + private lateinit var client: PatreonApiClient + private val logger = LoggerFactory.getLogger(PatreonApiClientTest::class.java) + + @BeforeEach + override fun setup() { + super.setup() + client = PatreonApiClient(logger) + } + + @Test + fun `verify valid webhook signature`() { + val payload = """{"data":{"id":"123"}}""" + val secret = "test-webhook-secret" + + // Compute expected signature using HmacMD5 + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + val expectedSignature = hash.joinToString("") { "%02x".format(it) } + + val result = client.verifyWebhookSignature(payload, expectedSignature, secret) + + assertTrue(result) + } + + @Test + fun `reject invalid webhook signature`() { + val payload = """{"data":{"id":"123"}}""" + val secret = "test-webhook-secret" + val invalidSignature = "invalid-signature-12345" + + val result = client.verifyWebhookSignature(payload, invalidSignature, secret) + + assertFalse(result) + } + + @Test + fun `reject tampered payload`() { + val originalPayload = """{"data":{"id":"123"}}""" + val tamperedPayload = """{"data":{"id":"456"}}""" + val secret = "test-webhook-secret" + + // Compute signature for original payload + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(originalPayload.toByteArray()) + val originalSignature = hash.joinToString("") { "%02x".format(it) } + + // Verify with tampered payload should fail + val result = client.verifyWebhookSignature(tamperedPayload, originalSignature, secret) + + assertFalse(result) + } + + @Test + fun `reject wrong secret`() { + val payload = """{"data":{"id":"123"}}""" + val correctSecret = "correct-secret" + val wrongSecret = "wrong-secret" + + // Compute signature with correct secret + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(correctSecret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + val signature = hash.joinToString("") { "%02x".format(it) } + + // Verify with wrong secret should fail + val result = client.verifyWebhookSignature(payload, signature, wrongSecret) + + assertFalse(result) + } + + @Test + fun `signature verification is case insensitive`() { + val payload = """{"data":{"id":"123"}}""" + val secret = "test-webhook-secret" + + // Compute expected signature + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + val lowerCaseSignature = hash.joinToString("") { "%02x".format(it) } + val upperCaseSignature = lowerCaseSignature.uppercase() + + // Both should verify successfully + assertTrue(client.verifyWebhookSignature(payload, lowerCaseSignature, secret)) + assertTrue(client.verifyWebhookSignature(payload, upperCaseSignature, secret)) + } + + @Test + fun `empty payload signature verification`() { + val payload = "" + val secret = "test-webhook-secret" + + // Compute expected signature for empty payload + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + val expectedSignature = hash.joinToString("") { "%02x".format(it) } + + val result = client.verifyWebhookSignature(payload, expectedSignature, secret) + + assertTrue(result) + } + + @Test + fun `empty signature returns false`() { + val payload = """{"data":{"id":"123"}}""" + val secret = "test-webhook-secret" + + val result = client.verifyWebhookSignature(payload, "", secret) + + assertFalse(result) + } +} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncServiceTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncServiceTest.kt new file mode 100644 index 000000000..439a37477 --- /dev/null +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonSyncServiceTest.kt @@ -0,0 +1,314 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.Account +import com.darkrockstudios.apps.hammer.account.AccountsRepository +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.admin.WhiteListRepository +import com.darkrockstudios.apps.hammer.database.ServerConfigDao +import com.darkrockstudios.apps.hammer.database.WhiteListDao +import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase +import com.darkrockstudios.apps.hammer.utils.BaseTest +import com.darkrockstudios.apps.hammer.utils.TestClock +import io.mockk.coEvery +import io.mockk.coVerify +import io.mockk.mockk +import kotlinx.coroutines.test.runTest +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.slf4j.LoggerFactory +import kotlin.test.assertEquals +import kotlin.test.assertFalse +import kotlin.test.assertIs +import kotlin.test.assertTrue +import kotlin.time.Clock +import kotlin.time.Instant + +class PatreonSyncServiceTest : BaseTest() { + + private lateinit var db: SharedPostgresTestDatabase + private lateinit var whiteListDao: WhiteListDao + private lateinit var configDao: ServerConfigDao + private lateinit var configRepository: ConfigRepository + private lateinit var whiteListRepository: WhiteListRepository + private lateinit var clock: TestClock + private lateinit var patreonApiClient: PatreonApiClient + private lateinit var accountsRepository: AccountsRepository + private val logger = LoggerFactory.getLogger(PatreonSyncServiceTest::class.java) + + @BeforeEach + override fun setup() { + super.setup() + + db = SharedPostgresTestDatabase() + db.initialize() + whiteListDao = WhiteListDao(db) + configDao = ServerConfigDao(db) + configRepository = ConfigRepository(configDao) + clock = TestClock(Clock.System) + whiteListRepository = WhiteListRepository(whiteListDao, configRepository, clock) + patreonApiClient = mockk() + accountsRepository = mockk() + + setupKoin() + } + + private fun createSyncService() = PatreonSyncService( + patreonApiClient = patreonApiClient, + whiteListRepository = whiteListRepository, + accountsRepository = accountsRepository, + configRepository = configRepository, + clock = clock, + logger = logger + ) + + private suspend fun enablePatreon( + campaignId: String = "test-campaign", + accessToken: String = "test-token", + minimumAmountCents: Int = 500 + ) { + val config = PatreonConfig( + enabled = true, + campaignId = campaignId, + creatorAccessToken = accessToken, + minimumAmountCents = minimumAmountCents + ) + configRepository.set(AdminServerConfig.PATREON_CONFIG, config) + } + + @Test + fun `sync skipped when disabled`() = runTest { + // Patreon disabled by default + val service = createSyncService() + + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(0, result.getOrThrow().added) + assertEquals(0, result.getOrThrow().removed) + } + + @Test + fun `sync fails when missing campaign ID`() = runTest { + val config = PatreonConfig(enabled = true, campaignId = "", creatorAccessToken = "token") + configRepository.set(AdminServerConfig.PATREON_CONFIG, config) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isFailure) + assertIs(result.exceptionOrNull()) + } + + @Test + fun `new patron joins - added to whitelist`() = runTest { + enablePatreon() + + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(listOf("patron@example.com")) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(1, result.getOrThrow().added) + assertTrue(whiteListRepository.isOnWhiteList("patron@example.com")) + + // Verify reason is "Patreon" + val entries = whiteListRepository.getWhiteListByReason(PatreonSyncService.WHITELIST_REASON) + assertEquals(1, entries.size) + assertEquals("patron@example.com", entries[0].email) + } + + @Test + fun `existing patron with different reason - not modified`() = runTest { + // Add user to whitelist with different reason + whiteListRepository.addToWhiteList("betatester@example.com", "Beta tester") + + enablePatreon() + + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(listOf("betatester@example.com")) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(0, result.getOrThrow().added) + assertEquals(1, result.getOrThrow().skipped) + + // Verify reason is still "Beta tester" + val entries = whiteListRepository.getWhiteListByReason("Beta tester") + assertEquals(1, entries.size) + assertEquals("betatester@example.com", entries[0].email) + + // Verify no Patreon entries + val patreonEntries = whiteListRepository.getWhiteListByReason(PatreonSyncService.WHITELIST_REASON) + assertEquals(0, patreonEntries.size) + } + + @Test + fun `patron unsubscribes - removed from whitelist and logged out`() = runTest { + // Add user as Patreon member + whiteListRepository.addToWhiteList("lapsed@example.com", PatreonSyncService.WHITELIST_REASON) + + enablePatreon() + + // Patron is no longer in the API response + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(emptyList()) + + coEvery { accountsRepository.forceLogout("lapsed@example.com") } returns true + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(1, result.getOrThrow().removed) + assertFalse(whiteListRepository.isOnWhiteList("lapsed@example.com")) + + // Verify force logout was called + coVerify { accountsRepository.forceLogout("lapsed@example.com") } + } + + @Test + fun `non-Patreon user unaffected when not in API`() = runTest { + // Add user with non-Patreon reason + whiteListRepository.addToWhiteList("friend@example.com", "Friend") + + enablePatreon() + + // Friend is not in Patreon API (they're not a patron) + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(emptyList()) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(0, result.getOrThrow().removed) + + // Friend should still be on whitelist + assertTrue(whiteListRepository.isOnWhiteList("friend@example.com")) + } + + @Test + fun `sync with no changes`() = runTest { + // Add existing Patreon member + whiteListRepository.addToWhiteList("patron@example.com", PatreonSyncService.WHITELIST_REASON) + + enablePatreon() + + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(listOf("patron@example.com")) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(0, result.getOrThrow().added) + assertEquals(0, result.getOrThrow().removed) + } + + @Test + fun `force logout works`() = runTest { + coEvery { accountsRepository.forceLogout("user@example.com") } returns true + + val service = createSyncService() + service.forceLogout("user@example.com") + + coVerify { accountsRepository.forceLogout("user@example.com") } + } + + @Test + fun `force logout handles missing account gracefully`() = runTest { + coEvery { accountsRepository.forceLogout("nonexistent@example.com") } returns false + + val service = createSyncService() + // Should not throw + service.forceLogout("nonexistent@example.com") + } + + @Test + fun `email normalization works`() = runTest { + enablePatreon() + + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(listOf(" PATRON@EXAMPLE.COM ")) + + val service = createSyncService() + val result = service.performFullSync() + + assertTrue(result.isSuccess) + assertEquals(1, result.getOrThrow().added) + + // Should be normalized to lowercase + assertTrue(whiteListRepository.isOnWhiteList("patron@example.com")) + } + + @Test + fun `last sync time is updated`() = runTest { + enablePatreon() + + coEvery { + patreonApiClient.fetchAllQualifyingMembers("test-campaign", "test-token", 500) + } returns Result.success(emptyList()) + + val service = createSyncService() + service.performFullSync() + + val config = configRepository.get(AdminServerConfig.PATREON_CONFIG) + assertEquals(clock.now().toString(), config.lastSync) + } + + @Test + fun `patron count returns correct value`() = runTest { + whiteListRepository.addToWhiteList("patron1@example.com", PatreonSyncService.WHITELIST_REASON) + whiteListRepository.addToWhiteList("patron2@example.com", PatreonSyncService.WHITELIST_REASON) + whiteListRepository.addToWhiteList("friend@example.com", "Friend") + + val service = createSyncService() + val count = service.getPatreonWhitelistCount() + + assertEquals(2L, count) + } + + @Test + fun `patron with accounts count returns correct value`() = runTest { + // Add patrons to whitelist + whiteListRepository.addToWhiteList("patron1@example.com", PatreonSyncService.WHITELIST_REASON) + whiteListRepository.addToWhiteList("patron2@example.com", PatreonSyncService.WHITELIST_REASON) + whiteListRepository.addToWhiteList("patron3@example.com", PatreonSyncService.WHITELIST_REASON) + whiteListRepository.addToWhiteList("friend@example.com", "Friend") + + // Create accounts for only some of the patrons + db.serverDatabase.accountQueries.testInsertAccount( + email = "patron1@example.com", + password_hash = "hash", + cipher_secret = "secret", + is_admin = false, + created = Instant.parse("2024-01-01T00:00:00Z"), + last_sync = Instant.parse("2024-01-01T00:00:00Z") + ) + db.serverDatabase.accountQueries.testInsertAccount( + email = "patron3@example.com", + password_hash = "hash", + cipher_secret = "secret", + is_admin = false, + created = Instant.parse("2024-01-01T00:00:00Z"), + last_sync = Instant.parse("2024-01-01T00:00:00Z") + ) + + val service = createSyncService() + val count = service.getPatreonMembersWithAccountsCount() + + // Only patron1 and patron3 have accounts (patron2 doesn't, friend is not a Patreon member) + assertEquals(2L, count) + } +} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandlerTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandlerTest.kt new file mode 100644 index 000000000..8e7bd2e97 --- /dev/null +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/patreon/PatreonWebhookHandlerTest.kt @@ -0,0 +1,271 @@ +package com.darkrockstudios.apps.hammer.patreon + +import com.darkrockstudios.apps.hammer.admin.AdminServerConfig +import com.darkrockstudios.apps.hammer.admin.ConfigRepository +import com.darkrockstudios.apps.hammer.database.ServerConfigDao +import com.darkrockstudios.apps.hammer.e2e.util.SharedPostgresTestDatabase +import com.darkrockstudios.apps.hammer.utils.BaseTest +import io.mockk.coEvery +import io.mockk.coVerify +import io.mockk.every +import io.mockk.mockk +import kotlinx.coroutines.test.runTest +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.Test +import org.slf4j.LoggerFactory +import kotlin.test.assertEquals +import kotlin.test.assertTrue + +class PatreonWebhookHandlerTest : BaseTest() { + + private lateinit var db: SharedPostgresTestDatabase + private lateinit var configDao: ServerConfigDao + private lateinit var configRepository: ConfigRepository + private lateinit var patreonApiClient: PatreonApiClient + private lateinit var patreonSyncService: PatreonSyncService + private val logger = LoggerFactory.getLogger(PatreonWebhookHandlerTest::class.java) + + @BeforeEach + override fun setup() { + super.setup() + + db = SharedPostgresTestDatabase() + db.initialize() + configDao = ServerConfigDao(db) + configRepository = ConfigRepository(configDao) + patreonApiClient = mockk() + patreonSyncService = mockk() + + setupKoin() + } + + private fun createHandler() = PatreonWebhookHandler( + patreonApiClient = patreonApiClient, + patreonSyncService = patreonSyncService, + configRepository = configRepository, + logger = logger + ) + + private suspend fun enablePatreon( + webhookSecret: String = "test-secret" + ) { + val config = PatreonConfig( + enabled = true, + campaignId = "test-campaign", + creatorAccessToken = "test-token", + webhookSecret = webhookSecret, + minimumAmountCents = 500 + ) + configRepository.set(AdminServerConfig.PATREON_CONFIG, config) + } + + private fun computeSignature(payload: String, secret: String): String { + val mac = javax.crypto.Mac.getInstance("HmacMD5") + val secretKey = javax.crypto.spec.SecretKeySpec(secret.toByteArray(), "HmacMD5") + mac.init(secretKey) + val hash = mac.doFinal(payload.toByteArray()) + return hash.joinToString("") { "%02x".format(it) } + } + + @Test + fun `returns Disabled when Patreon integration is disabled`() = runTest { + // Patreon disabled by default + val handler = createHandler() + + val result = handler.handleWebhook( + payload = """{"data":{}}""", + signature = "some-signature", + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.Disabled) + } + + @Test + fun `returns MissingSignature when signature header is null`() = runTest { + enablePatreon() + val handler = createHandler() + + val result = handler.handleWebhook( + payload = """{"data":{}}""", + signature = null, + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.MissingSignature) + } + + @Test + fun `returns MissingSignature when signature header is blank`() = runTest { + enablePatreon() + val handler = createHandler() + + val result = handler.handleWebhook( + payload = """{"data":{}}""", + signature = " ", + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.MissingSignature) + } + + @Test + fun `returns NotConfigured when webhook secret is not set`() = runTest { + enablePatreon(webhookSecret = "") + val handler = createHandler() + + val result = handler.handleWebhook( + payload = """{"data":{}}""", + signature = "some-signature", + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.NotConfigured) + } + + @Test + fun `returns InvalidSignature when signature verification fails`() = runTest { + enablePatreon() + val handler = createHandler() + + every { + patreonApiClient.verifyWebhookSignature(any(), any(), any()) + } returns false + + val result = handler.handleWebhook( + payload = """{"data":{}}""", + signature = "invalid-signature", + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.InvalidSignature) + } + + @Test + fun `triggers full sync on valid webhook`() = runTest { + enablePatreon() + val handler = createHandler() + val payload = """{"data":{"id":"123"}}""" + val signature = computeSignature(payload, "test-secret") + + every { + patreonApiClient.verifyWebhookSignature(payload, signature, "test-secret") + } returns true + + coEvery { + patreonSyncService.performFullSync() + } returns Result.success(SyncResult(added = 1, removed = 0, skipped = 0)) + + val result = handler.handleWebhook( + payload = payload, + signature = signature, + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.Success) + assertEquals(1, (result as WebhookResult.Success).syncResult.added) + + coVerify { patreonSyncService.performFullSync() } + } + + @Test + fun `returns SyncFailed when sync fails`() = runTest { + enablePatreon() + val handler = createHandler() + val payload = """{"data":{"id":"123"}}""" + val signature = computeSignature(payload, "test-secret") + + every { + patreonApiClient.verifyWebhookSignature(payload, signature, "test-secret") + } returns true + + coEvery { + patreonSyncService.performFullSync() + } returns Result.failure(RuntimeException("API error")) + + val result = handler.handleWebhook( + payload = payload, + signature = signature, + eventType = "members:pledge:create" + ) + + assertTrue(result is WebhookResult.SyncFailed) + assertEquals("API error", (result as WebhookResult.SyncFailed).error) + } + + @Test + fun `handles members create event`() = runTest { + enablePatreon() + val handler = createHandler() + val payload = """{"data":{"id":"123","type":"member"}}""" + val signature = computeSignature(payload, "test-secret") + + every { + patreonApiClient.verifyWebhookSignature(payload, signature, "test-secret") + } returns true + + coEvery { + patreonSyncService.performFullSync() + } returns Result.success(SyncResult(added = 1, removed = 0, skipped = 0)) + + val result = handler.handleWebhook( + payload = payload, + signature = signature, + eventType = "members:create" + ) + + assertTrue(result is WebhookResult.Success) + coVerify { patreonSyncService.performFullSync() } + } + + @Test + fun `handles members delete event`() = runTest { + enablePatreon() + val handler = createHandler() + val payload = """{"data":{"id":"123","type":"member"}}""" + val signature = computeSignature(payload, "test-secret") + + every { + patreonApiClient.verifyWebhookSignature(payload, signature, "test-secret") + } returns true + + coEvery { + patreonSyncService.performFullSync() + } returns Result.success(SyncResult(added = 0, removed = 1, skipped = 0)) + + val result = handler.handleWebhook( + payload = payload, + signature = signature, + eventType = "members:delete" + ) + + assertTrue(result is WebhookResult.Success) + assertEquals(1, (result as WebhookResult.Success).syncResult.removed) + coVerify { patreonSyncService.performFullSync() } + } + + @Test + fun `handles members pledge update event`() = runTest { + enablePatreon() + val handler = createHandler() + val payload = """{"data":{"id":"123","type":"member"}}""" + val signature = computeSignature(payload, "test-secret") + + every { + patreonApiClient.verifyWebhookSignature(payload, signature, "test-secret") + } returns true + + coEvery { + patreonSyncService.performFullSync() + } returns Result.success(SyncResult(added = 0, removed = 0, skipped = 1)) + + val result = handler.handleWebhook( + payload = payload, + signature = signature, + eventType = "members:pledge:update" + ) + + assertTrue(result is WebhookResult.Success) + coVerify { patreonSyncService.performFullSync() } + } +} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepositoryTest.kt index 8637271c8..95259a79f 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepositoryTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/access/ProjectAccessRepositoryTest.kt @@ -3,17 +3,9 @@ package com.darkrockstudios.apps.hammer.project.access import com.darkrockstudios.apps.hammer.GetPrivateAccessForProject import com.darkrockstudios.apps.hammer.Project_access import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.ApiProjectEntity -import com.darkrockstudios.apps.hammer.base.http.ApiSceneType import com.darkrockstudios.apps.hammer.database.ProjectAccessDao import com.darkrockstudios.apps.hammer.database.ProjectDao import com.darkrockstudios.apps.hammer.database.PublicProjectInfo -import com.darkrockstudios.apps.hammer.project.EntityDefinition -import com.darkrockstudios.apps.hammer.project.ProjectDefinition -import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource -import com.darkrockstudios.apps.hammer.utilities.SResult -import com.darkrockstudios.apps.hammer.utilities.isFailure -import com.darkrockstudios.apps.hammer.utilities.isSuccess import com.darkrockstudios.apps.hammer.utils.TestClock import io.mockk.MockKAnnotations import io.mockk.coEvery @@ -37,9 +29,6 @@ class ProjectAccessRepositoryTest { @MockK private lateinit var projectDao: ProjectDao - @MockK - private lateinit var projectEntityDatasource: ProjectEntityDatasource - private lateinit var testClock: TestClock private lateinit var repository: ProjectAccessRepository @@ -48,13 +37,12 @@ class ProjectAccessRepositoryTest { private val projectId = 100L private val penName = "TestAuthor" private val projectName = "TestProject" - private val projectDef = ProjectDefinition(projectName, projectUuid) @BeforeEach fun setup() { MockKAnnotations.init(this, relaxUnitFun = true) testClock = TestClock(Clock.System) - repository = ProjectAccessRepository(projectAccessDao, projectDao, projectEntityDatasource, testClock) + repository = ProjectAccessRepository(projectAccessDao, projectDao, testClock) } @Test @@ -222,120 +210,22 @@ class ProjectAccessRepositoryTest { val password = "secret123" val expiresAt = Instant.parse("2025-12-31T23:59:59Z") - mockCreatePrivateAccessCollaborators() + coEvery { projectDao.getProjectId(userId, projectUuid) } returns projectId - val result = repository.createPrivateAccess(userId, projectUuid, password, expiresAt) + repository.createPrivateAccess(userId, projectUuid, password, expiresAt) - assertTrue(isSuccess(result)) - coVerify { projectAccessDao.insertAccessWithScenes(projectId, password, expiresAt, emptySet(), any()) } + coVerify { projectAccessDao.insertAccess(projectId, password, expiresAt) } } @Test fun `createPrivateAccess - creates access without expiration`() = runTest { val password = "secret123" - mockCreatePrivateAccessCollaborators() - - val result = repository.createPrivateAccess(userId, projectUuid, password, null) - - assertTrue(isSuccess(result)) - coVerify { projectAccessDao.insertAccessWithScenes(projectId, password, null, emptySet(), any()) } - } - - @Test - fun `createPrivateAccess - persists the selected scene ids`() = runTest { - val password = "secret123" - val sceneIds = setOf(3, 7) - - mockCreatePrivateAccessCollaborators() - mockSceneDefs(3, 7) - mockLoadScene(3) - mockLoadScene(7) - - val result = repository.createPrivateAccess(userId, projectUuid, password, null, sceneIds) - - assertTrue(isSuccess(result)) - coVerify { projectAccessDao.insertAccessWithScenes(projectId, password, null, sceneIds, any()) } - } - - @Test - fun `createPrivateAccess - rejects an id that does not exist`() = runTest { - mockCreatePrivateAccessCollaborators() - mockSceneDefs(3) - mockLoadScene(3) - - val result = repository.createPrivateAccess(userId, projectUuid, "secret", null, setOf(3, 9)) - - assertTrue(isFailure(result)) - coVerify(exactly = 0) { projectAccessDao.insertAccessWithScenes(any(), any(), any(), any(), any()) } - } - - @Test - fun `createPrivateAccess - rejects a scene group id`() = runTest { - mockCreatePrivateAccessCollaborators() - mockSceneDefs(3, 4) - mockLoadScene(3) - mockLoadScene(4, sceneType = ApiSceneType.Group) - - val result = repository.createPrivateAccess(userId, projectUuid, "secret", null, setOf(3, 4)) - - assertTrue(isFailure(result)) - coVerify(exactly = 0) { projectAccessDao.insertAccessWithScenes(any(), any(), any(), any(), any()) } - } - - @Test - fun `createPrivateAccess - rejects an empty scene restriction instead of widening it`() = runTest { - mockCreatePrivateAccessCollaborators() - - val result = repository.createPrivateAccess(userId, projectUuid, "secret", null, emptySet()) - - assertTrue(isFailure(result)) - coVerify(exactly = 0) { projectAccessDao.insertAccessWithScenes(any(), any(), any(), any(), any()) } - } - - @Test - fun `createPrivateAccess - surfaces the DAO's duplicate-password refusal`() = runTest { - mockCreatePrivateAccessCollaborators() - coEvery { - projectAccessDao.insertAccessWithScenes(any(), any(), any(), any(), any()) - } returns null - - val result = repository.createPrivateAccess(userId, projectUuid, "secret123", null) - - assertTrue(isFailure(result)) - } - - private fun mockCreatePrivateAccessCollaborators() { coEvery { projectDao.getProjectId(userId, projectUuid) } returns projectId - coEvery { projectEntityDatasource.getProject(userId, projectUuid) } returns projectDef - coEvery { projectAccessDao.insertAccessWithScenes(any(), any(), any(), any(), any()) } returns 42L - } - private fun mockSceneDefs(vararg ids: Int) { - coEvery { - projectEntityDatasource.getEntityDefsByType(userId, projectDef, ApiProjectEntity.Type.SCENE) - } returns ids.map { EntityDefinition(it, ApiProjectEntity.Type.SCENE) } - } + repository.createPrivateAccess(userId, projectUuid, password, null) - private fun mockLoadScene(id: Int, sceneType: ApiSceneType = ApiSceneType.Scene) { - coEvery { - projectEntityDatasource.loadEntity( - userId, projectDef, id, - ApiProjectEntity.Type.SCENE, - ApiProjectEntity.SceneEntity.serializer(), - ) - } returns SResult.success( - ApiProjectEntity.SceneEntity( - id = id, - sceneType = sceneType, - order = 0, - name = "Scene $id", - path = listOf(0), - content = "", - outline = "", - notes = "", - ) - ) + coVerify { projectAccessDao.insertAccess(projectId, password, null) } } @Test @@ -359,10 +249,6 @@ class ProjectAccessRepositoryTest { coEvery { projectDao.getProjectId(userId, projectUuid) } returns projectId coEvery { projectAccessDao.getPrivateAccessForProject(projectId) } returns entries - coEvery { projectAccessDao.getSceneIdsForAccessIds(listOf(1L, 2L)) } returns - mapOf(1L to setOf(10, 11, 12, 13, 14)) - coEvery { projectEntityDatasource.getProject(userId, projectUuid) } returns projectDef - mockSceneDefs(10, 11, 12, 13, 14) val result = repository.getPrivateAccessEntries(userId, projectUuid) @@ -373,13 +259,11 @@ class ProjectAccessRepositoryTest { assertEquals(Instant.parse("2099-06-15T12:00:00Z"), result[0].expiresAt) // Locale/zone-dependent formatting: assert only the stable year. assertTrue(result[0].expiresAtFormatted!!.contains("2099")) - assertEquals(5, result[0].sceneCount) assertEquals(2, result[1].id) assertEquals("pass2", result[1].password) assertFalse(result[1].isExpired) assertNull(result[1].expiresAt) assertNull(result[1].expiresAtFormatted) - assertNull(result[1].sceneCount) } @Test @@ -396,7 +280,6 @@ class ProjectAccessRepositoryTest { coEvery { projectDao.getProjectId(userId, projectUuid) } returns projectId coEvery { projectAccessDao.getPrivateAccessForProject(projectId) } returns entries - coEvery { projectAccessDao.getSceneIdsForAccessIds(any()) } returns emptyMap() val result = repository.getPrivateAccessEntries(userId, projectUuid) @@ -404,31 +287,6 @@ class ProjectAccessRepositoryTest { assertTrue(result[0].isExpired) } - @Test - fun `getPrivateAccessEntries - a share whose scenes were all deleted reads as sceneless`() = runTest { - val entries = listOf( - GetPrivateAccessForProject( - id = 1, - access_password = "pass1", - expires_at = null, - project_id = 1, - published_at = Instant.parse("2025-12-25T23:51:32Z") - ) - ) - - coEvery { projectDao.getProjectId(userId, projectUuid) } returns projectId - coEvery { projectAccessDao.getPrivateAccessForProject(projectId) } returns entries - coEvery { projectAccessDao.getSceneIdsForAccessIds(listOf(1L)) } returns mapOf(1L to setOf(10, 11)) - coEvery { projectEntityDatasource.getProject(userId, projectUuid) } returns projectDef - mockSceneDefs(20, 21) - - val result = repository.getPrivateAccessEntries(userId, projectUuid) - - assertEquals(0, result[0].sceneCount) - assertTrue(result[0].isSceneless) - assertTrue(result[0].isRestricted) - } - @Test fun `deleteAllAccessForUser - deletes all access entries for user`() = runTest { repository.deleteAllAccessForUser(userId) @@ -557,9 +415,8 @@ class ProjectAccessRepositoryTest { projectAccessDao.findProjectByPenNameProjectNameAndPassword( penName, projectName, - password, - any() - ) + password + ) } returns privateInfo val result = repository.findAccessibleProject(penName, projectName, password) @@ -570,74 +427,6 @@ class ProjectAccessRepositoryTest { assertFalse(result.isPublic) } - @Test - fun `findAccessibleProject - private share carries its scene restriction`() = runTest { - val password = "secret123" - val privateInfo = PublicProjectInfo( - projectUuid = projectUuid.id, - userId = userId, - projectName = projectName, - penName = penName, - expiresAt = null, - accessId = 42L, - ) - - coEvery { projectAccessDao.findPublicProjectByPenNameAndProjectName(penName, projectName) } returns null - coEvery { projectAccessDao.hasAnyAccessForProject(penName, projectName) } returns true - coEvery { - projectAccessDao.findProjectByPenNameProjectNameAndPassword(penName, projectName, password, any()) - } returns privateInfo - coEvery { projectAccessDao.getSceneIdsForAccess(42L) } returns listOf(3, 7) - - val result = repository.findAccessibleProject(penName, projectName, password) - - assertTrue(result is PublicProjectResult.Success) - assertEquals(setOf(3, 7), (result as PublicProjectResult.Success).sceneIds) - } - - @Test - fun `findAccessibleProject - unrestricted private share has null scene ids`() = runTest { - val password = "secret123" - val privateInfo = PublicProjectInfo( - projectUuid = projectUuid.id, - userId = userId, - projectName = projectName, - penName = penName, - expiresAt = null, - accessId = 42L, - ) - - coEvery { projectAccessDao.findPublicProjectByPenNameAndProjectName(penName, projectName) } returns null - coEvery { projectAccessDao.hasAnyAccessForProject(penName, projectName) } returns true - coEvery { - projectAccessDao.findProjectByPenNameProjectNameAndPassword(penName, projectName, password, any()) - } returns privateInfo - coEvery { projectAccessDao.getSceneIdsForAccess(42L) } returns emptyList() - - val result = repository.findAccessibleProject(penName, projectName, password) - - assertTrue(result is PublicProjectResult.Success) - assertNull((result as PublicProjectResult.Success).sceneIds) - } - - @Test - fun `findAccessibleProject - public access never carries a scene restriction`() = runTest { - val publicInfo = PublicProjectInfo( - projectUuid = projectUuid.id, - userId = userId, - projectName = projectName, - penName = penName, - expiresAt = null - ) - - coEvery { projectAccessDao.findPublicProjectByPenNameAndProjectName(penName, projectName) } returns publicInfo - - val result = repository.findAccessibleProject(penName, projectName, null) - - assertTrue(result is PublicProjectResult.Success) - assertNull((result as PublicProjectResult.Success).sceneIds) - } - @Test fun `findAccessibleProject - returns password required with wrong password`() = runTest { val wrongPassword = "wrong" @@ -648,9 +437,8 @@ class ProjectAccessRepositoryTest { projectAccessDao.findProjectByPenNameProjectNameAndPassword( penName, projectName, - wrongPassword, - any() - ) + wrongPassword + ) } returns null val result = repository.findAccessibleProject(penName, projectName, wrongPassword) @@ -675,9 +463,8 @@ class ProjectAccessRepositoryTest { projectAccessDao.findProjectByPenNameProjectNameAndPassword( penName, projectName, - password, - any() - ) + password + ) } returns expiredInfo val result = repository.findAccessibleProject(penName, projectName, password) @@ -714,9 +501,8 @@ class ProjectAccessRepositoryTest { projectAccessDao.findProjectByPenNameProjectNameAndPassword( penName, projectName, - password, - any() - ) + password + ) } returns validPrivateInfo val result = repository.findAccessibleProject(penName, projectName, password) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/ProjectDataRoutesTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/ProjectDataRoutesTest.kt index f08a4db4a..fbe3ceed4 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/ProjectDataRoutesTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/ProjectDataRoutesTest.kt @@ -35,7 +35,6 @@ import com.darkrockstudios.apps.hammer.utilities.MarkdownService import com.darkrockstudios.apps.hammer.utilities.SResult import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import com.darkrockstudios.apps.hammer.utils.testAccount import io.ktor.client.call.body import io.ktor.client.plugins.contentnegotiation.ContentNegotiation import io.ktor.client.request.get @@ -101,9 +100,6 @@ class ProjectDataRoutesTest : BaseTest() { super.setup() MockKAnnotations.init(this, relaxUnitFun = true) - // The bearer gate loads the account after token validation; default to an active one. - coEvery { accountsRepository.getAccountOrNull(any()) } returns testAccount() - coEvery { projectEntityDatasource.getProject(userId, projectId) } returns ProjectDefinition(projectName, projectId) @@ -127,8 +123,6 @@ class ProjectDataRoutesTest : BaseTest() { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } single { json } } } @@ -136,7 +130,7 @@ class ProjectDataRoutesTest : BaseTest() { @Test fun `GET project_data returns dto when row exists`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverProjectDataRepository.load(userId, ProjectDefinition(projectName, projectId)) } returns SResult.success(RawProjectDataDto(sampleJson, "hash-abc")) @@ -163,7 +157,7 @@ class ProjectDataRoutesTest : BaseTest() { @Test fun `GET project_data returns 204 when no row`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverProjectDataRepository.load(any(), any()) } returns SResult.success(null) @@ -186,7 +180,7 @@ class ProjectDataRoutesTest : BaseTest() { @Test fun `GET project_data returns 404 when project missing`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverProjectDataRepository.load(any(), any()) } returns SResult.failure(ProjectNotFound(projectId)) @@ -209,7 +203,7 @@ class ProjectDataRoutesTest : BaseTest() { @Test fun `POST project_data 200 when accepted`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverProjectDataRepository.save( userId, @@ -255,7 +249,7 @@ class ProjectDataRoutesTest : BaseTest() { @Test fun `POST project_data 409 with conflict body when hashes mismatch`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false val serverState = sampleData.copy(authorName = "Server") coEvery { diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/WritingActivityRoutesTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/WritingActivityRoutesTest.kt index 5ab0938b2..efe04eb05 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/WritingActivityRoutesTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/project/routes/WritingActivityRoutesTest.kt @@ -29,7 +29,6 @@ import com.darkrockstudios.apps.hammer.utilities.MarkdownService import com.darkrockstudios.apps.hammer.utilities.SResult import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import com.darkrockstudios.apps.hammer.utils.testAccount import io.ktor.client.call.body import io.ktor.client.plugins.contentnegotiation.ContentNegotiation import io.ktor.client.request.get @@ -120,9 +119,6 @@ class WritingActivityRoutesTest : BaseTest() { super.setup() MockKAnnotations.init(this, relaxUnitFun = true) - // The bearer gate loads the account after token validation; default to an active one. - coEvery { accountsRepository.getAccountOrNull(any()) } returns testAccount() - coEvery { projectEntityDatasource.getProject(userId, projectId) } returns ProjectDefinition(projectName, projectId) @@ -146,8 +142,6 @@ class WritingActivityRoutesTest : BaseTest() { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } single { json } } } @@ -169,7 +163,7 @@ class WritingActivityRoutesTest : BaseTest() { ) ) coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverWritingActivityRepository.loadAll( userId, @@ -197,7 +191,7 @@ class WritingActivityRoutesTest : BaseTest() { @Test fun `GET writing_activity returns 404 when project missing`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverWritingActivityRepository.loadAll(any(), any()) } returns SResult.failure(ProjectNotFound(projectId)) @@ -230,7 +224,7 @@ class WritingActivityRoutesTest : BaseTest() { ), ) coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { serverWritingActivityRepository.saveDeviceLog( userId = userId, @@ -269,7 +263,7 @@ class WritingActivityRoutesTest : BaseTest() { @Test fun `GET writing_activity 410 Gone when project id unknown`() = testApplication { coEvery { accountsRepository.checkToken(userId, bearerToken) } returns SResult.success(0L) - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectEntityDatasource.getProject(userId, projectId) } returns null application { diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/repository/ProjectsRepositoryRenameEntityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/repository/ProjectsRepositoryRenameEntityTest.kt index c256fb638..c4b6d87c3 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/repository/ProjectsRepositoryRenameEntityTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/repository/ProjectsRepositoryRenameEntityTest.kt @@ -2,8 +2,6 @@ package com.darkrockstudios.apps.hammer.projects.repository import com.darkrockstudios.apps.hammer.base.ProjectId import com.darkrockstudios.apps.hammer.base.validate.MAX_PROJECT_NAME_LENGTH -import com.darkrockstudios.apps.hammer.project.ProjectNameTaken -import com.darkrockstudios.apps.hammer.utilities.isFailure import io.mockk.coEvery import io.mockk.coVerify import kotlinx.coroutines.test.runTest @@ -11,7 +9,6 @@ import org.junit.jupiter.api.Test import org.junit.jupiter.params.ParameterizedTest import org.junit.jupiter.params.provider.MethodSource import java.util.stream.Stream -import kotlin.test.assertIs import kotlin.test.assertTrue class ProjectsRepositoryRenameEntityTest : ProjectsRepositoryBaseTest() { @@ -32,23 +29,6 @@ class ProjectsRepositoryRenameEntityTest : ProjectsRepositoryBaseTest() { } } - @Test - fun `Rename Project - Failure - Name Already Taken`() = runTest { - val syncId = "sync-id" - val projectId = ProjectId("ProjectId") - val newProjectName = "Taken Project Name" - - coEvery { projectsSessionManager.validateSyncId(any(), any(), any()) } returns true - coEvery { projectEntityDatasource.checkProjectExists(any(), projectId) } returns true - coEvery { projectEntityDatasource.renameProject(any(), any(), any()) } returns false - - createProjectsRepository().apply { - val result = renameProject(userId, syncId, projectId, newProjectName) - assertTrue(isFailure(result)) - assertIs(result.exception) - } - } - companion object { @JvmStatic fun provideBadNames(): Stream = Stream.of( diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesBaseTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesBaseTest.kt index 02a498df1..84dffbee7 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesBaseTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesBaseTest.kt @@ -21,11 +21,9 @@ import com.darkrockstudios.apps.hammer.story.StoryRendererService import com.darkrockstudios.apps.hammer.utilities.MarkdownService import com.darkrockstudios.apps.hammer.utils.BaseTest import com.darkrockstudios.apps.hammer.utils.setupKtorTestKoin -import com.darkrockstudios.apps.hammer.utils.testAccount import io.ktor.server.application.Application import io.ktor.server.testing.ApplicationTestBuilder import io.mockk.MockKAnnotations -import io.mockk.coEvery import io.mockk.impl.annotations.MockK import io.mockk.mockk import kotlinx.serialization.json.Json @@ -92,11 +90,6 @@ abstract class ProjectsRoutesBaseTest : BaseTest() { MockKAnnotations.init(this, relaxUnitFun = true) - // The bearer gate loads the account after token validation; default to an - // active, allowed one (the relaxed mock's isOnWhiteList would return false). - coEvery { accountsRepository.getAccountOrNull(any()) } returns testAccount() - coEvery { whiteListRepository.isOnWhiteList(any()) } returns true - testModule = module { single { accountsRepository } single { whiteListRepository } @@ -117,8 +110,6 @@ abstract class ProjectsRoutesBaseTest : BaseTest() { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } - single { mockk(relaxed = true) } } } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesCreateProjectTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesCreateProjectTest.kt index 93aa2dc60..ca07eba36 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesCreateProjectTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesCreateProjectTest.kt @@ -29,6 +29,7 @@ class ProjectsRoutesCreateProjectTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.createProject( userId = userId, @@ -67,6 +68,7 @@ class ProjectsRoutesCreateProjectTest : ProjectsRoutesBaseTest() { @Test fun `Projects - Create Project - Invalid Request`() = testApplication { coEvery { accountsRepository.checkToken(any(), any()) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false defaultApplication() @@ -84,6 +86,7 @@ class ProjectsRoutesCreateProjectTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.createProject( userId = userId, @@ -109,6 +112,7 @@ class ProjectsRoutesCreateProjectTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.createProject( userId = userId, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesDeleteProjectTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesDeleteProjectTest.kt index 8f1a3f72b..aa471f97c 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesDeleteProjectTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesDeleteProjectTest.kt @@ -22,6 +22,7 @@ class ProjectsRoutesDeleteProjectTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.deleteProject( userId = userId, @@ -53,6 +54,7 @@ class ProjectsRoutesDeleteProjectTest : ProjectsRoutesBaseTest() { @Test fun `Projects - Delete Project - Invalid Request`() = testApplication { coEvery { accountsRepository.checkToken(any(), any()) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false defaultApplication() @@ -73,6 +75,7 @@ class ProjectsRoutesDeleteProjectTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.deleteProject( userId = userId, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectBeginSyncTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectBeginSyncTest.kt index 1018a8885..3f29ab66e 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectBeginSyncTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectBeginSyncTest.kt @@ -35,6 +35,7 @@ class ProjectsRoutesProjectBeginSyncTest : ProjectsRoutesBaseTest() { coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) coEvery { accountsRepository.getInstallId(BEARER_TOKEN) } returns "test-install-id" + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.beginProjectsSync(userId, "test-install-id") } returns SResult.success(syncData) @@ -60,6 +61,7 @@ class ProjectsRoutesProjectBeginSyncTest : ProjectsRoutesBaseTest() { @Test fun `Projects - Begin Sync - Active Sync Session Conflict`() = testApplication { coEvery { accountsRepository.checkToken(any(), any()) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.beginProjectsSync(any(), any()) } returns SResult.failure(Exception()) @@ -76,6 +78,7 @@ class ProjectsRoutesProjectBeginSyncTest : ProjectsRoutesBaseTest() { @Test fun `Projects - Begin Sync - Bad Auth`() = testApplication { coEvery { accountsRepository.checkToken(any(), any()) } returns SResult.failure(Exception()) + coEvery { whiteListRepository.useWhiteList() } returns false defaultApplication() client.get("api/projects/0/begin_sync") { diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectEndSyncTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectEndSyncTest.kt index 7dc52828e..7f50e949a 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectEndSyncTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesProjectEndSyncTest.kt @@ -18,6 +18,7 @@ class ProjectsRoutesProjectEndSyncTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.endProjectsSync(userId = userId, syncId = syncId) } returns SResult.success(Unit) @@ -39,6 +40,7 @@ class ProjectsRoutesProjectEndSyncTest : ProjectsRoutesBaseTest() { val userId = 0L coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false defaultApplication() diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesRenameProjectTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesRenameProjectTest.kt index eab85f73d..d220970a7 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesRenameProjectTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/projects/routes/ProjectsRoutesRenameProjectTest.kt @@ -6,12 +6,10 @@ import com.darkrockstudios.apps.hammer.base.http.HAMMER_PROTOCOL_VERSION import com.darkrockstudios.apps.hammer.base.http.HEADER_SYNC_ID import com.darkrockstudios.apps.hammer.project.InvalidProjectName import com.darkrockstudios.apps.hammer.project.InvalidSyncIdException -import com.darkrockstudios.apps.hammer.project.ProjectNameTaken import com.darkrockstudios.apps.hammer.project.ProjectNotFound import com.darkrockstudios.apps.hammer.utilities.SResult import com.darkrockstudios.apps.hammer.utilities.ServerResult import io.ktor.client.request.* -import io.ktor.client.statement.* import io.ktor.http.* import io.ktor.server.testing.* import io.mockk.coEvery @@ -21,7 +19,6 @@ import org.junit.jupiter.params.ParameterizedTest import org.junit.jupiter.params.provider.Arguments import org.junit.jupiter.params.provider.MethodSource import java.util.stream.Stream -import kotlin.test.assertContains import kotlin.test.assertEquals class ProjectsRoutesRenameProjectTest : ProjectsRoutesBaseTest() { @@ -33,6 +30,7 @@ class ProjectsRoutesRenameProjectTest : ProjectsRoutesBaseTest() { val newName = "New Project Name" coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.renameProject( userId = userId, @@ -64,38 +62,6 @@ class ProjectsRoutesRenameProjectTest : ProjectsRoutesBaseTest() { } } - @Test - fun `Unknown project reports that the project does not exist`() = testApplication { - val projectId = ProjectId("TestProjectId") - val syncId = "syncId-test" - val userId = 0L - val newName = "What Ever" - - coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) - coEvery { - projectsRepository.renameProject( - userId = userId, - syncId = syncId, - projectId = projectId, - newProjectName = newName - ) - } returns SResult.failure(ProjectNotFound(projectId)) - - defaultApplication() - - client.get("api/projects/0/rename") { - header(HAMMER_PROTOCOL_HEADER, HAMMER_PROTOCOL_VERSION.toString()) - header("Authorization", "Bearer $BEARER_TOKEN") - header(HEADER_SYNC_ID, syncId) - - parameter("projectId", projectId.id) - parameter("projectName", newName) - }.apply { - assertEquals(HttpStatusCode.NotFound, status) - assertContains(bodyAsText(), "Project does not exist") - } - } - companion object { @JvmStatic fun provideFailureTestData(): Stream { @@ -114,10 +80,6 @@ class ProjectsRoutesRenameProjectTest : ProjectsRoutesBaseTest() { ), HttpStatusCode.BadRequest ), - Arguments.of( - SResult.failure(ProjectNameTaken("What Ever")), - HttpStatusCode.Conflict - ), ) } } @@ -134,6 +96,7 @@ class ProjectsRoutesRenameProjectTest : ProjectsRoutesBaseTest() { val newName = "What Ever" coEvery { accountsRepository.checkToken(userId, BEARER_TOKEN) } returns SResult.success(0L) + coEvery { whiteListRepository.useWhiteList() } returns false coEvery { projectsRepository.renameProject( userId = userId, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepositoryTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepositoryTest.kt index d3df7bb4a..fd6cb9e95 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepositoryTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/review/ReviewRepositoryTest.kt @@ -13,7 +13,6 @@ import com.darkrockstudios.apps.hammer.dependencyinjection.PROJECTS_SYNC_MANAGER import com.darkrockstudios.apps.hammer.dependencyinjection.PROJECT_SYNC_MANAGER import com.darkrockstudios.apps.hammer.encryption.ContentEncryptor import com.darkrockstudios.apps.hammer.encryption.ContentEncryptorRegistry -import com.darkrockstudios.apps.hammer.project.EntityDefinition import com.darkrockstudios.apps.hammer.project.ProjectDefinition import com.darkrockstudios.apps.hammer.project.ProjectEntityDatasource import com.darkrockstudios.apps.hammer.project.ProjectSyncData @@ -167,10 +166,10 @@ class ReviewRepositoryTest : BaseTest() { coEvery { accountDao.getAccount(userId) } returns mockk { coEvery { cipher_secret } returns cipherSecret } - coEvery { - projectEntityDatasource.getEntityDefsByType(userId, projectDef, ApiProjectEntity.Type.SCENE) - } returns sceneIds.map { EntityDefinition(it, ApiProjectEntity.Type.SCENE) } for (sceneId in sceneIds) { + coEvery { + projectEntityDatasource.findEntityType(sceneId, userId, projectDef) + } returns ApiProjectEntity.Type.SCENE coEvery { projectEntityDatasource.loadEntity( userId, projectDef, sceneId, @@ -267,10 +266,9 @@ class ReviewRepositoryTest : BaseTest() { fun `create review request rejects non-scene entity ids`() = runTest { coEvery { projectEntityDatasource.getProject(userId, projectId) } returns projectDef coEvery { projectDao.getProjectIdOrNull(userId, projectId) } returns numericProjectId - // Entity 9 exists but is not a scene, so the scene defs list does not contain it. coEvery { - projectEntityDatasource.getEntityDefsByType(userId, projectDef, ApiProjectEntity.Type.SCENE) - } returns emptyList() + projectEntityDatasource.findEntityType(9, userId, projectDef) + } returns ApiProjectEntity.Type.NOTE val result = createRepository().createReviewRequest( userId = userId, diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererServiceTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererServiceTest.kt index 68b8ff93c..83e18bd9a 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererServiceTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/story/StoryRendererServiceTest.kt @@ -21,8 +21,6 @@ import org.junit.jupiter.api.Test import kotlin.test.assertEquals import kotlin.test.assertFalse import kotlin.test.assertIs -import kotlin.test.assertNotEquals -import kotlin.test.assertNull import kotlin.test.assertTrue class StoryRendererServiceTest { @@ -138,83 +136,6 @@ class StoryRendererServiceTest { assertTrue(firstContentPos < secondContentPos, "Child scenes should be in order") } - @Test - fun `chapter headings gain no break from the scene separator`() = runTest { - val scenes = listOf( - createScene(id = 1, name = "First", content = "Content 1", order = 0), - createScene(id = 2, name = "Second", content = "Content 2", order = 1), - ) - setupMocksForScenes(scenes) - - val result = service.renderStoryAsHtml(userId, projectId) - - assertIs(result) - assertFalse(result.html.contains("(result) - assertTrue(result.html.contains("

    First child content.

    ")) - assertTrue(result.html.contains("

    Second child content.

    ")) - } - - @Test - fun `sibling scenes in a group are parted by one blank line`() = runTest { - val scenes = listOf( - createScene(id = 1, name = "Chapter 1", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene 1.1", content = "First child content.", order = 0, path = listOf(0, 1)), - createScene(id = 3, name = "Scene 1.2", content = "Second child content.", order = 1, path = listOf(0, 1)), - ) - setupMocksForScenes(scenes) - - val result = service.renderStoryAsHtml(userId, projectId) - - assertIs(result) - // Nothing else marks the seam between two scenes of a chapter, and without it the last line - // of one and the first of the next read as consecutive lines of the same passage. - assertEquals(1, Regex("").findAll(result.html).count(), result.html) - } - - @Test - fun `sibling scenes in an exported group render as separate paragraphs`() = runTest { - val scenes = listOf( - createScene(id = 1, name = "Chapter 1", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene 1.1", content = "First child content.", order = 0, path = listOf(0, 1)), - createScene(id = 3, name = "Scene 1.2", content = "Second child content.", order = 1, path = listOf(0, 1)), - ) - setupMocksForScenes(scenes) - - val result = service.renderSceneAsHtml(userId, projectId, sceneId = 1) - - assertIs(result) - assertTrue(result.html.contains("

    First child content.

    ")) - assertTrue(result.html.contains("

    Second child content.

    ")) - } - - @Test - fun `a scene keeps its own block structure`() = runTest { - val content = "A list follows:\n\n- one\n- two\n\nAnd prose after it." - val scene = createScene(id = 1, name = "Chapter One", content = content, order = 0) - setupMocksForScenes(listOf(scene)) - - val result = service.renderStoryAsHtml(userId, projectId) - - assertIs(result) - assertTrue(result.html.contains("
      ")) - assertTrue(result.html.contains("
    • one
    • ")) - assertTrue(result.html.contains("

      And prose after it.

      ")) - } - @Test fun `exports nested groups correctly`() = runTest { val scenes = listOf( @@ -359,326 +280,6 @@ class StoryRendererServiceTest { assertTrue(result.html.contains("") || result.html.contains("")) } - // Scene-limited share tests - - @Test - fun `filtered - prepareExport version covers only the filtered scenes`() = runTest { - setupMocksForScenes( - listOf( - createScene(1, "First", "Content 1", 0), - createScene(2, "Second", "Content 2", 1), - ) - ) - stubSceneHashes(EntityHash(1, "hash-one"), EntityHash(2, "hash-two")) - - val full = service.prepareExport(userId, projectId)!! - val filtered = service.prepareExport(userId, projectId, setOf(1))!! - - assertNotEquals(full.version, filtered.version) - - // An edit to an unselected scene must not invalidate the filtered share. - stubSceneHashes(EntityHash(1, "hash-one"), EntityHash(2, "hash-two-changed")) - assertEquals(filtered.version, service.prepareExport(userId, projectId, setOf(1))!!.version) - - // An edit to a selected scene must. - stubSceneHashes(EntityHash(1, "hash-one-changed"), EntityHash(2, "hash-two-changed")) - assertNotEquals(filtered.version, service.prepareExport(userId, projectId, setOf(1))!!.version) - } - - @Test - fun `filtered - two shares with different scene sets get distinct versions`() = runTest { - setupMocksForScenes( - listOf( - createScene(1, "First", "Content 1", 0), - createScene(2, "Second", "Content 2", 1), - ) - ) - stubSceneHashes(EntityHash(1, "hash-one"), EntityHash(2, "hash-two")) - - val shareOne = service.prepareExport(userId, projectId, setOf(1))!! - val shareTwo = service.prepareExport(userId, projectId, setOf(2))!! - - assertNotEquals(shareOne.version, shareTwo.version) - } - - @Test - fun `filtered - prepareExport returns null when every selected scene is gone`() = runTest { - setupMocksForScenes(listOf(createScene(1, "First", "Content 1", 0))) - stubSceneHashes(EntityHash(1, "hash-one")) - - assertNull(service.prepareExport(userId, projectId, setOf(99))) - } - - @Test - fun `filtered - renders only the selected scenes`() = runTest { - setupMocksForScenes( - listOf( - createScene(1, "First", "Alpha content", 0), - createScene(2, "Second", "Bravo content", 1), - createScene(3, "Third", "Charlie content", 2), - ) - ) - - val prepared = service.prepareExport(userId, projectId, setOf(1, 3))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - val data = result.data - assertTrue(data.pageHtml.contains("Alpha content")) - assertTrue(data.pageHtml.contains("Charlie content")) - assertFalse(data.pageHtml.contains("Bravo content")) - assertEquals(2, data.sceneCount) - assertEquals(4, data.totalWordCount) - } - - @Test - fun `filtered - a deleted selected scene silently drops out`() = runTest { - setupMocksForScenes( - listOf( - createScene(1, "First", "Alpha content", 0), - createScene(2, "Second", "Bravo content", 1), - ) - ) - - // Scene 3 was selected when the share was created but no longer exists. - val prepared = service.prepareExport(userId, projectId, setOf(1, 3))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertTrue(result.data.pageHtml.contains("Alpha content")) - assertFalse(result.data.pageHtml.contains("Bravo content")) - assertEquals(1, result.data.sceneCount) - } - - @Test - fun `filtered - an unfiltered prepareExport keeps full-story behavior`() = runTest { - setupMocksForScenes( - listOf( - createScene(1, "First", "Alpha content", 0), - createScene(2, "Second", "Bravo content", 1), - ) - ) - - val prepared = service.prepareExport(userId, projectId)!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertTrue(result.data.pageHtml.contains("Alpha content")) - assertTrue(result.data.pageHtml.contains("Bravo content")) - } - - @Test - fun `chapter headings are the author's own, unnumbered`() = runTest { - setupMocksForScenes( - listOf( - createScene(id = 1, name = "Prologue", content = "Prologue content.", order = 0), - createScene(id = 2, name = "Chapitre 1", content = "First chapter.", order = 1), - ) - ) - - val result = service.renderStoryAsHtml(userId, projectId) - - assertIs(result) - assertTrue(result.html.contains("

      Prologue

      "), result.html) - assertTrue(result.html.contains("

      Chapitre 1

      "), result.html) - } - - /** - * Two chapters whose scenes were not created in reading order, so entity id order and tree - * order disagree: FR/Prologue(2), ENG/Prologue(4), FR/Chapitre 1(5). - */ - private fun interleavedChapters() = listOf( - createScene(id = 1, name = "Unhealthy - FR", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Prologue", content = "Prologue francais", order = 0, path = listOf(0, 1)), - createScene(id = 3, name = "Unhealthy - ENG", content = "", order = 1, sceneType = ApiSceneType.Group), - createScene(id = 4, name = "Prologue", content = "English prologue", order = 0, path = listOf(0, 3)), - createScene(id = 5, name = "Chapitre 1", content = "Chapitre un", order = 1, path = listOf(0, 1)), - ) - - private fun assertRendersInOrder(html: String, vararg content: String) { - val positions = content.map { it to html.indexOf(it) } - positions.forEach { (text, at) -> assertTrue(at >= 0, "'$text' is missing from the render:\n$html") } - positions.zipWithNext { (beforeText, before), (afterText, after) -> - assertTrue(before < after, "'$beforeText' should render before '$afterText':\n$html") - } - } - - @Test - fun `paginated - scenes render in tree order, not entity id order`() = runTest { - setupMocksForScenes(interleavedChapters()) - - val result = service.renderStoryAsHtmlPaginated(userId, projectId) - - assertIs(result) - assertRendersInOrder(result.data.pageHtml, "Prologue francais", "Chapitre un", "English prologue") - } - - @Test - fun `filtered - selected scenes render in tree order, not entity id order`() = runTest { - setupMocksForScenes(interleavedChapters()) - - val prepared = service.prepareExport(userId, projectId, setOf(2, 4, 5))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertRendersInOrder(result.data.pageHtml, "Prologue francais", "Chapitre un", "English prologue") - } - - @Test - fun `filtered - a subset spanning two chapters keeps tree order`() = runTest { - setupMocksForScenes(interleavedChapters()) - - val prepared = service.prepareExport(userId, projectId, setOf(4, 5))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertFalse(result.data.pageHtml.contains("Prologue francais")) - assertRendersInOrder(result.data.pageHtml, "Chapitre un", "English prologue") - } - - @Test - fun `paginated - pagination follows tree order`() = runTest { - setupMocksForScenes(interleavedChapters()) - - // Three scenes of 2, 2, and 2 words: one per page, in tree order. - val pages = (1..3).map { page -> - val result = service.renderStoryAsHtmlPaginated(userId, projectId, page = page, wordsPerPage = 2) - assertIs(result) - result.data - } - - assertEquals(3, pages.first().totalPages) - assertTrue(pages[0].pageHtml.contains("Prologue francais")) - assertTrue(pages[1].pageHtml.contains("Chapitre un")) - assertTrue(pages[2].pageHtml.contains("English prologue")) - } - - @Test - fun `paginated - a scene orphaned from its group still renders`() = runTest { - setupMocksForScenes( - listOf( - createScene(id = 1, name = "Chapter 1", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene 1", content = "Attached content", order = 0, path = listOf(0, 1)), - // Parent group 99 does not exist; the prose must not vanish from the page. - createScene(id = 3, name = "Lost Scene", content = "Orphaned content", order = 0, path = listOf(0, 99)), - ) - ) - - val result = service.renderStoryAsHtmlPaginated(userId, projectId) - - assertIs(result) - assertTrue(result.data.pageHtml.contains("Attached content")) - assertTrue(result.data.pageHtml.contains("Orphaned content")) - assertEquals(2, result.data.sceneCount) - } - - /** Two chapters, one scene each, with [chapterOrder] deciding which chapter reads first. */ - private fun twoChapters(chapterOrder: List) = listOf( - createScene(id = 1, name = "Chapter A", content = "", order = chapterOrder[0], sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene X", content = "Alpha content", order = 0, path = listOf(0, 1)), - createScene(id = 3, name = "Chapter B", content = "", order = chapterOrder[1], sceneType = ApiSceneType.Group), - createScene(id = 4, name = "Scene Y", content = "Bravo content", order = 0, path = listOf(0, 3)), - ) - - @Test - fun `filtered - reordering the chapters around a share changes its version`() = runTest { - setupMocksForScenes(twoChapters(listOf(0, 1))) - val before = service.prepareExport(userId, projectId, setOf(2, 4))!! - - // Neither selected scene is touched; only the groups that place them swap. - setupMocksForScenes(twoChapters(listOf(1, 0))) - val after = service.prepareExport(userId, projectId, setOf(2, 4))!! - - assertNotEquals( - before.version, - after.version, - "a reader holding the old validator would be answered 304 with the old reading order" - ) - } - - @Test - fun `filtered - reordering the chapters around a share changes the rendered order`() = runTest { - setupMocksForScenes(twoChapters(listOf(1, 0))) - - val prepared = service.prepareExport(userId, projectId, setOf(2, 4))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertRendersInOrder(result.data.pageHtml, "Bravo content", "Alpha content") - } - - @Test - fun `filtered - a share never reads a scene it does not show`() = runTest { - setupMocksForScenes( - listOf( - createScene(id = 1, name = "Chapter A", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene X", content = "Alpha content", order = 0, path = listOf(0, 1)), - createScene(id = 3, name = "Secret", content = "Unshared prose", order = 1, path = listOf(0, 1)), - ) - ) - - val prepared = service.prepareExport(userId, projectId, setOf(2))!! - val result = service.renderStoryAsHtmlPaginated(prepared) - - assertIs(result) - assertFalse(result.data.pageHtml.contains("Unshared prose")) - // Unshared prose is never decrypted, not merely dropped after the fact. - coVerify(exactly = 0) { - datasource.loadEntity( - userId, - projectDef, - 3, - ApiProjectEntity.Type.SCENE, - ApiProjectEntity.SceneEntity.serializer() - ) - } - } - - @Test - fun `filtered - an unrelated scene failing to load still caches the share`() = runTest { - setupMocksForScenes( - listOf( - createScene(id = 1, name = "Shared", content = "Alpha content", order = 0), - createScene(id = 2, name = "Elsewhere", content = "Bravo content", order = 1), - ) - ) - // A scene the share doesn't show fails to decrypt; it cannot affect this render's output. - coEvery { - datasource.loadEntity( - userId, - projectDef, - 2, - ApiProjectEntity.Type.SCENE, - ApiProjectEntity.SceneEntity.serializer() - ) - } returns SResult.failure("boom") - - val prepared = cachingService.prepareExport(userId, projectId, setOf(1))!! - val result = cachingService.renderStoryAsHtmlPaginated(prepared, cacheable = true) - - assertIs(result) - assertTrue(result.data.pageHtml.contains("Alpha content")) - assertEquals(1, cachedFiles().size, "the share renders the same every time; it should be cached") - } - - @Test - fun `a scene orphaned from its group still renders on the author's full story`() = runTest { - setupMocksForScenes( - listOf( - createScene(id = 1, name = "Chapter 1", content = "", order = 0, sceneType = ApiSceneType.Group), - createScene(id = 2, name = "Scene 1", content = "Attached content", order = 0, path = listOf(0, 1)), - // Parent group 99 does not exist; readers can see this scene, so the author must too. - createScene(id = 3, name = "Lost Scene", content = "Orphaned content", order = 0, path = listOf(0, 99)), - ) - ) - - val result = service.renderStoryAsHtml(userId, projectId) - - assertIs(result) - assertTrue(result.html.contains("Attached content")) - assertTrue(result.html.contains("Orphaned content"), result.html) - } - private fun createScene( id: Int, name: String, @@ -703,12 +304,9 @@ class StoryRendererServiceTest { val entityDefs = scenes.map { EntityDefinition(it.id, ApiProjectEntity.Type.SCENE) } coEvery { datasource.getEntityDefsByType(userId, projectDef, ApiProjectEntity.Type.SCENE) } returns entityDefs - // Mirrors the real column: the stored hash covers the whole serialized entity, so editing a - // scene or moving it changes its hash the way a sync would. - stubSceneHashes( - *scenes.map { EntityHash(it.id, "h${listOf(it.name, it.content, it.order, it.path).hashCode()}") } - .toTypedArray() - ) + // Mirrors the real column: the stored hash covers the scene's content, so editing a scene + // here changes its hash the way a sync would. + stubSceneHashes(*scenes.map { EntityHash(it.id, "h${it.content.hashCode()}") }.toTypedArray()) val entityIdSlot = slot() coEvery { diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasherTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasherTest.kt deleted file mode 100644 index d7d99b627..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/Argon2PasswordHasherTest.kt +++ /dev/null @@ -1,129 +0,0 @@ -package com.darkrockstudios.apps.hammer.utilities - -import org.junit.jupiter.api.Test -import kotlin.test.assertEquals -import kotlin.test.assertFalse -import kotlin.test.assertNotEquals -import kotlin.test.assertTrue - -/** - * The reference-hash fixtures below come from the Argon2 C implementation (libargon2, - * via de.mkammerer:argon2-jvm 2.12), which wrote every password hash on deployed - * servers. They must keep verifying. - */ -class Argon2PasswordHasherTest { - - private val referenceHashes = listOf( - // argon2i at the parameters AccountsRepository hashes with. - "correct horse battery staple" to - "\$argon2i\$v=19\$m=65536,t=3,p=2\$k7m7gU9uModw2lSbVPJ8lQ\$iBwaiktAxMo5yNDbAyxMti4I2wtZjYgsL+jB2RCcKAw", - // A different variant and cost settings, all read back out of the string. - "correct horse battery staple" to - "\$argon2id\$v=19\$m=19456,t=2,p=1\$tlovharpYfIUfTm1m0FOpQ\$s0nGX03Qf8gy426+jDwY0p+kaXmjyiaGpAlXMPcjxTY", - "a" to - "\$argon2d\$v=19\$m=8,t=1,p=1\$FciDFN4R17rjWQgcpzuBLQ\$5sFXlzqDGdvVE3PLHftVmbgIPeD0+ROLXDoD6Ug2fk0", - // A non-ASCII password, which only verifies if both sides encode it as UTF-8. - "caf\u00e9 na\u00efve \u00dfeta" to - "\$argon2i\$v=19\$m=32768,t=2,p=4\$K4OYE6n5R01UtQGT3lgcKA\$al0ciei4LlOHcylR1ZZsYmNXBHDlZ6JJJMSdSZ3f+ec", - ) - - @Test - fun `verifies hashes written by the reference implementation`() { - referenceHashes.forEach { (password, hash) -> - assertTrue( - Argon2PasswordHasher.verify(hash, password.toCharArray()), - "Reference hash $hash must verify", - ) - } - } - - @Test - fun `rejects a wrong password against a reference hash`() { - referenceHashes.forEach { (_, hash) -> - assertFalse( - Argon2PasswordHasher.verify(hash, "not the password".toCharArray()), - "Reference hash $hash must not verify against another password", - ) - } - } - - @Test - fun `verifies a hash carrying no version marker`() { - val hash = "\$argon2i\$m=1024,t=2,p=1\$c2l4dGVlbmJ5dGVzYWx0IQ\$l/Rt3Va9SLakmdDaJnB+MRNtwcxBR8XKsJpNKSEGnro" - - assertTrue(Argon2PasswordHasher.verify(hash, "legacy-format".toCharArray())) - assertFalse(Argon2PasswordHasher.verify(hash, "legacy-formaT".toCharArray())) - } - - @Test - fun `verifies its own hashes`() { - val password = "a password with spaces & symbols !@#" - - val hash = Argon2PasswordHasher.hash(password.toCharArray(), memoryKib = 1024, iterations = 2, parallelism = 1) - - assertTrue(Argon2PasswordHasher.verify(hash, password.toCharArray())) - assertFalse(Argon2PasswordHasher.verify(hash, "a password with spaces & symbols !@".toCharArray())) - assertFalse(Argon2PasswordHasher.verify(hash, "".toCharArray())) - } - - @Test - fun `writes the encoded form the parameters describe`() { - val hash = Argon2PasswordHasher.hash("pw".toCharArray(), memoryKib = 4096, iterations = 5, parallelism = 3) - - val fields = hash.split("$") - assertEquals(listOf("", "argon2i", "v=19", "m=4096,t=5,p=3"), fields.take(4)) - // Base64 without padding: 16 salt bytes and 32 hash bytes. - assertEquals(22, fields[4].length) - assertEquals(43, fields[5].length) - } - - @Test - fun `salts every hash separately`() { - val password = "same password".toCharArray() - - val first = Argon2PasswordHasher.hash(password, memoryKib = 1024, iterations = 2, parallelism = 1) - val second = Argon2PasswordHasher.hash(password, memoryKib = 1024, iterations = 2, parallelism = 1) - - assertNotEquals(first, second) - assertTrue(Argon2PasswordHasher.verify(first, password)) - assertTrue(Argon2PasswordHasher.verify(second, password)) - } - - @Test - fun `treats an unreadable stored hash as a failed verification`() { - val salt = "c2l4dGVlbmJ5dGVzYWx0IQ" - val hash = "l/Rt3Va9SLakmdDaJnB+MRNtwcxBR8XKsJpNKSEGnro" - - val malformed = listOf( - "", - "not a hash at all", - // Bcrypt, in case a server was ever seeded from another tool. - "\$2y\$10\$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy", - // Unknown variant. - "\$argon2x\$v=19\$m=1024,t=2,p=1\$$salt\$$hash", - // Unsupported version. - "\$argon2i\$v=99\$m=1024,t=2,p=1\$$salt\$$hash", - // Missing the hash field. - "\$argon2i\$v=19\$m=1024,t=2,p=1\$$salt", - // Non-numeric and missing cost parameters. - "\$argon2i\$v=19\$m=lots,t=2,p=1\$$salt\$$hash", - "\$argon2i\$v=19\$m=1024,p=1\$$salt\$$hash", - // Memory below the parallelism floor, which the generator silently clamps. - "\$argon2i\$v=19\$m=4,t=2,p=4\$$salt\$$hash", - // Costs a corrupt row could carry that would exhaust the heap or the clock. - "\$argon2i\$v=19\$m=2000000000,t=2,p=1\$$salt\$$hash", - "\$argon2i\$v=19\$m=1024,t=2000000000,p=1\$$salt\$$hash", - // Keyed and associated-data hashes need inputs we don't hold. - "\$argon2i\$v=19\$m=1024,t=2,p=1,keyid=Zm9v\$$salt\$$hash", - // Salt outside the base64 alphabet. - "\$argon2i\$v=19\$m=1024,t=2,p=1\$!!!!\$$hash", - ) - - malformed.forEach { - assertFalse( - Argon2PasswordHasher.verify(it, "legacy-format".toCharArray()), - "Must not verify: $it", - ) - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/EntityHashSensitivityTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/EntityHashSensitivityTest.kt index f3c632a71..3190edbd1 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/EntityHashSensitivityTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/EntityHashSensitivityTest.kt @@ -237,7 +237,6 @@ class EntityHashSensitivityTest { "image.base64" to base.copy(image = base.image!!.copy(base64 = "abcd")), "image.fileExtension" to base.copy(image = base.image!!.copy(fileExtension = "jpg")), "aliases" to base.copy(aliases = listOf("Bobby")), - "excludeFromDictionary" to base.copy(excludeFromDictionary = true), ), ) } @@ -274,8 +273,6 @@ class EntityHashSensitivityTest { theme = ProjectTheme(primary = "p", secondary = "s"), wordCountGoal = WordCountGoal(cadence = WordCountGoal.Cadence.DAY, count = 100), tags = setOf("base-tag"), - language = "en-US", - dictionaryWords = setOf("base-word"), ) Spec( klass = ProjectData::class, @@ -292,9 +289,6 @@ class EntityHashSensitivityTest { "wordCountGoal.cadence" to base.copy(wordCountGoal = base.wordCountGoal!!.copy(cadence = WordCountGoal.Cadence.WEEK)), "wordCountGoal.count" to base.copy(wordCountGoal = base.wordCountGoal!!.copy(count = 999)), "tags" to base.copy(tags = setOf("different")), - "language" to base.copy(language = "fr"), - "encyclopediaDictionary" to base.copy(encyclopediaDictionary = false), - "dictionaryWords" to base.copy(dictionaryWords = setOf("different")), ), ) } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownServiceTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownServiceTest.kt index 702718b87..45279ae50 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownServiceTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/MarkdownServiceTest.kt @@ -1,6 +1,5 @@ package com.darkrockstudios.apps.hammer.utilities -import com.darkrockstudios.apps.hammer.base.markdown.ProseHtml import org.junit.jupiter.api.Test import kotlin.test.assertEquals import kotlin.test.assertFalse @@ -19,41 +18,6 @@ class MarkdownServiceTest { assertTrue(result.contains("italic")) } - @Test - fun `markdownToSafeHtml renders strikethrough`() { - val result = markdownService.markdownToSafeHtml("He was ~~dead~~ alive.") - - assertTrue(result.contains("dead"), result) - assertFalse(result.contains("~~"), result) - } - - @Test - fun `markdownToSafeHtml renders strikethrough alongside other emphasis`() { - val result = markdownService.markdownToSafeHtml("**bold** *italic* ~~struck~~") - - assertTrue(result.contains("bold"), result) - assertTrue(result.contains("italic"), result) - assertTrue(result.contains("struck"), result) - } - - @Test - fun `markdownToSafeHtml keeps strikethrough nested inside emphasis`() { - val result = markdownService.markdownToSafeHtml("He said *hello ~~there~~* now.") - - assertTrue(result.contains("there"), result) - assertFalse(result.contains("~~"), result) - } - - @Test - fun `markdownToSafeHtml does not let authored markup forge a del element`() { - val result = markdownService.markdownToSafeHtml( - "x" - ) - - assertFalse(result.contains("onclick"), result) - assertFalse(result.contains("alert"), result) - } - @Test fun `markdownToSafeHtml renders headings`() { val markdown = "# Heading 1\n## Heading 2" @@ -195,231 +159,4 @@ class MarkdownServiceTest { assertFalse(result.contains("data:")) } - - @Test - fun `markdownToSafeHtml reflows single newlines unless asked to preserve them`() { - val markdown = "First line.\nSecond line." - val result = markdownService.markdownToSafeHtml(markdown) - - assertEquals(1, countTag(result, "p")) - assertEquals(0, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml collapses extra blank lines unless asked to preserve them`() { - val markdown = "First paragraph.\n\n\n\nSecond paragraph." - val result = markdownService.markdownToSafeHtml(markdown) - - assertEquals(0, countBreaks(result)) - assertTrue(result.contains("First paragraph.")) - assertTrue(result.contains("Second paragraph.")) - } - - @Test - fun `markdownToSafeHtml gives every authored line its own paragraph`() { - // An en dash: French dialogue opens with one, and unlike "- " it is not a list marker. - val dash = "–" - val markdown = "$dash Bonsoir madame.\n$dash Ne vous inquietez pas.\n$dash Tres bien." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(3, countTag(result, "p")) - assertTrue(result.contains("

      $dash Bonsoir madame.

      "), result) - assertTrue(result.contains("

      $dash Ne vous inquietez pas.

      "), result) - assertTrue(result.contains("

      $dash Tres bien.

      "), result) - } - - @Test - fun `markdownToSafeHtml keeps emphasis whole when it spans an authored line break`() { - val markdown = "He said *hello\nthere* now." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - // Splitting mid-emphasis would cross the tags; the line stays joined instead. - assertEquals(1, countTag(result, "p")) - assertTrue(result.contains("hello"), result) - assertFalse(result.contains("*"), result) - } - - @Test - fun `markdownToSafeHtml splits a line that is emphasized end to end`() { - val markdown = "*First line.*\n*Second line.*" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(2, countTag(result, "p")) - assertEquals(2, countTag(result, "em")) - } - - @Test - fun `markdownToSafeHtml renders a hard line break as a single line break`() { - val markdown = "First line. \nSecond line." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(2, countTag(result, "p")) - assertEquals(0, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml renders a single blank line as a break`() { - val markdown = "First paragraph.\n\nSecond paragraph." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(1, countBreaks(result)) - assertTrue(result.contains("First paragraph.")) - assertTrue(result.contains("Second paragraph.")) - } - - @Test - fun `markdownToSafeHtml renders each blank line as a break`() { - val markdown = "First paragraph.\n\n\n\nSecond paragraph." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(3, countBreaks(result)) - assertTrue(result.contains("First paragraph.")) - assertTrue(result.contains("Second paragraph.")) - } - - @Test - fun `markdownToSafeHtml caps a runaway run of blank lines`() { - val markdown = "First paragraph." + "\n".repeat(40) + "Second paragraph." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(ProseHtml.MAX_CONSECUTIVE_BREAKS, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml ignores blank lines before the first paragraph`() { - val markdown = "\n\n\n\nFirst paragraph." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml ignores trailing blank lines`() { - val markdown = "First paragraph." + "\n".repeat(6) - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml leaves blank lines around a heading to the heading's own spacing`() { - val markdown = "## Chapter One\n\nFirst paragraph.\n\n\n## Chapter Two" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - assertEquals(2, countTag(result, "h2")) - } - - @Test - fun `markdownToSafeHtml leaves lines and blank lines inside fenced code untouched`() { - val markdown = "```\nfirst\n\n\n\nsecond\n```" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - assertEquals(0, countTag(result, "p")) - assertTrue(result.contains("first")) - assertTrue(result.contains("second")) - } - - @Test - fun `markdownToSafeHtml leaves blank lines inside an indented code block untouched`() { - val markdown = "Intro:\n\n code line one\n\n\n code line two\n\nOutro." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - assertEquals(1, countTag(result, "pre")) - } - - @Test - fun `markdownToSafeHtml keeps a list intact`() { - val markdown = "- item 1\n- item 2\n\n\nAfter the list." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(1, countTag(result, "ul")) - assertEquals(2, countTag(result, "li")) - assertEquals(0, countBreaks(result)) - assertTrue(result.contains("After the list.")) - } - - @Test - fun `markdownToSafeHtml keeps a wrapped list item as one item`() { - val markdown = "- item one\n continued\n- item two" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(2, countTag(result, "li")) - assertEquals(0, countTag(result, "p")) - } - - @Test - fun `markdownToSafeHtml gives a quoted line its own paragraph`() { - val markdown = "> quote line one\n> quote line two" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(1, countTag(result, "blockquote")) - assertEquals(2, countTag(result, "p")) - assertEquals(0, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml renders a blank line inside a quote as a break`() { - val markdown = "> quote line one\n>\n> quote line two" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(1, countTag(result, "blockquote")) - assertEquals(2, countTag(result, "p")) - assertEquals(1, countBreaks(result)) - } - - @Test - fun `markdownToSafeHtml keeps a table intact`() { - val markdown = "| a | b |\n| --- | --- |\n| 1 | 2 |\n\nAfter." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(0, countBreaks(result)) - assertEquals(1, countTag(result, "table")) - assertEquals(2, countTag(result, "th")) - assertEquals(2, countTag(result, "td")) - assertTrue(result.contains("After.")) - } - - @Test - fun `markdownToSafeHtml keeps a table's column alignment`() { - val markdown = "| a | b | c |\n| :--- | :---: | ---: |\n| 1 | 2 | 3 |" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertTrue(result.contains("""align="center""""), result) - assertTrue(result.contains("""align="right""""), result) - } - - @Test - fun `markdownToSafeHtml keeps the number an ordered list starts at`() { - val markdown = "5. Fifth\n6. Sixth" - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertTrue(result.contains("""
        """), result) - } - - @Test - fun `markdownToSafeHtml lays out Windows line endings like any other`() { - val unix = "First line.\nSecond line.\n\nAfter a blank line." - val windows = unix.replace("\n", "\r\n") - - assertEquals( - markdownService.markdownToSafeHtml(unix, preserveLineBreaks = true), - markdownService.markdownToSafeHtml(windows, preserveLineBreaks = true), - ) - } - - @Test - fun `markdownToSafeHtml keeps blocks apart across Windows line endings`() { - val markdown = "- one\r\n- two\r\n\r\nAfter the list." - val result = markdownService.markdownToSafeHtml(markdown, preserveLineBreaks = true) - - assertEquals(2, countTag(result, "li")) - assertTrue(result.contains("

        After the list.

        "), result) - } - - private fun countBreaks(html: String) = Regex("").findAll(html).count() - - private fun countTag(html: String, tag: String) = Regex("<$tag[\\s>]").findAll(html).count() } diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZoneTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZoneTest.kt deleted file mode 100644 index 5282cd965..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utilities/ServerTimeZoneTest.kt +++ /dev/null @@ -1,105 +0,0 @@ -package com.darkrockstudios.apps.hammer.utilities - -import org.junit.jupiter.api.Test -import java.time.ZoneId -import java.util.TimeZone -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith -import kotlin.test.assertTrue - -class ServerTimeZoneTest { - - private fun env(vararg entries: Pair): (String) -> String? { - val map = entries.toMap() - return { map[it] } - } - - @Test - fun `config timezone wins over both environment variables`() { - val zone = resolveServerTimeZone( - configured = "Europe/Paris", - readEnv = env(TIMEZONE_ENV_VAR to "Asia/Tokyo", "TZ" to "America/New_York"), - ) - - assertEquals(ZoneId.of("Europe/Paris"), zone) - } - - @Test - fun `HAMMER_TIMEZONE is used when the config leaves it unset`() { - val zone = resolveServerTimeZone( - configured = null, - readEnv = env(TIMEZONE_ENV_VAR to "Asia/Tokyo", "TZ" to "America/New_York"), - ) - - assertEquals(ZoneId.of("Asia/Tokyo"), zone) - } - - @Test - fun `TZ is used when nothing else sets a zone`() { - val zone = resolveServerTimeZone(configured = null, readEnv = env("TZ" to "America/New_York")) - - assertEquals(ZoneId.of("America/New_York"), zone) - } - - @Test - fun `a TZ with the POSIX colon prefix is accepted`() { - val zone = resolveServerTimeZone(configured = null, readEnv = env("TZ" to ":Europe/Paris")) - - assertEquals(ZoneId.of("Europe/Paris"), zone) - } - - @Test - fun `falls back to the host zone when nothing is set`() { - val zone = resolveServerTimeZone(configured = null, readEnv = env()) - - assertEquals(ZoneId.systemDefault(), zone) - } - - @Test - fun `blank settings are ignored`() { - val zone = resolveServerTimeZone( - configured = " ", - readEnv = env(TIMEZONE_ENV_VAR to "", "TZ" to "Asia/Tokyo"), - ) - - assertEquals(ZoneId.of("Asia/Tokyo"), zone) - } - - @Test - fun `an unknown config timezone aborts with the offending value`() { - val error = assertFailsWith { - resolveServerTimeZone(configured = "Europe/Paree", readEnv = env()) - } - - assertTrue(error.message!!.contains("Europe/Paree"), "Message was: ${error.message}") - } - - @Test - fun `an unknown HAMMER_TIMEZONE aborts`() { - val error = assertFailsWith { - resolveServerTimeZone(configured = null, readEnv = env(TIMEZONE_ENV_VAR to "Not/AZone")) - } - - assertTrue(error.message!!.contains(TIMEZONE_ENV_VAR), "Message was: ${error.message}") - } - - @Test - fun `a POSIX-form TZ falls through to the host zone instead of aborting`() { - val zone = resolveServerTimeZone(configured = null, readEnv = env("TZ" to "CET-1CEST,M3.5.0,M10.5.0/3")) - - assertEquals(ZoneId.systemDefault(), zone) - } - - @Test - fun `applying a zone makes it the JVM default`() { - val original = TimeZone.getDefault() - try { - applyServerTimeZone(ZoneId.of("Pacific/Chatham")) - - assertEquals(ZoneId.of("Pacific/Chatham"), ZoneId.systemDefault()) - } finally { - // Back through apply(), not setDefault(), so the logging config is restored with it. - applyServerTimeZone(original.toZoneId()) - } - } -} diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/BaseTest.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/BaseTest.kt index ff5728049..14e70c26d 100644 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/BaseTest.kt +++ b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/BaseTest.kt @@ -6,7 +6,6 @@ import com.darkrockstudios.apps.hammer.dependencyinjection.DISPATCHER_IO import com.darkrockstudios.apps.hammer.dependencyinjection.DISPATCHER_MAIN import com.darkrockstudios.apps.hammer.dependencyinjection.PROJECTS_SYNC_MANAGER import com.darkrockstudios.apps.hammer.dependencyinjection.PROJECT_SYNC_MANAGER -import com.darkrockstudios.apps.hammer.kudos.StoryKudosRepository import com.darkrockstudios.apps.hammer.monitoring.ErrorRepository import com.darkrockstudios.apps.hammer.monitoring.MetricsRepository import com.darkrockstudios.apps.hammer.monitoring.MonitoringState @@ -21,7 +20,6 @@ import com.darkrockstudios.apps.hammer.project.ProjectSynchronizationSession import com.darkrockstudios.apps.hammer.projects.ProjectsSynchronizationSession import com.darkrockstudios.apps.hammer.scheduling.RecurringTaskRegistry import com.darkrockstudios.apps.hammer.syncsessionmanager.SyncSessionManager -import com.darkrockstudios.apps.hammer.plugin.PluginRegistry import io.ktor.server.application.Application import io.ktor.server.application.install import io.mockk.mockk @@ -118,8 +116,6 @@ fun Application.setupKtorTestKoin(baseTest: BaseTest, vararg modules: Module) { modules( module { - // Route helpers resolve the registry even when no plugins are in play. - single { PluginRegistry(emptyList()) } single(named(DISPATCHER_DEFAULT)) { StandardTestDispatcher( baseTest.scope.testScheduler, @@ -154,7 +150,6 @@ fun Application.setupKtorTestKoin(baseTest: BaseTest, vararg modules: Module) { single { mockk(relaxed = true) } single { mockk(relaxed = true) } single { mockk(relaxed = true) } - single { mockk(relaxed = true) } single { RecurringTaskRegistry() } single>(named(PROJECTS_SYNC_MANAGER)) { mockk(relaxed = true) diff --git a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/TestAccounts.kt b/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/TestAccounts.kt deleted file mode 100644 index 29f6a93c5..000000000 --- a/server/src/test/kotlin/com/darkrockstudios/apps/hammer/utils/TestAccounts.kt +++ /dev/null @@ -1,26 +0,0 @@ -package com.darkrockstudios.apps.hammer.utils - -import com.darkrockstudios.apps.hammer.Account -import kotlin.time.Clock -import kotlin.time.Instant - -/** A plain account row for tests that need the auth gates to see a real account. */ -fun testAccount( - userId: Long = 0L, - email: String = "test@test.com", - isAdmin: Boolean = false, - deletedAt: Instant? = null, -) = Account( - id = userId, - email = email, - pen_name = null, - password_hash = "hash", - cipher_secret = "secret", - created = Clock.System.now(), - is_admin = isAdmin, - last_sync = Clock.System.now(), - bio = null, - email_verified = true, - community_member = false, - deleted_at = deletedAt, -) diff --git a/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/EndToEndTest.kt b/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/EndToEndTest.kt index bee1f99bc..59d9c6308 100644 --- a/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/EndToEndTest.kt +++ b/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/EndToEndTest.kt @@ -18,8 +18,6 @@ import com.darkrockstudios.apps.hammer.utilities.TokenHasher import com.darkrockstudios.apps.hammer.utilities.TouchableFileSystem import com.darkrockstudios.apps.hammer.utilities.DiskCache import com.darkrockstudios.apps.hammer.utilities.cacheDirectory -import com.darkrockstudios.apps.hammer.plugin.ServerPlugin -import com.darkrockstudios.apps.hammer.plugin.installedPlugins import io.ktor.client.* import io.ktor.client.plugins.contentnegotiation.* import io.ktor.serialization.kotlinx.json.* @@ -59,13 +57,6 @@ abstract class EndToEndTest { */ protected open val serverConfig = ServerConfig(encryption = EncryptionConfig(EncryptionMode.AES)) - /** - * Plugins active in the booted server. Defaults to the build's real plugin list so e2e - * runs match production; tests override to add fixtures or to isolate from plugins. - * Plugin fixtures must keep their integrations unconfigured or tests become order-dependent. - */ - protected open val serverPlugins: List = installedPlugins() - /** The OS-assigned port the server bound to; valid after [doStartServer]. */ protected var serverPort: Int = 0 private set @@ -163,7 +154,7 @@ abstract class EndToEndTest { port = 0, host = "0.0.0.0", module = { - appMain(serverConfig, testModule, plugins = serverPlugins) + appMain(serverConfig, testModule) } ) server.start() diff --git a/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/WebEndToEndTest.kt b/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/WebEndToEndTest.kt deleted file mode 100644 index 608ec6d6e..000000000 --- a/server/src/testFixtures/kotlin/com/darkrockstudios/apps/hammer/e2e/util/WebEndToEndTest.kt +++ /dev/null @@ -1,65 +0,0 @@ -package com.darkrockstudios.apps.hammer.e2e.util - -import io.ktor.client.HttpClient -import io.ktor.client.HttpClientConfig -import io.ktor.client.plugins.cookies.HttpCookies -import io.ktor.client.request.post -import io.ktor.client.request.setBody -import io.ktor.http.ContentType -import io.ktor.http.HttpStatusCode -import io.ktor.http.contentType -import kotlinx.coroutines.runBlocking -import java.net.URLEncoder -import kotlin.time.Clock - -/** - * Base for end-to-end tests that drive the web frontend rather than the sync API: seeds a - * whitelisted account and signs it in through the real login form, leaving the session cookie - * on the returned client. - */ -abstract class WebEndToEndTest : EndToEndTest() { - - /** Creates [email] as a whitelisted account, optionally with [penName] already claimed. */ - protected fun seedWhitelistedAccount( - email: String, - password: String, - penName: String? = null, - ) = runBlocking { - E2eTestData.createAccount(TestAccount(email, password), database()) - database().serverDatabase.whiteListQueries - .addToWhiteList(email, Clock.System.now(), "Test author", null) - - if (penName != null) { - val account = database().serverDatabase.accountQueries.findAccount(email).executeAsOne() - database().serverDatabase.accountQueries.updatePenName(penName, account.id) - } - } - - /** - * Signs in over the login form and returns the client holding the session. [configure] adds - * to the client being built, for tests that need a particular transport behaviour. - */ - protected suspend fun login( - email: String, - password: String, - configure: HttpClientConfig<*>.() -> Unit = {}, - ): HttpClient { - val authed = HttpClient { - install(HttpCookies) - configure() - } - - val response = authed.post(route("login")) { - contentType(ContentType.Application.FormUrlEncoded) - setBody( - "email=${URLEncoder.encode(email, "UTF-8")}" + - "&password=${URLEncoder.encode(password, "UTF-8")}" - ) - } - check(response.status == HttpStatusCode.Found) { - "Harness could not log $email in: got ${response.status}" - } - - return authed - } -} diff --git a/settings.gradle.kts b/settings.gradle.kts index b882dd06b..18b0a49c4 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -7,7 +7,7 @@ pluginManagement { } } -// F-Droid can't reach foojay, so skip the toolchain resolver for F-Droid builds. +// F-Droid can't provide JBR or reach foojay, so skip both for F-Droid builds. // The flag is honoured from -Pfdroid=true, an `fdroid` entry in gradle.properties, // or the FDROID_BUILD environment variable - the same sources the module build // scripts read, so a single gradle.properties line drives the whole build. @@ -27,7 +27,5 @@ val isFDroidBuild = providers.gradleProperty("fdroid").orNull?.isNotEmpty() == t val modules = mutableListOf(":base", ":android", ":composeUi", ":common", ":server", ":integrationTests") if (!isFDroidBuild) { modules += ":desktop" - // Depends on Google Play services for phone pairing, so it is not an F-Droid module. - modules += ":wear" } include(*modules.toTypedArray()) diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml index 65691aefa..220026715 100644 --- a/snap/snapcraft.yaml +++ b/snap/snapcraft.yaml @@ -1,13 +1,6 @@ name: hammer-editor -# core24 (glibc 2.39), not core22 (glibc 2.35). A strict snap runs against the -# base's libc, not the host's, so the host having a newer glibc doesn't help: -# libnucleus_tao.so carries a non-weak GLIBC_2.39 version reference (Rust std's -# pidfd_spawnp / pidfd_getpid) and ld.so hard-fails the load on core22 with -# "version `GLIBC_2.39' not found". Nothing else we bundle needs past 2.36. -# core26 would give more headroom, but the gnome extension has no 2604 content -# snap yet. -base: core24 -version: '3.12.0' +base: core22 +version: '3.7.2' summary: A simple tool for building stories description: | Hammer is a multi-platform story editor application. It's designed for @@ -19,25 +12,13 @@ icon: snap/gui/hammer-editor-store.png grade: stable confinement: strict -platforms: - amd64: - -# Spell check needs libhunspell and Hunspell dictionaries, neither of which core24 has. -plugs: - hunspell-dictionaries: - interface: content - target: $SNAP/usr/share/hunspell - default-provider: hunspell-dictionaries-1-7-2004 +architectures: + - build-on: amd64 apps: hammer-editor: command: bin/hammer extensions: [ gnome ] - environment: - # JNA asks for libhunspell-1.7.so; only the versioned .so.0 is staged, which - # JNA matches only when searching an explicit library path. - JAVA_TOOL_OPTIONS: -Djna.library.path=$SNAP/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR - DICPATH: $SNAP/usr/share/hunspell plugs: - home - network @@ -48,7 +29,6 @@ apps: - x11 - opengl - removable-media - - hunspell-dictionaries parts: hammer: @@ -59,51 +39,47 @@ parts: override-build: | set -euo pipefail - # A full JDK, not a JRE: the build resolves its toolchain to this - # JVM and jpackage bundles it into lib/runtime/, so jlink and - # jpackage have to be present. - echo "Downloading Temurin JDK..." - wget https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.12%2B8/OpenJDK21U-jdk_x64_linux_hotspot_21.0.12_8.tar.gz -O jdk.tar.gz - echo "e4446ff06a276155697597cc0f1b15da004ff083f4964a35271ecee567177370 jdk.tar.gz" | sha256sum -c - - tar -xzf jdk.tar.gz - export JAVA_HOME=$PWD/jdk-21.0.12+8 + # Download and setup JetBrains Runtime SDK (full JDK with jlink/jpackage) + # createDistributable bundles whatever JVM is in JAVA_HOME, so any + # silent fall-through to the container's OpenJDK ships a non-JBR + # runtime and the app crashes on startup with the Nucleus check. + echo "Downloading JetBrains Runtime SDK..." + wget https://cache-redirector.jetbrains.com/intellij-jbr/jbrsdk_jcef-21.0.9-linux-x64-b1163.86.tar.gz + tar -xzf jbrsdk_jcef-21.0.9-linux-x64-b1163.86.tar.gz + export JAVA_HOME=$PWD/jbrsdk_jcef-21.0.9-linux-x64-b1163.86 export PATH=$JAVA_HOME/bin:$PATH - # Fail fast if the extract didn't produce a usable toolchain. + # Fail fast if the JBR SDK extract didn't produce a usable toolchain. test -x "$JAVA_HOME/bin/java" test -x "$JAVA_HOME/bin/jlink" test -x "$JAVA_HOME/bin/jpackage" - echo "Building with JDK (JAVA_HOME=$JAVA_HOME)" + echo "Building with JBR SDK (JAVA_HOME=$JAVA_HOME)" java -version + # Run gradle build with createDistributable + # This will now bundle JBR (not OpenJDK) in lib/runtime/ chmod +x ./gradlew - ./gradlew :desktop:jvmJar -Pchannel=snap -Pformat=snap --no-daemon - ./gradlew :desktop:createDistributable -Pchannel=snap -Pformat=snap -x desktopTest --no-daemon - - # The installers/ path comes from outputBaseDir in - # desktop/build.gradle.kts; the app tree carries its own JVM at - # lib/runtime/, which the launcher below points JAVA_HOME at. + # First build all necessary JARs, then create the distributable + ./gradlew :desktop:jvmJar --no-daemon + ./gradlew :desktop:createDistributable -x desktopTest --no-daemon + # Copy the gradle output to the install directory + # Note: outputBaseDir is set to 'installers' in build.gradle.kts + # This includes the bundled JBR at lib/runtime/ mkdir -p $CRAFT_PART_INSTALL/lib cp -r desktop/build/installers/main/app/hammer $CRAFT_PART_INSTALL/lib/hammer - + # Create the bin directory and launcher script + # Use the bundled JBR runtime instead of system OpenJDK mkdir -p $CRAFT_PART_INSTALL/bin cat > $CRAFT_PART_INSTALL/bin/hammer << 'EOF' #!/bin/bash + # Use the bundled JetBrains Runtime (JBR) that comes with the distributable export JAVA_HOME=$SNAP/lib/hammer/lib/runtime export PATH=$JAVA_HOME/bin:$PATH exec $SNAP/lib/hammer/bin/hammer "$@" EOF chmod +x $CRAFT_PART_INSTALL/bin/hammer - hunspell: - plugin: nil - stage-packages: - - libhunspell-1.7-0 - override-build: | - # Mount point for the hunspell-dictionaries content plug. - mkdir -p $CRAFT_PART_INSTALL/usr/share/hunspell - desktop-entry: plugin: dump source: snap/gui diff --git a/wear/build.gradle.kts b/wear/build.gradle.kts deleted file mode 100644 index 7fff5420a..000000000 --- a/wear/build.gradle.kts +++ /dev/null @@ -1,123 +0,0 @@ -import com.darkrockstudios.build.getWearVersionCode -import org.jetbrains.kotlin.gradle.dsl.JvmTarget - -val RELEASE_STORE_FILE = System.getenv("RELEASE_STORE_FILE") ?: "/" -val RELEASE_STORE_PASSWORD = System.getenv("RELEASE_STORE_PASSWORD") ?: "" -val RELEASE_KEY_ALIAS = System.getenv("RELEASE_KEY_ALIAS") ?: "" -val RELEASE_KEY_PASSWORD = System.getenv("RELEASE_KEY_PASSWORD") ?: "" - -// Wear OS 3 is the first release that runs standalone apps like this one. -val WEAR_MIN_SDK = 30 - -plugins { - alias(libs.plugins.android.application) - alias(libs.plugins.kotlin.serialization) - alias(libs.plugins.compose.compiler) -} - -group = "com.darkrockstudios.apps.hammer" -version = libs.versions.app.get() - -dependencies { - implementation(project(":common")) - implementation(libs.activity.compose) - implementation(libs.koin.android) - implementation(libs.decompose.compose) - implementation(libs.decompose.android) - implementation(libs.work.runtime.ktx) - implementation(libs.androidx.datastore) - implementation(libs.wear.compose.material3) - implementation(libs.wear.compose.foundation) - implementation(libs.wear.compose.ui.tooling) - implementation(libs.wear.input) - implementation(libs.wear.tiles) - implementation(libs.wear.protolayout) - implementation(libs.wear.protolayout.material3) - implementation(libs.wear.protolayout.expression) - implementation(libs.wear.complications.datasource) - implementation(libs.concurrent.futures) - debugImplementation(libs.wear.tiles.tooling) - implementation(libs.wear.tiles.tooling.preview) - implementation(libs.play.services.wearable) - implementation(libs.coroutines.play.services) - implementation(libs.lifecycle.process) - implementation(libs.core.splashscreen) - debugImplementation(libs.jetbrains.compose.ui.tooling) - - testImplementation(platform(libs.junit.bom)) - testImplementation(libs.bundles.junit.jupiter) - testRuntimeOnly(libs.junit.platform.launcher) - testImplementation(libs.coroutines.test) - testImplementation(libs.koin.test) - testImplementation(libs.mockk) - testImplementation(libs.jetbrains.compose.components.resources) - testImplementation(libs.tomlkt) - testImplementation(libs.okio.fakefilesystem) -} - -android { - namespace = "com.darkrockstudios.apps.hammer.wear" - compileSdk = libs.versions.android.sdk.compile.get().toInt() - defaultConfig { - // Shares the phone's id so Play lists both under one app and the Data Layer pairs them. - applicationId = "com.darkrockstudios.apps.hammer.android" - minSdk = WEAR_MIN_SDK - targetSdk = libs.versions.android.sdk.target.get().toInt() - versionCode = getWearVersionCode(libs.versions.app.get()) - versionName = libs.versions.app.get() - } - buildFeatures { - compose = true - buildConfig = true - } - compileOptions { - sourceCompatibility = JavaVersion.toVersion(libs.versions.jvm.get().toInt()) - targetCompatibility = JavaVersion.toVersion(libs.versions.jvm.get().toInt()) - } - signingConfigs { - create("release") { - keyAlias = RELEASE_KEY_ALIAS - keyPassword = RELEASE_KEY_PASSWORD - storeFile = file(RELEASE_STORE_FILE) - storePassword = RELEASE_STORE_PASSWORD - } - } - buildTypes { - debug { - applicationIdSuffix = ".dev" - versionNameSuffix = "-dev" - } - release { - isMinifyEnabled = true - isShrinkResources = true - - signingConfig = signingConfigs.getByName("release") - - proguardFiles( - getDefaultProguardFile("proguard-android-optimize.txt"), - rootProject.file("proguard-common.pro"), - file("proguard-rules.pro"), - ) - } - } - testOptions { - unitTests.isReturnDefaultValues = true - } - packaging { - resources { - excludes += setOf( - "/META-INF/{AL2.0,LGPL2.1}", - "/META-INF/versions/9/previous-compilation-data.bin", - "/META-INF/LICENSE.md", - "/META-INF/LICENSE-notice.md" - ) - } - } -} - -kotlin { - jvmToolchain(libs.versions.jvm.get().toInt()) - compilerOptions { - jvmTarget.set(JvmTarget.fromTarget(libs.versions.jvm.get())) - } -} diff --git a/wear/proguard-rules.pro b/wear/proguard-rules.pro deleted file mode 100644 index 6b586e597..000000000 --- a/wear/proguard-rules.pro +++ /dev/null @@ -1 +0,0 @@ -# Wear-only rules. Rules shared with the phone app live in /proguard-common.pro. diff --git a/wear/src/main/AndroidManifest.xml b/wear/src/main/AndroidManifest.xml deleted file mode 100644 index 73dadfc6b..000000000 --- a/wear/src/main/AndroidManifest.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/CaptureActivity.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/CaptureActivity.kt deleted file mode 100644 index 5076dc6ef..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/CaptureActivity.kt +++ /dev/null @@ -1,160 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear - -import android.app.Activity -import android.app.RemoteInput -import android.content.Context -import android.content.Intent -import android.os.Bundle -import androidx.activity.ComponentActivity -import androidx.activity.compose.BackHandler -import androidx.activity.compose.rememberLauncherForActivityResult -import androidx.activity.compose.setContent -import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen -import androidx.activity.result.contract.ActivityResultContracts -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue -import androidx.compose.ui.res.stringResource -import androidx.wear.compose.material3.AppScaffold -import androidx.wear.compose.material3.SwipeToDismissBox -import androidx.wear.compose.material3.TimeText -import androidx.wear.input.RemoteInputIntentHelper -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.arkivanov.decompose.retainedComponent -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture -import com.darkrockstudios.apps.hammer.wear.components.capture.CaptureComponent -import com.darkrockstudios.apps.hammer.wear.ui.CaptureScreen -import com.darkrockstudios.apps.hammer.wear.ui.theme.HammerWearTheme -import org.koin.android.ext.android.get -import org.koin.core.qualifier.named - -private const val REMOTE_INPUT_KEY = "capture_text" - -/** Entry point for the tile, the complication, and the app's own capture buttons. */ -class CaptureActivity : ComponentActivity() { - - override fun onCreate(savedInstanceState: Bundle?) { - val splash = installSplashScreen() - super.onCreate(savedInstanceState) - - val mode = runCatching { Capture.Mode.valueOf(intent.getStringExtra(EXTRA_MODE).orEmpty()) } - .getOrDefault(Capture.Mode.Note) - - val pickProject = intent.getStringExtra(EXTRA_PICK_PROJECT).toBoolean() - - val component = retainedComponent { componentContext -> - CaptureComponent( - componentContext = componentContext, - mode = mode, - startWithPicker = pickProject, - captureTargets = get(), - subscriptions = get(), - captureUseCase = get(), - appScope = get(named(APP_SCOPE)), - ) - } - // Note mode reads the project list before it can prompt; keep the icon up instead of a bare screen. - splash.setKeepOnScreenCondition { component.state.value.loading } - - setContent { - HammerWearTheme { - CaptureUi(component = component, onDone = ::finish) - } - } - } - - companion object { - /** Read by the tile, which builds its launch action rather than an Intent. */ - const val EXTRA_MODE = "capture_mode" - - /** Lets the tile's project name act as "change this", which it cannot do itself. */ - const val EXTRA_PICK_PROJECT = "capture_pick_project" - - fun intent(context: Context, mode: Capture.Mode, pickProject: Boolean = false): Intent = - Intent(context, CaptureActivity::class.java) - .putExtra(EXTRA_MODE, mode.name) - .putExtra(EXTRA_PICK_PROJECT, pickProject.toString()) - } -} - -@Composable -private fun CaptureUi(component: Capture, onDone: () -> Unit) { - val state by component.state.subscribeAsState() - var prompted by rememberSaveable { mutableStateOf(false) } - - val label = stringResource( - if (state.mode == Capture.Mode.Idea) R.string.capture_title_idea else R.string.capture_title_note - ) - - val launcher = rememberLauncherForActivityResult(ActivityResultContracts.StartActivityForResult()) { result -> - val data = result.data - if (result.resultCode != Activity.RESULT_OK || data == null) return@rememberLauncherForActivityResult - RemoteInput.getResultsFromIntent(data) - ?.getCharSequence(REMOTE_INPUT_KEY) - ?.toString() - ?.let(component::onTextEntered) - } - - fun promptForText() { - val intent = RemoteInputIntentHelper.createActionRemoteInputIntent() - RemoteInputIntentHelper.putRemoteInputsExtra( - intent, - listOf(RemoteInput.Builder(REMOTE_INPUT_KEY).setLabel(label).build()), - ) - launcher.launch(intent) - } - - // Dictation is the point of the feature, so it opens without a tap standing in the way. It waits - // for the component to settle first: prompting before we know there is a project to save to - // would take a whole dictated note and then throw it away on the "no project" screen. - LaunchedEffect(state.loading, state.outcome, state.pickingProject) { - if (!prompted && !state.loading && state.outcome == null && !state.pickingProject) { - prompted = true - promptForText() - } - } - - // One way out, whether it came from the swipe or the back button. Leaving is only immediate - // when there is nothing to lose. - fun exit() { - when { - state.confirmingDiscard -> component.cancelDiscard() - state.pickingProject -> component.dismissProjectPicker() - state.hasUnsavedWork -> component.requestDiscard() - else -> onDone() - } - } - - val layered = state.pickingProject || state.confirmingDiscard - BackHandler(enabled = layered || state.hasUnsavedWork) { exit() } - - AppScaffold(timeText = { TimeText() }) { - SwipeToDismissBox( - onDismissed = ::exit, - backgroundKey = false, - contentKey = layered, - // Disabled only when the gesture can safely fall through to finishing the activity. - userSwipeEnabled = layered || state.hasUnsavedWork, - ) { isBackground -> - CaptureScreen( - state = if (isBackground) { - state.copy(pickingProject = false, confirmingDiscard = false) - } else { - state - }, - onEditText = ::promptForText, - onShowProjectPicker = component::showProjectPicker, - onSelectProject = component::selectProject, - onDismissProjectPicker = component::dismissProjectPicker, - onCancelDiscard = component::cancelDiscard, - onDiscard = onDone, - onSave = component::save, - onDone = onDone, - ) - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/HammerWearApplication.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/HammerWearApplication.kt deleted file mode 100644 index 1dc8c0d38..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/HammerWearApplication.kt +++ /dev/null @@ -1,55 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear - -import android.app.Application -import com.darkrockstudios.apps.hammer.common.FileLogger -import com.darkrockstudios.apps.hammer.common.data.migrator.DataMigrator -import com.darkrockstudios.apps.hammer.common.dependencyinjection.NapierLogger -import com.darkrockstudios.apps.hammer.common.dependencyinjection.appModule -import com.darkrockstudios.apps.hammer.common.dependencyinjection.mainModule -import com.darkrockstudios.apps.hammer.common.installGlobalExceptionHandler -import com.darkrockstudios.apps.hammer.common.logStartupBanner -import com.darkrockstudios.apps.hammer.common.setInternalDirectories -import com.darkrockstudios.apps.hammer.wear.dependencyinjection.wearModule -import com.darkrockstudios.apps.hammer.wear.sync.SyncScheduler -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.SupervisorJob -import kotlinx.coroutines.cancel -import kotlinx.coroutines.runBlocking -import org.koin.android.ext.koin.androidContext -import org.koin.core.context.GlobalContext.startKoin -import org.koin.java.KoinJavaComponent.getKoin - -class HammerWearApplication : Application() { - - private val applicationScope = CoroutineScope(SupervisorJob() + Dispatchers.Default) - - override fun onCreate() { - super.onCreate() - - setInternalDirectories(this) - Napier.base(FileLogger(scope = applicationScope)) - installGlobalExceptionHandler() - logStartupBanner() - - startKoin { - logger(NapierLogger()) - androidContext(this@HammerWearApplication) - modules( - mainModule, - appModule(applicationScope), - wearModule, - ) - } - - runBlocking { getKoin().get(DataMigrator::class).handleDataMigration() } - - getKoin().get(SyncScheduler::class).start() - } - - override fun onTerminate() { - super.onTerminate() - applicationScope.cancel("Application onTerminate") - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/MainActivity.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/MainActivity.kt deleted file mode 100644 index 7467c9c90..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/MainActivity.kt +++ /dev/null @@ -1,46 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear - -import android.os.Build -import android.os.Bundle -import androidx.activity.ComponentActivity -import androidx.activity.compose.setContent -import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen -import com.arkivanov.decompose.retainedComponent -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import com.darkrockstudios.apps.hammer.wear.components.WearRootComponent -import com.darkrockstudios.apps.hammer.wear.ui.WearRootUi -import com.darkrockstudios.apps.hammer.wear.ui.theme.HammerWearTheme -import org.koin.android.ext.android.get -import org.koin.core.qualifier.named - -class MainActivity : ComponentActivity() { - override fun onCreate(savedInstanceState: Bundle?) { - installSplashScreen() - super.onCreate(savedInstanceState) - - val root = retainedComponent { componentContext -> - WearRootComponent( - componentContext = componentContext, - globalSettingsStore = get(), - phonePairing = get(), - accountUseCase = get(), - listProjects = get(), - projectsRepository = get(), - subscriptions = get(), - unsyncedContent = get(), - syncCoordinator = get(), - signOutUseCase = get(), - localNetworkAccess = get(), - appScope = get(named(APP_SCOPE)), - strRes = get(), - deviceLabel = Build.MODEL, - ) - } - - setContent { - HammerWearTheme { - WearRootUi(root) - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/complication/CaptureComplicationService.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/complication/CaptureComplicationService.kt deleted file mode 100644 index 0508183fb..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/complication/CaptureComplicationService.kt +++ /dev/null @@ -1,81 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.complication - -import android.app.PendingIntent -import android.graphics.drawable.Icon -import androidx.wear.watchface.complications.data.ComplicationData -import androidx.wear.watchface.complications.data.ComplicationType -import androidx.wear.watchface.complications.data.MonochromaticImage -import androidx.wear.watchface.complications.data.MonochromaticImageComplicationData -import androidx.wear.watchface.complications.data.PlainComplicationText -import androidx.wear.watchface.complications.data.ShortTextComplicationData -import androidx.wear.watchface.complications.datasource.ComplicationRequest -import androidx.wear.watchface.complications.datasource.SuspendingComplicationDataSourceService -import com.darkrockstudios.apps.hammer.wear.CaptureActivity -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture -import com.darkrockstudios.apps.hammer.wear.data.CaptureTileState -import com.darkrockstudios.apps.hammer.wear.data.CaptureTileStateUseCase -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject - -/** A watch face shortcut into dictating a note, showing what is still waiting to sync. */ -class CaptureComplicationService : SuspendingComplicationDataSourceService(), KoinComponent { - - private val tileState: CaptureTileStateUseCase by inject() - - override fun getPreviewData(type: ComplicationType): ComplicationData? = - complicationData(type, CaptureTileState(pending = 2)) - - override suspend fun onComplicationRequest(request: ComplicationRequest): ComplicationData? { - val state = try { - tileState.load() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to read the capture complication's state", e) - CaptureTileState() - } - return complicationData(request.complicationType, state) - } - - private fun complicationData(type: ComplicationType, state: CaptureTileState): ComplicationData? { - val description = PlainComplicationText.Builder(getString(R.string.complication_description)).build() - return when (type) { - ComplicationType.SHORT_TEXT -> ShortTextComplicationData.Builder( - text = PlainComplicationText.Builder(shortText(state)).build(), - contentDescription = description, - ) - .setMonochromaticImage(icon()) - .setTapAction(captureIntent()) - .build() - - ComplicationType.MONOCHROMATIC_IMAGE -> MonochromaticImageComplicationData.Builder( - monochromaticImage = icon(), - contentDescription = description, - ) - .setTapAction(captureIntent()) - .build() - - else -> null - } - } - - /** The count is the useful number; the label is the fallback when there is nothing waiting. */ - private fun shortText(state: CaptureTileState): String { - val pending = state.pending - return if (pending != null && pending > 0) pending.toString() else getString(R.string.tile_note) - } - - private fun icon() = MonochromaticImage.Builder( - Icon.createWithResource(this, R.drawable.ic_launcher_monochrome) - ).build() - - private fun captureIntent(): PendingIntent = PendingIntent.getActivity( - this, - 0, - CaptureActivity.intent(this, Capture.Mode.Note), - PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT, - ) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRoot.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRoot.kt deleted file mode 100644 index 70b744f97..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRoot.kt +++ /dev/null @@ -1,43 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components - -import com.arkivanov.decompose.router.stack.ChildStack -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.wear.components.pairing.Pairing -import com.darkrockstudios.apps.hammer.wear.components.projects.WearProjects -import com.darkrockstudios.apps.hammer.wear.components.signin.ManualSignIn -import com.darkrockstudios.apps.hammer.wear.components.synclog.SyncLog -import kotlinx.serialization.Serializable - -interface WearRoot { - val stack: Value> - - fun showPairing() - fun showManualSignIn() - fun onBack() - - @Serializable - sealed interface Config { - @Serializable - data object Onboarding : Config - - @Serializable - data object Pairing : Config - - @Serializable - data object ManualSignIn : Config - - @Serializable - data object Projects : Config - - @Serializable - data object SyncLog : Config - } - - sealed interface Destination { - data object Onboarding : Destination - data class PairingDestination(val component: Pairing) : Destination - data class ManualSignInDestination(val component: ManualSignIn) : Destination - data class ProjectsDestination(val component: WearProjects) : Destination - data class SyncLogDestination(val component: SyncLog) : Destination - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponent.kt deleted file mode 100644 index 1279658c0..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponent.kt +++ /dev/null @@ -1,141 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.router.stack.ChildStack -import com.arkivanov.decompose.router.stack.StackNavigation -import com.arkivanov.decompose.router.stack.childStack -import com.arkivanov.decompose.router.stack.pop -import com.arkivanov.decompose.router.stack.pushNew -import com.arkivanov.decompose.router.stack.replaceAll -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.wear.components.pairing.PairingComponent -import com.darkrockstudios.apps.hammer.wear.components.projects.WearProjectsComponent -import com.darkrockstudios.apps.hammer.wear.components.signin.ManualSignInComponent -import com.darkrockstudios.apps.hammer.wear.components.synclog.SyncLogComponent -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.LocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.data.SignOutUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import com.darkrockstudios.apps.hammer.wear.data.isSignedIn -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingUseCase -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class WearRootComponent( - componentContext: ComponentContext, - private val globalSettingsStore: GlobalSettingsStore, - private val phonePairing: PhonePairingUseCase, - private val accountUseCase: AccountUseCase, - private val listProjects: ListWatchProjectsUseCase, - private val projectsRepository: ProjectsRepository, - private val subscriptions: SubscribedProjectsRepository, - private val unsyncedContent: UnsyncedContentUseCase, - private val syncCoordinator: SyncCoordinator, - private val signOutUseCase: SignOutUseCase, - private val localNetworkAccess: LocalNetworkAccess, - private val appScope: CoroutineScope, - private val strRes: StrRes, - private val deviceLabel: String, -) : ComponentBase(componentContext), WearRoot { - - private val navigation = StackNavigation() - - override val stack: Value> = childStack( - source = navigation, - serializer = WearRoot.Config.serializer(), - initialConfiguration = if (globalSettingsStore.serverSettings.isSignedIn()) { - WearRoot.Config.Projects - } else { - WearRoot.Config.Onboarding - }, - handleBackButton = true, - childFactory = ::createChild, - ) - - override fun onCreate() { - super.onCreate() - scope.launch { - globalSettingsStore.serverSettingsUpdates.collect { settings -> - withContext(dispatcherMain) { - val signedIn = settings.isSignedIn() - val onboarding = stack.value.items.none { it.configuration == WearRoot.Config.Projects } - if (signedIn && onboarding) { - navigation.replaceAll(WearRoot.Config.Projects) - } else if (!signedIn && !onboarding) { - navigation.replaceAll(WearRoot.Config.Onboarding) - } - } - } - } - } - - override fun showPairing() { - navigation.pushNew(WearRoot.Config.Pairing) - } - - override fun showManualSignIn() { - navigation.pushNew(WearRoot.Config.ManualSignIn) - } - - override fun onBack() { - if (stack.value.backStack.isNotEmpty()) { - navigation.pop() - } - } - - private fun createChild( - config: WearRoot.Config, - componentContext: ComponentContext, - ): WearRoot.Destination = when (config) { - WearRoot.Config.Onboarding -> WearRoot.Destination.Onboarding - - WearRoot.Config.Pairing -> WearRoot.Destination.PairingDestination( - PairingComponent( - componentContext = componentContext, - phonePairing = phonePairing, - deviceLabel = deviceLabel, - onCancel = ::onBack, - ) - ) - - WearRoot.Config.ManualSignIn -> WearRoot.Destination.ManualSignInDestination( - ManualSignInComponent( - componentContext = componentContext, - accountUseCase = accountUseCase, - localNetworkAccess = localNetworkAccess, - strRes = strRes, - ) - ) - - WearRoot.Config.Projects -> WearRoot.Destination.ProjectsDestination( - WearProjectsComponent( - componentContext = componentContext, - globalSettingsStore = globalSettingsStore, - listProjects = listProjects, - projectsRepository = projectsRepository, - subscriptions = subscriptions, - unsyncedContent = unsyncedContent, - syncCoordinator = syncCoordinator, - signOutUseCase = signOutUseCase, - localNetworkAccess = localNetworkAccess, - appScope = appScope, - onShowSyncLog = { navigation.pushNew(WearRoot.Config.SyncLog) }, - ) - ) - - WearRoot.Config.SyncLog -> WearRoot.Destination.SyncLogDestination( - SyncLogComponent( - componentContext = componentContext, - syncCoordinator = syncCoordinator, - ) - ) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/Capture.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/Capture.kt deleted file mode 100644 index 96cb0aed3..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/Capture.kt +++ /dev/null @@ -1,53 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.capture - -import com.arkivanov.decompose.value.Value - -interface Capture { - val state: Value - - /** The text dictated or typed through `RemoteInput`. */ - fun onTextEntered(text: String) - fun showProjectPicker() - fun selectProject(projectName: String) - fun dismissProjectPicker() - - /** Asks before leaving with writing that was never saved. */ - fun requestDiscard() - fun cancelDiscard() - fun save() - - enum class Mode { Note, Idea } - - data class State( - val mode: Mode, - val text: String = "", - /** The projects a note can go to: subscribed ones, whose ids the server already knows. */ - val projects: List = emptyList(), - val projectName: String? = null, - val pickingProject: Boolean = false, - val confirmingDiscard: Boolean = false, - val loading: Boolean = true, - val saving: Boolean = false, - val outcome: Outcome? = null, - ) { - val canSave: Boolean - get() = text.isNotBlank() && !saving && - (mode == Mode.Idea || projectName != null) - - /** - * Writing that leaving would destroy. A save already in flight does not count: it finishes - * outside the screen either way. - */ - val hasUnsavedWork: Boolean - get() = text.isNotBlank() && !saving && outcome == null - } - - sealed interface Outcome { - /** [pending] is null until the count has been gathered, which happens after the save. */ - data class Saved(val pending: Int? = null) : Outcome - - /** No project is kept on the watch, so a note has nowhere to go. */ - data object NoProjects : Outcome - data object Failed : Outcome - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponent.kt deleted file mode 100644 index c3182d696..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponent.kt +++ /dev/null @@ -1,144 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.capture - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.wear.data.CaptureResult -import com.darkrockstudios.apps.hammer.wear.data.CaptureTarget -import com.darkrockstudios.apps.hammer.wear.data.CaptureTargets -import com.darkrockstudios.apps.hammer.wear.data.CaptureTargetsUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.WatchProject -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class CaptureComponent( - componentContext: ComponentContext, - private val mode: Capture.Mode, - private val startWithPicker: Boolean = false, - private val captureTargets: CaptureTargetsUseCase, - private val subscriptions: SubscribedProjectsRepository, - private val captureUseCase: CaptureUseCase, - private val appScope: CoroutineScope, -) : ComponentBase(componentContext), Capture { - - private val _state = MutableValue(Capture.State(mode = mode)) - override val state: Value = _state - - // Only touched on the main dispatcher. - private var targets: List = emptyList() - - override fun onCreate() { - super.onCreate() - if (mode == Capture.Mode.Idea) { - _state.update { it.copy(loading = false) } - } else { - scope.launch { loadTargets() } - } - } - - override fun onTextEntered(text: String) { - _state.update { it.copy(text = text.trim()) } - } - - override fun showProjectPicker() { - if (targets.isEmpty()) return - _state.update { it.copy(pickingProject = true) } - } - - override fun selectProject(projectName: String) { - val target = targets.find { it.projectDef.name == projectName } ?: return - _state.update { it.copy(projectName = projectName, pickingProject = false) } - target.projectId?.let { projectId -> - appScope.launch { subscriptions.setLastCaptureProject(projectId) } - } - } - - override fun dismissProjectPicker() { - _state.update { it.copy(pickingProject = false) } - } - - override fun requestDiscard() { - if (!_state.value.hasUnsavedWork) return - _state.update { it.copy(confirmingDiscard = true, pickingProject = false) } - } - - override fun cancelDiscard() { - _state.update { it.copy(confirmingDiscard = false) } - } - - override fun save() { - val current = _state.value - if (!current.canSave) return - - val target = when (current.mode) { - Capture.Mode.Idea -> CaptureTarget.Idea - Capture.Mode.Note -> { - val projectDef = targets.find { it.projectDef.name == current.projectName }?.projectDef ?: return - CaptureTarget.Note(projectDef) - } - } - - _state.update { it.copy(saving = true, confirmingDiscard = false) } - // Outlives the screen: a capture must land even if the watch drops the activity mid-save. - appScope.launch { - val result = captureUseCase.capture(target, current.text) - withContext(dispatcherMain) { - _state.update { - it.copy( - saving = false, - outcome = when (result) { - CaptureResult.Saved -> Capture.Outcome.Saved() - CaptureResult.Empty, CaptureResult.Failed -> Capture.Outcome.Failed - }, - ) - } - } - - if (result != CaptureResult.Saved) return@launch - - // The user has already been told their words are safe; the count only fills in the rest. - val pending = captureUseCase.pendingCount() ?: return@launch - withContext(dispatcherMain) { - _state.update { - if (it.outcome is Capture.Outcome.Saved) { - it.copy(outcome = Capture.Outcome.Saved(pending)) - } else { - it - } - } - } - } - } - - private suspend fun loadTargets() { - val loaded = try { - captureTargets.load() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to list the projects a note could go to", e) - CaptureTargets() - } - - withContext(dispatcherMain) { - targets = loaded.projects - _state.update { - it.copy( - projects = loaded.projects.map { project -> project.projectDef.name }, - projectName = loaded.default?.projectDef?.name, - // Only worth showing when there is a choice to make. - pickingProject = startWithPicker && loaded.projects.size > 1, - loading = false, - outcome = if (loaded.projects.isEmpty()) Capture.Outcome.NoProjects else it.outcome, - ) - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/Pairing.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/Pairing.kt deleted file mode 100644 index 36e89a4a6..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/Pairing.kt +++ /dev/null @@ -1,11 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.pairing - -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.wear.pairing.PairingState - -interface Pairing { - val state: Value - - fun startPairing() - fun cancel() -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/PairingComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/PairingComponent.kt deleted file mode 100644 index fe4778f29..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/pairing/PairingComponent.kt +++ /dev/null @@ -1,46 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.pairing - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.wear.pairing.PairingState -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingUseCase -import com.darkrockstudios.apps.hammer.wear.pairing.inFlight -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class PairingComponent( - componentContext: ComponentContext, - private val phonePairing: PhonePairingUseCase, - private val deviceLabel: String, - private val onCancel: () -> Unit, -) : ComponentBase(componentContext), Pairing { - - private val _state = MutableValue(phonePairing.state.value) - override val state: Value = _state - - override fun onCreate() { - super.onCreate() - scope.launch { - phonePairing.state.collect { pairingState -> - withContext(dispatcherMain) { _state.value = pairingState } - } - } - // The state outlives this screen, so only a request still in flight is worth resuming. Any - // finished state is stale: a Paired left over from before a sign out would otherwise strand - // the screen on "Paired" with no way to try again. - if (!phonePairing.state.value.inFlight) { - startPairing() - } - } - - override fun startPairing() { - scope.launch { phonePairing.startPairing(deviceLabel) } - } - - override fun cancel() { - phonePairing.reset() - onCancel() - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjects.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjects.kt deleted file mode 100644 index e29c9c607..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjects.kt +++ /dev/null @@ -1,61 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.projects - -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome - -interface WearProjects { - val state: Value - - fun toggleSubscription(projectName: String) - fun syncNow() - fun showSyncLog() - fun signOut() - fun confirmSignOut() - fun cancelSignOut() - fun dismissNotice() - - /** Called once the local network prompt is answered, whichever way. */ - fun onLocalNetworkPermissionResult() - - data class State( - val accountEmail: String? = null, - val projects: List = emptyList(), - val loaded: Boolean = false, - val syncing: Boolean = false, - val lastSyncFailed: Boolean = false, - val needsReauth: Boolean = false, - val signOutWarning: SignOutWarning? = null, - /** True while the unsynced captures are being counted, before the warning can be shown. */ - val checkingSignOut: Boolean = false, - val notice: Notice? = null, - /** - * The server is on the local network and the app is not allowed to reach it. Nothing syncs - * until that changes. - */ - val localNetworkBlocked: Boolean = false, - ) - - /** The outcome of an unsubscribe that did not simply remove the project. */ - data class Notice(val projectName: String, val reason: Reason) { - enum class Reason { - /** Writing the server has not accepted yet, so the project was left alone. */ - UnsyncedKept, - - /** The unsubscribe itself failed, which says nothing about whether anything is unsynced. */ - Failed, - } - } - - /** [canSubscribe] is false until account sync has registered the project with the server. */ - data class ProjectRow( - val name: String, - val canSubscribe: Boolean, - val subscribed: Boolean, - val unsubscribing: Boolean = false, - val progress: Float? = null, - val outcome: ProjectSyncOutcome? = null, - ) - - /** [items] is zero when the count could not be read, which still warrants a warning. */ - data class SignOutWarning(val items: Int) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponent.kt deleted file mode 100644 index 8ccff03e8..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponent.kt +++ /dev/null @@ -1,280 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.projects - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.LocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.data.SignOutUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import com.darkrockstudios.apps.hammer.wear.data.WatchProject -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import com.darkrockstudios.apps.hammer.wear.sync.SyncStatus -import com.darkrockstudios.apps.hammer.wear.sync.SyncTrigger -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class WearProjectsComponent( - componentContext: ComponentContext, - private val globalSettingsStore: GlobalSettingsStore, - private val listProjects: ListWatchProjectsUseCase, - private val projectsRepository: ProjectsRepository, - private val subscriptions: SubscribedProjectsRepository, - private val unsyncedContent: UnsyncedContentUseCase, - private val syncCoordinator: SyncCoordinator, - private val signOutUseCase: SignOutUseCase, - private val localNetworkAccess: LocalNetworkAccess, - private val appScope: CoroutineScope, - private val onShowSyncLog: () -> Unit, -) : ComponentBase(componentContext), WearProjects { - - private val _state = MutableValue( - WearProjects.State(accountEmail = globalSettingsStore.serverSettings?.email) - ) - override val state: Value = _state - - // Only touched on the main dispatcher. - private var watchProjects: List = emptyList() - private var syncStatus: SyncStatus = syncCoordinator.status.value - private var projectsLoaded = false - private var unsubscribing: Set = emptySet() - private var signOutWarning: WearProjects.SignOutWarning? = null - private var checkingSignOut = false - private var notice: WearProjects.Notice? = null - private var localNetworkBlocked = false - - override fun onCreate() { - super.onCreate() - scope.launch { reload() } - scope.launch { - syncCoordinator.status.collect { status -> - withContext(dispatcherMain) { - val finished = syncStatus.running && !status.running - syncStatus = status - publish() - // A sync can add, rename, or remove projects. - if (finished) launch { reload() } - } - } - } - // Held back until the local network permission is settled: pairing lands here and syncs at - // once, and a blocked connection to a LAN server only times out, with nothing saying why. - scope.launch { syncOnceReachable() } - } - - override fun onLocalNetworkPermissionResult() { - scope.launch { syncOnceReachable() } - } - - private suspend fun syncOnceReachable() { - val blocked = isLocalNetworkBlocked() - withContext(dispatcherMain) { - localNetworkBlocked = blocked - publish() - } - if (!blocked) syncCoordinator.requestAutoSync() - } - - /** An unreadable answer counts as reachable: the sync then fails, or not, on its own terms. */ - private suspend fun isLocalNetworkBlocked(): Boolean { - val address = globalSettingsStore.serverSettings?.url ?: return false - return try { - localNetworkAccess.isBlocked(address) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to check whether the server needs local network access", e) - false - } - } - - override fun toggleSubscription(projectName: String) { - val project = watchProjects.find { it.projectDef.name == projectName } ?: return - val projectId = project.projectId ?: return - - if (!project.subscribed) { - scope.launch { - subscriptions.setSubscribed(projectId, true) - syncCoordinator.requestSync(SyncTrigger.Manual) - reload() - } - return - } - - if (projectName in unsubscribing) return - unsubscribing = unsubscribing + projectName - notice = null - publish() - // Outlives the screen: abandoning a half-done unsubscribe would strand the subscription. - appScope.launch { unsubscribe(project, projectId) } - } - - override fun syncNow() { - syncCoordinator.requestSync(SyncTrigger.Manual) - } - - override fun showSyncLog() { - onShowSyncLog() - } - - override fun signOut() { - if (checkingSignOut || signOutWarning != null) return - // Counting reads every subscribed project, so the button has to say it is working. - checkingSignOut = true - publish() - - scope.launch { - val pending = try { - unsyncedContent.pending() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to count unsynced captures before signing out", e) - null - } - - withContext(dispatcherMain) { - checkingSignOut = false - if (pending != null && pending.isEmpty) { - publish() - runSignOut() - } else { - signOutWarning = WearProjects.SignOutWarning(items = pending?.total ?: 0) - publish() - } - } - } - } - - override fun confirmSignOut() { - signOutWarning = null - publish() - runSignOut() - } - - override fun cancelSignOut() { - signOutWarning = null - publish() - } - - override fun dismissNotice() { - notice = null - publish() - } - - /** - * Uploads before dropping the project's content, so writing captured on the watch is never - * destroyed by unsubscribing. If anything is still unsynced the project stays subscribed as - * well as intact, because an unsubscribed project is filtered out of every later sync and its - * writing would never get another chance to upload. - */ - private suspend fun unsubscribe(project: WatchProject, projectId: ProjectId) { - val name = project.projectDef.name - // Distinct from a failure: telling someone to sync and retry is useless advice when the - // unsubscribe itself is what broke. - var reason: WearProjects.Notice.Reason? = WearProjects.Notice.Reason.Failed - try { - // While the project is still subscribed, so the sync filter includes it. - if (pendingIn(project) > 0) syncCoordinator.sync(SyncTrigger.Manual) - - reason = syncCoordinator.runExclusive { - if (pendingIn(project) == 0) { - subscriptions.setSubscribed(projectId, false) - projectsRepository.deleteProjectContent(project.projectDef) - null - } else { - WearProjects.Notice.Reason.UnsyncedKept - } - } - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to unsubscribe from $name", e) - } finally { - withContext(dispatcherMain) { - unsubscribing = unsubscribing - name - notice = reason?.let { WearProjects.Notice(projectName = name, reason = it) } - } - reload() - } - } - - /** An unreadable count counts as pending, so a failure can never authorise a delete. */ - private suspend fun pendingIn(project: WatchProject): Int = try { - unsyncedContent.pendingIn(project.projectDef) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to count unsynced writing in ${project.projectDef.name}", e) - 1 - } - - private fun runSignOut() { - appScope.launch { - try { - signOutUseCase.signOut() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Sign out failed", e) - } - } - } - - private suspend fun reload() { - // The scope's job is not a supervisor, so a throw here would take the status collector with it. - val projects = try { - listProjects.list() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to list the watch's projects", e) - return - } - withContext(dispatcherMain) { - watchProjects = projects - projectsLoaded = true - publish() - } - } - - private fun publish() { - val rows = watchProjects.map { project -> - val name = project.projectDef.name - // A failed account sync reports every project as failed, including the ones this watch - // filtered out and never tried to sync. - val progress = syncStatus.projects[name]?.takeIf { project.subscribed } - WearProjects.ProjectRow( - name = name, - canSubscribe = project.projectId != null, - subscribed = project.subscribed, - unsubscribing = name in unsubscribing, - progress = progress?.progress, - outcome = progress?.outcome, - ) - } - val lastResult = syncStatus.lastResult - _state.update { - it.copy( - projects = rows, - loaded = projectsLoaded, - syncing = syncStatus.running, - lastSyncFailed = syncStatus.lastRunFailed || (lastResult != null && !lastResult.allSuccess), - needsReauth = syncStatus.needsReauth, - signOutWarning = signOutWarning, - checkingSignOut = checkingSignOut, - notice = notice, - localNetworkBlocked = localNetworkBlocked, - ) - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignIn.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignIn.kt deleted file mode 100644 index 5fbe9e938..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignIn.kt +++ /dev/null @@ -1,34 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.signin - -import com.arkivanov.decompose.value.Value - -interface ManualSignIn { - val state: Value - - fun updateServer(server: String) - fun updateEmail(email: String) - fun updatePassword(password: String) - fun signIn() - - /** Called once the local network prompt is answered, whichever way. */ - fun onLocalNetworkPermissionResult() - - /** The password is deliberately absent: it never leaves the component. */ - data class State( - val server: String = "", - val serverInsecure: Boolean = false, - val email: String = "", - val hasPassword: Boolean = false, - val busy: Boolean = false, - val error: SignInError? = null, - /** The server is on the local network and signing in has to wait for the prompt. */ - val localNetworkBlocked: Boolean = false, - ) - - sealed interface SignInError { - data object MissingFields : SignInError - data object TermsRequired : SignInError - data object LocalNetworkDenied : SignInError - data class Message(val text: String?) : SignInError - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponent.kt deleted file mode 100644 index 75aed35f6..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponent.kt +++ /dev/null @@ -1,108 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.signin - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.arkivanov.decompose.value.update -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.account.ServerSetupResult -import com.darkrockstudios.apps.hammer.common.data.globalsettings.isInsecureServerUrl -import com.darkrockstudios.apps.hammer.common.data.globalsettings.parseServerUrl -import com.darkrockstudios.apps.hammer.common.util.StrRes -import com.darkrockstudios.apps.hammer.wear.data.LocalNetworkAccess -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class ManualSignInComponent( - componentContext: ComponentContext, - private val accountUseCase: AccountUseCase, - private val localNetworkAccess: LocalNetworkAccess, - private val strRes: StrRes, -) : ComponentBase(componentContext), ManualSignIn { - - private val _state = MutableValue(ManualSignIn.State()) - override val state: Value = _state - - private var password: String = "" - - // The watch's RemoteInput keyboard capitalises the first letter and offers no way to turn that - // off, so both of these are folded down to what the server actually matches on. - override fun updateServer(server: String) { - val trimmed = server.trim().lowercase() - _state.update { it.copy(server = trimmed, serverInsecure = isInsecureServerUrl(trimmed), error = null) } - } - - override fun updateEmail(email: String) { - _state.update { it.copy(email = email.trim().lowercase(), error = null) } - } - - override fun updatePassword(password: String) { - this.password = password - _state.update { it.copy(hasPassword = password.isNotEmpty(), error = null) } - } - - override fun signIn() { - val current = _state.value - if (current.busy) return - if (current.server.isBlank() || current.email.isBlank() || password.isEmpty()) { - _state.update { it.copy(error = ManualSignIn.SignInError.MissingFields) } - return - } - - _state.update { it.copy(busy = true, error = null) } - scope.launch { - val parsedUrl = parseServerUrl(current.server) - // The login is the first request, so a LAN server has to be reachable before it. - if (isLocalNetworkBlocked(parsedUrl.host)) { - withContext(dispatcherMain) { - _state.update { it.copy(busy = false, localNetworkBlocked = true) } - } - return@launch - } - val result = accountUseCase.setupServer( - url = parsedUrl.host, - email = current.email, - password = password, - create = false, - ssl = parsedUrl.ssl, - ) - val error = when (result) { - ServerSetupResult.Success -> null - is ServerSetupResult.TermsRequired -> ManualSignIn.SignInError.TermsRequired - is ServerSetupResult.Failure -> - ManualSignIn.SignInError.Message(result.displayMessage?.text(strRes)) - } - withContext(dispatcherMain) { - if (error == null) password = "" - _state.update { it.copy(busy = false, error = error) } - } - } - } - - override fun onLocalNetworkPermissionResult() { - _state.update { it.copy(localNetworkBlocked = false) } - scope.launch { - val host = parseServerUrl(_state.value.server).host - if (isLocalNetworkBlocked(host)) { - withContext(dispatcherMain) { - _state.update { it.copy(error = ManualSignIn.SignInError.LocalNetworkDenied) } - } - } else { - withContext(dispatcherMain) { signIn() } - } - } - } - - /** An unreadable answer counts as reachable: the login then fails, or not, on its own terms. */ - private suspend fun isLocalNetworkBlocked(host: String): Boolean = try { - localNetworkAccess.isBlocked(host) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to check whether the server needs local network access", e) - false - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLog.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLog.kt deleted file mode 100644 index 220d02718..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLog.kt +++ /dev/null @@ -1,11 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.synclog - -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage - -interface SyncLog { - val state: Value - - /** Newest entry first. */ - data class State(val entries: List = emptyList()) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLogComponent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLogComponent.kt deleted file mode 100644 index 5e4445a5c..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/components/synclog/SyncLogComponent.kt +++ /dev/null @@ -1,29 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.synclog - -import com.arkivanov.decompose.ComponentContext -import com.arkivanov.decompose.value.MutableValue -import com.arkivanov.decompose.value.Value -import com.darkrockstudios.apps.hammer.common.components.ComponentBase -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import kotlinx.coroutines.launch -import kotlinx.coroutines.withContext - -class SyncLogComponent( - componentContext: ComponentContext, - private val syncCoordinator: SyncCoordinator, -) : ComponentBase(componentContext), SyncLog { - - private val _state = MutableValue(SyncLog.State(syncCoordinator.status.value.log.asReversed())) - override val state: Value = _state - - override fun onCreate() { - super.onCreate() - scope.launch { - syncCoordinator.status.collect { status -> - withContext(dispatcherMain) { - _state.value = SyncLog.State(status.log.asReversed()) - } - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTargetsUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTargetsUseCase.kt deleted file mode 100644 index 3ad92f047..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTargetsUseCase.kt +++ /dev/null @@ -1,26 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -/** - * Where a note could go right now. [default] is the project last captured to, falling back to the - * first one on the watch, so dictating is one tap and choosing is optional. - */ -data class CaptureTargets( - val projects: List = emptyList(), - val default: WatchProject? = null, -) - -class CaptureTargetsUseCase( - private val listProjects: ListWatchProjectsUseCase, - private val subscriptions: SubscribedProjectsRepository, -) { - suspend fun load(): CaptureTargets { - // Only subscribed projects: an unsynced one has an empty IdAllocator, so a note there - // would take id 1 and collide on every later sync. - val projects = listProjects.list().filter { it.subscribed } - val lastUsed = subscriptions.lastCaptureProjectId() - return CaptureTargets( - projects = projects, - default = projects.find { it.projectId == lastUsed } ?: projects.firstOrNull(), - ) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCase.kt deleted file mode 100644 index 552a172d7..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCase.kt +++ /dev/null @@ -1,21 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -/** - * What the tile and complication show without opening the app: where a note would go, and how much - * writing is still waiting to reach the server. Both are null when they could not be read, so a - * surface can leave them out rather than state something untrue. - */ -data class CaptureTileState( - val projectName: String? = null, - val pending: Int? = null, -) - -class CaptureTileStateUseCase( - private val captureTargets: CaptureTargetsUseCase, - private val unsyncedContent: UnsyncedContentUseCase, -) { - suspend fun load(): CaptureTileState = CaptureTileState( - projectName = captureTargets.load().default?.projectDef?.name, - pending = unsyncedContent.pending().total, - ) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCase.kt deleted file mode 100644 index e8301abff..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCase.kt +++ /dev/null @@ -1,72 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.wear.sync.CaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.tile.CaptureSurfaceUpdater -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException - -sealed interface CaptureTarget { - data class Note(val projectDef: ProjectDef) : CaptureTarget - data object Idea : CaptureTarget -} - -sealed interface CaptureResult { - data object Saved : CaptureResult - data object Empty : CaptureResult - data object Failed : CaptureResult -} - -/** - * Writes a capture. Behind an interface because saving a note needs a full project scope, which a - * JVM test cannot open. - */ -interface CaptureWriter { - suspend fun writeNote(projectDef: ProjectDef, text: String): Boolean - suspend fun writeIdea(text: String): Boolean -} - -class CaptureUseCase( - private val writer: CaptureWriter, - private val unsyncedContent: UnsyncedContentUseCase, - private val captureSync: CaptureSyncScheduler, - private val surfaces: CaptureSurfaceUpdater, -) { - /** - * Returns as soon as the capture is durable and a sync is queued. The pending count is not - * gathered here: it is only ever displayed, and nothing that can still fail belongs between - * writing the user's words and telling them the words are safe. - */ - suspend fun capture(target: CaptureTarget, text: String): CaptureResult { - val trimmed = text.trim() - if (trimmed.isEmpty()) return CaptureResult.Empty - - val written = try { - when (target) { - is CaptureTarget.Note -> writer.writeNote(target.projectDef, trimmed) - CaptureTarget.Idea -> writer.writeIdea(trimmed) - } - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to save a capture", e) - false - } - - if (!written) return CaptureResult.Failed - - captureSync.syncSoon() - surfaces.refresh() - return CaptureResult.Saved - } - - /** Everything on the watch still waiting to reach the server, or null if it could not be read. */ - suspend fun pendingCount(): Int? = try { - unsyncedContent.pending().total - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to count what is waiting to sync", e) - null - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCase.kt deleted file mode 100644 index a1f406e11..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCase.kt +++ /dev/null @@ -1,40 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import okio.IOException - -/** - * A project as the watch sees it. [projectId] is null until account sync has registered the - * project with the server, and such a project cannot be subscribed to yet. - */ -data class WatchProject( - val projectDef: ProjectDef, - val projectId: ProjectId?, - val subscribed: Boolean, -) - -class ListWatchProjectsUseCase( - private val projectsRepository: ProjectsRepository, - private val subscriptions: SubscribedProjectsRepository, -) { - suspend fun list(): List { - val subscribed = subscriptions.currentSubscriptions() - return projectsRepository.getProjects() - .mapNotNull { projectDef -> - // The project can be deleted concurrently by a sync. - val projectId = try { - projectsRepository.getProjectId(projectDef) - } catch (_: IOException) { - return@mapNotNull null - } - WatchProject( - projectDef = projectDef, - projectId = projectId, - subscribed = projectId != null && projectId in subscribed, - ) - } - .sortedBy { it.projectDef.name.lowercase() } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAccess.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAccess.kt deleted file mode 100644 index 576186c4c..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAccess.kt +++ /dev/null @@ -1,39 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import android.content.Context -import android.content.pm.PackageManager -import android.os.Build -import androidx.core.content.ContextCompat -import kotlinx.coroutines.withContext -import kotlin.coroutines.CoroutineContext - -// Defined as a string literal so the module still compiles against SDKs below 37, where the -// Manifest.permission constant is absent. -const val ACCESS_LOCAL_NETWORK = "android.permission.ACCESS_LOCAL_NETWORK" -private const val LOCAL_NETWORK_MIN_SDK = 37 - -/** - * Android 17 blocks an app from reaching local network addresses until it holds - * [ACCESS_LOCAL_NETWORK]. A blocked connection does not fail fast; it times out as a generic - * connection error, so the permission has to be settled before connecting rather than diagnosed - * after. - */ -interface LocalNetworkAccess { - /** True when [serverAddress] is on the local network and the app may not reach it yet. */ - suspend fun isBlocked(serverAddress: String): Boolean -} - -class AndroidLocalNetworkAccess( - private val context: Context, - private val ioDispatcher: CoroutineContext, -) : LocalNetworkAccess { - - override suspend fun isBlocked(serverAddress: String): Boolean { - if (Build.VERSION.SDK_INT < LOCAL_NETWORK_MIN_SDK) return false - if (ContextCompat.checkSelfPermission(context, ACCESS_LOCAL_NETWORK) == PackageManager.PERMISSION_GRANTED) { - return false - } - // Resolving a name is a network call. - return withContext(ioDispatcher) { isLocalNetworkServer(serverAddress) } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddress.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddress.kt deleted file mode 100644 index 6105501e5..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddress.kt +++ /dev/null @@ -1,63 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import java.net.Inet4Address -import java.net.Inet6Address -import java.net.InetAddress -import java.net.UnknownHostException - -/** Names that only ever resolve on a home or office network. */ -private val LOCAL_NAME_SUFFIXES = listOf(".local", ".lan", ".home", ".internal", ".home.arpa") - -/** - * The host part of a stored server address, which carries its port: `192.168.1.5:8080`, - * `nas.lan`, `[fd00::1]:8080`. - */ -internal fun hostOf(serverAddress: String): String { - val address = serverAddress.trim().substringBefore('/') - return when { - address.startsWith("[") -> address.substringAfter('[').substringBefore(']') - // More than one colon without brackets is a bare IPv6 literal, not host:port. - address.count { it == ':' } == 1 -> address.substringBefore(':') - else -> address - } -} - -/** - * Whether [serverAddress] points at the local network, and so needs Android 17's local network - * permission to reach. Names are resolved, because `nas.lan` and a hostname with a LAN record look - * no different from a public one. A name that cannot be resolved falls back to how it looks. - */ -fun isLocalNetworkServer( - serverAddress: String, - resolve: (String) -> List = { InetAddress.getAllByName(it).toList() }, -): Boolean { - val host = hostOf(serverAddress).lowercase() - if (host.isEmpty()) return false - - val addresses = try { - resolve(host) - } catch (_: UnknownHostException) { - return looksLocal(host) - } catch (_: SecurityException) { - return looksLocal(host) - } - return addresses.any { it.isLocalNetwork() } -} - -private fun looksLocal(host: String): Boolean = - host == "localhost" || !host.contains('.') || LOCAL_NAME_SUFFIXES.any { host.endsWith(it) } - -/** - * Private, loopback and link-local ranges, IPv6 unique local addresses, and the carrier-grade NAT - * range that mesh VPNs such as Tailscale hand out. Over-including costs one prompt; missing one - * leaves every sync timing out with no explanation. - */ -internal fun InetAddress.isLocalNetwork(): Boolean { - if (isLoopbackAddress || isSiteLocalAddress || isLinkLocalAddress || isAnyLocalAddress) return true - val bytes = address - return when (this) { - is Inet6Address -> (bytes[0].toInt() and 0xFE) == 0xFC - is Inet4Address -> (bytes[0].toInt() and 0xFF) == 100 && (bytes[1].toInt() and 0xC0) == 64 - else -> false - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryCaptureWriter.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryCaptureWriter.kt deleted file mode 100644 index e7c20e672..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryCaptureWriter.kt +++ /dev/null @@ -1,25 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeasRepository -import com.darkrockstudios.apps.hammer.common.data.isSuccess -import com.darkrockstudios.apps.hammer.common.data.notesrepository.NotesRepository -import com.darkrockstudios.apps.hammer.common.data.temporaryProjectTask -import org.koin.core.component.KoinComponent -import org.koin.core.parameter.parametersOf - -class RepositoryCaptureWriter( - private val ideasRepository: IdeasRepository, -) : CaptureWriter, KoinComponent { - - override suspend fun writeNote(projectDef: ProjectDef, text: String): Boolean { - var saved = false - temporaryProjectTask(projectDef) { projectScope -> - val notesRepository: NotesRepository = projectScope.get { parametersOf(projectDef) } - saved = isSuccess(notesRepository.createNote(text)) - } - return saved - } - - override suspend fun writeIdea(text: String): Boolean = isSuccess(ideasRepository.createIdea(text)) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryUnsyncedContentSource.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryUnsyncedContentSource.kt deleted file mode 100644 index 4c2a032ff..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/RepositoryUnsyncedContentSource.kt +++ /dev/null @@ -1,31 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.ideasrepository.IdeasDatasource -import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeasSyncDatasource -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.loadPendingEntityCount -import kotlinx.serialization.json.Json -import okio.FileSystem - -/** - * Both counts read their bookkeeping files directly. Neither opens a project scope or waits on a - * repository's cache: counting is on the path between saving a capture and telling the user it is - * safe, so it has to be cheap and it must not be able to hang. - */ -class RepositoryUnsyncedContentSource( - private val ideasDatasource: IdeasDatasource, - private val ideasSyncDatasource: IdeasSyncDatasource, - private val fileSystem: FileSystem, - private val json: Json, -) : UnsyncedContentSource { - - override suspend fun pendingIn(projectDef: ProjectDef): Int = - loadPendingEntityCount(projectDef, fileSystem, json) - - /** An idea with no baseline has never been accepted by the server. */ - override suspend fun pendingIdeas(): Int { - val syncData = ideasSyncDatasource.load() - val ideas = ideasDatasource.loadIdeas() - return ideas.count { it.id !in syncData.baselines } + syncData.pendingDeletes.size - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ServerSettingsExt.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ServerSettingsExt.kt deleted file mode 100644 index bb41c506a..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/ServerSettingsExt.kt +++ /dev/null @@ -1,7 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings - -/** Account setup stores provisional settings with no user before sign-in completes. */ -fun ServerSettings?.isSignedIn(): Boolean = - this != null && userId >= 0 && !bearerToken.isNullOrBlank() diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCase.kt deleted file mode 100644 index 8de743f78..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCase.kt +++ /dev/null @@ -1,36 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import com.darkrockstudios.apps.hammer.wear.sync.SyncScheduler - -/** - * Forgets the account and everything synced from it. The watch holds no data of its own beyond - * what sync brought down, and leftover account sync state would act on the next account signed in. - * - * Callers run this in the app scope: dropping the server settings navigates away from the screen - * that started it. - */ -class SignOutUseCase( - private val globalSettingsStore: GlobalSettingsStore, - private val projectsRepository: ProjectsRepository, - private val subscriptions: SubscribedProjectsRepository, - private val syncScheduler: SyncScheduler, - private val syncCoordinator: SyncCoordinator, -) { - suspend fun signOut() { - syncScheduler.cancel() - syncCoordinator.runExclusive { - try { - globalSettingsStore.deleteServerSettings() - projectsRepository.deleteAllLocalData() - } finally { - // Even a failed wipe must not leave this account's subscriptions or its auto sync - // latch behind for whoever signs in next. - subscriptions.clear() - syncCoordinator.resetAutoSync() - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepository.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepository.kt deleted file mode 100644 index 77a081e58..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepository.kt +++ /dev/null @@ -1,34 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.first -import kotlinx.coroutines.flow.map - -/** - * The projects whose content is kept on the watch. Keyed by server id so a rename on another - * device does not drop the subscription. - */ -class SubscribedProjectsRepository( - private val datasource: WearPrefsDatasource, -) { - val subscribedProjectIds: Flow> = - datasource.subscribedProjectIds.map { ids -> ids.mapTo(mutableSetOf(), ::ProjectId) } - - suspend fun currentSubscriptions(): Set = subscribedProjectIds.first() - - /** The project a capture defaults to, so dictating a note is one tap on a run. */ - suspend fun lastCaptureProjectId(): ProjectId? = datasource.lastCaptureProjectId.first()?.let(::ProjectId) - - suspend fun setSubscribed(projectId: ProjectId, subscribed: Boolean) { - datasource.setSubscribed(projectId.id, subscribed) - } - - suspend fun setLastCaptureProject(projectId: ProjectId) { - datasource.setLastCaptureProjectId(projectId.id) - } - - suspend fun clear() { - datasource.clear() - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContent.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContent.kt deleted file mode 100644 index 534929ae1..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContent.kt +++ /dev/null @@ -1,37 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.common.data.ProjectDef - -/** - * Counts writing the watch holds that the server has not accepted. Behind an interface because - * reading a project's sync journal needs a full project scope, which a JVM test cannot open. - */ -interface UnsyncedContentSource { - suspend fun pendingIn(projectDef: ProjectDef): Int - suspend fun pendingIdeas(): Int -} - -/** [projects] is keyed by project name and holds only projects with something outstanding. */ -data class UnsyncedContent( - val projects: Map = emptyMap(), - val ideas: Int = 0, -) { - val total: Int get() = projects.values.sum() + ideas - val isEmpty: Boolean get() = total == 0 -} - -class UnsyncedContentUseCase( - private val listProjects: ListWatchProjectsUseCase, - private val source: UnsyncedContentSource, -) { - suspend fun pendingIn(projectDef: ProjectDef): Int = source.pendingIn(projectDef) - - /** Only subscribed projects are counted; the rest hold no content on the watch. */ - suspend fun pending(): UnsyncedContent { - val projects = listProjects.list() - .filter { it.subscribed } - .associate { it.projectDef.name to source.pendingIn(it.projectDef) } - .filterValues { it > 0 } - return UnsyncedContent(projects = projects, ideas = source.pendingIdeas()) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/WearPrefsDatasource.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/WearPrefsDatasource.kt deleted file mode 100644 index 1ae4addcb..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/data/WearPrefsDatasource.kt +++ /dev/null @@ -1,57 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import android.content.Context -import androidx.datastore.core.DataStore -import androidx.datastore.preferences.core.Preferences -import androidx.datastore.preferences.core.edit -import androidx.datastore.preferences.core.stringPreferencesKey -import androidx.datastore.preferences.core.stringSetPreferencesKey -import androidx.datastore.preferences.preferencesDataStore -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.map - -/** Watch-only preferences. This is the only reader and writer of the wear DataStore. */ -interface WearPrefsDatasource { - val subscribedProjectIds: Flow> - val lastCaptureProjectId: Flow - - suspend fun setSubscribed(projectId: String, subscribed: Boolean) - suspend fun setLastCaptureProjectId(projectId: String) - suspend fun clear() -} - -private val Context.wearPrefsDataStore by preferencesDataStore(name = "wear_prefs") - -fun createWearPrefsDatasource(context: Context): WearPrefsDatasource = - DataStoreWearPrefsDatasource(context.wearPrefsDataStore) - -private class DataStoreWearPrefsDatasource( - private val dataStore: DataStore, -) : WearPrefsDatasource { - - override val subscribedProjectIds: Flow> = - dataStore.data.map { prefs -> prefs[SUBSCRIBED_PROJECT_IDS] ?: emptySet() } - - override val lastCaptureProjectId: Flow = - dataStore.data.map { prefs -> prefs[LAST_CAPTURE_PROJECT_ID] } - - override suspend fun setSubscribed(projectId: String, subscribed: Boolean) { - dataStore.edit { prefs -> - val current = prefs[SUBSCRIBED_PROJECT_IDS] ?: emptySet() - prefs[SUBSCRIBED_PROJECT_IDS] = if (subscribed) current + projectId else current - projectId - } - } - - override suspend fun setLastCaptureProjectId(projectId: String) { - dataStore.edit { prefs -> prefs[LAST_CAPTURE_PROJECT_ID] = projectId } - } - - override suspend fun clear() { - dataStore.edit { it.clear() } - } - - private companion object { - val SUBSCRIBED_PROJECT_IDS = stringSetPreferencesKey("subscribed_project_ids") - val LAST_CAPTURE_PROJECT_ID = stringPreferencesKey("last_capture_project_id") - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/dependencyinjection/wearModule.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/dependencyinjection/wearModule.kt deleted file mode 100644 index c44ab82a8..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/dependencyinjection/wearModule.kt +++ /dev/null @@ -1,112 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.dependencyinjection - -import androidx.work.WorkManager -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountUseCase -import com.darkrockstudios.apps.hammer.common.dependencyinjection.APP_SCOPE -import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_IO -import com.darkrockstudios.apps.hammer.wear.data.AndroidLocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.LocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.data.SignOutUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureTargetsUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureTileStateUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureWriter -import com.darkrockstudios.apps.hammer.wear.data.RepositoryCaptureWriter -import com.darkrockstudios.apps.hammer.wear.data.RepositoryUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import com.darkrockstudios.apps.hammer.wear.data.WearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.data.createWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.pairing.DataLayerPhonePairingClient -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingClient -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingUseCase -import com.darkrockstudios.apps.hammer.wear.sync.AccountSync -import com.darkrockstudios.apps.hammer.wear.sync.CaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.sync.WorkManagerCaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.sync.DefaultSyncCoordinator -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import com.darkrockstudios.apps.hammer.wear.sync.SyncScheduler -import com.darkrockstudios.apps.hammer.wear.tile.CaptureSurfaceUpdater -import com.darkrockstudios.apps.hammer.wear.tile.WearCaptureSurfaceUpdater -import org.koin.android.ext.koin.androidContext -import org.koin.core.module.Module -import org.koin.core.qualifier.named -import org.koin.dsl.module - -val wearModule: Module = module { - single { DataLayerPhonePairingClient(context = androidContext()) } - single { - PhonePairingUseCase( - client = get(), - globalSettingsStore = get(), - accountUseCase = get(), - ) - } - - single { createWearPrefsDatasource(androidContext()) } - single { - AndroidLocalNetworkAccess(context = androidContext(), ioDispatcher = get(named(DISPATCHER_IO))) - } - single { SubscribedProjectsRepository(datasource = get()) } - factory { ListWatchProjectsUseCase(projectsRepository = get(), subscriptions = get()) } - single { - RepositoryUnsyncedContentSource( - ideasDatasource = get(), - ideasSyncDatasource = get(), - fileSystem = get(), - json = get(), - ) - } - factory { UnsyncedContentUseCase(listProjects = get(), source = get()) } - single { RepositoryCaptureWriter(ideasRepository = get()) } - single { - WorkManagerCaptureSyncScheduler( - workManager = WorkManager.getInstance(androidContext()), - globalSettingsStore = get(), - ) - } - single { WearCaptureSurfaceUpdater(context = androidContext()) } - factory { - CaptureUseCase( - writer = get(), - unsyncedContent = get(), - captureSync = get(), - surfaces = get(), - ) - } - factory { CaptureTargetsUseCase(listProjects = get(), subscriptions = get()) } - factory { CaptureTileStateUseCase(captureTargets = get(), unsyncedContent = get()) } - - single { - val syncAccountUseCase: SyncAccountUseCase = get() - AccountSync { listener, projectFilter -> syncAccountUseCase.execute(listener, projectFilter) } - } - single { - DefaultSyncCoordinator( - accountSync = get(), - subscriptions = get(), - globalSettingsStore = get(), - networkConnectivity = get(), - surfaces = get(), - appScope = get(named(APP_SCOPE)), - ) - } - single { - SyncScheduler( - workManager = WorkManager.getInstance(androidContext()), - globalSettingsStore = get(), - appScope = get(named(APP_SCOPE)), - ) - } - factory { - SignOutUseCase( - globalSettingsStore = get(), - projectsRepository = get(), - subscriptions = get(), - syncScheduler = get(), - syncCoordinator = get(), - ) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PairingResponseListenerService.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PairingResponseListenerService.kt deleted file mode 100644 index 4410b2154..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PairingResponseListenerService.kt +++ /dev/null @@ -1,17 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.pairing - -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.google.android.gms.wearable.MessageEvent -import com.google.android.gms.wearable.WearableListenerService -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject - -class PairingResponseListenerService : WearableListenerService(), KoinComponent { - private val phonePairing: PhonePairingUseCase by inject() - - override fun onMessageReceived(event: MessageEvent) { - if (event.path == PairingProtocol.RESPONSE_PATH) { - phonePairing.onResponse(event.data) - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingClient.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingClient.kt deleted file mode 100644 index 979b22be2..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingClient.kt +++ /dev/null @@ -1,34 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.pairing - -import android.content.Context -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.google.android.gms.wearable.CapabilityClient -import com.google.android.gms.wearable.Wearable -import kotlinx.coroutines.tasks.await - -interface PhonePairingClient { - /** The node id of a reachable phone running Hammer, or null when there is none. */ - suspend fun findPhone(): String? - - suspend fun sendRequest(nodeId: String, request: PairRequest) -} - -class DataLayerPhonePairingClient(context: Context) : PhonePairingClient { - private val capabilityClient = Wearable.getCapabilityClient(context) - private val messageClient = Wearable.getMessageClient(context) - - override suspend fun findPhone(): String? { - val capability = capabilityClient - .getCapability(PairingProtocol.PHONE_CAPABILITY, CapabilityClient.FILTER_REACHABLE) - .await() - val nodes = capability.nodes - return (nodes.firstOrNull { it.isNearby } ?: nodes.firstOrNull())?.id - } - - override suspend fun sendRequest(nodeId: String, request: PairRequest) { - messageClient - .sendMessage(nodeId, PairingProtocol.REQUEST_PATH, PairingProtocol.encodeRequest(request)) - .await() - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCase.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCase.kt deleted file mode 100644 index 848219abc..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCase.kt +++ /dev/null @@ -1,115 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.pairing - -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.flow.MutableStateFlow -import kotlinx.coroutines.flow.StateFlow -import java.util.UUID - -sealed interface PairingState { - data object Idle : PairingState - data object SearchingPhone : PairingState - data object AwaitingConfirmation : PairingState - data object Paired : PairingState - data object PhoneNotFound : PairingState - - /** [reason] is null when the failure happened on this device rather than on the phone. */ - data class Failed(val reason: PairErrorCode?) : PairingState -} - -/** A request is being made or answered, as opposed to a finished attempt. */ -val PairingState.inFlight: Boolean - get() = this == PairingState.SearchingPhone || this == PairingState.AwaitingConfirmation - -/** - * Asks the paired phone for a session of this watch's own. The phone answers asynchronously - * through [PairingResponseListenerService], which may outlive the screen that started the request, - * so the state lives here rather than in a component. - */ -class PhonePairingUseCase( - private val client: PhonePairingClient, - private val globalSettingsStore: GlobalSettingsStore, - private val accountUseCase: AccountUseCase, -) { - private val _state = MutableStateFlow(PairingState.Idle) - val state: StateFlow = _state - - @Volatile - private var pendingRequestId: String? = null - - suspend fun startPairing(deviceLabel: String) { - _state.value = PairingState.SearchingPhone - - val nodeId = try { - client.findPhone() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - // Play services throws ApiException when the Wearable API is unavailable. - Napier.w("Phone lookup failed", e) - null - } - if (nodeId == null) { - _state.value = PairingState.PhoneNotFound - return - } - - val requestId = UUID.randomUUID().toString() - pendingRequestId = requestId - // Set before sending so a fast reply cannot be overwritten by this state. - _state.value = PairingState.AwaitingConfirmation - - try { - val request = PairRequest( - requestId = requestId, - installId = globalSettingsStore.ensureInstallId(), - deviceLabel = deviceLabel, - ) - client.sendRequest(nodeId, request) - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.w("Failed to send the pairing request", e) - pendingRequestId = null - _state.value = PairingState.Failed(reason = null) - } - } - - fun onResponse(payload: ByteArray) { - val response = PairingProtocol.decodeResponse(payload) - if (response == null) { - Napier.w("Ignoring an unreadable pairing response") - return - } - val pending = pendingRequestId - // A blank id is the phone answering a request it could not decode well enough to quote back. - if (pending == null || (response.requestId.isNotEmpty() && response.requestId != pending)) { - Napier.w("Ignoring a pairing response for a request that is no longer pending") - return - } - pendingRequestId = null - - _state.value = when (response) { - is PairResponse.Success -> { - if (accountUseCase.applyPairedSettings(response.settings).isSuccess) { - PairingState.Paired - } else { - PairingState.Failed(reason = null) - } - } - - is PairResponse.Error -> PairingState.Failed(reason = response.code) - } - } - - fun reset() { - pendingRequestId = null - _state.value = PairingState.Idle - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/AccountSyncWorker.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/AccountSyncWorker.kt deleted file mode 100644 index d0cd4ab9f..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/AccountSyncWorker.kt +++ /dev/null @@ -1,33 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import android.content.Context -import androidx.work.CoroutineWorker -import androidx.work.WorkerParameters -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject - -class AccountSyncWorker( - context: Context, - params: WorkerParameters, -) : CoroutineWorker(context, params), KoinComponent { - - private val coordinator: SyncCoordinator by inject() - private val globalSettingsStore: GlobalSettingsStore by inject() - - override suspend fun doWork(): Result { - if (!globalSettingsStore.globalSettings.automaticSyncing) return Result.success() - - return when (val run = coordinator.sync(SyncTrigger.Periodic)) { - // A sync is already running, so the periodic pass has nothing left to do. - SyncRunResult.Skipped, SyncRunResult.Busy -> Result.success() - SyncRunResult.Failed -> Result.retry() - is SyncRunResult.Completed -> when { - run.result.accountSuccess -> Result.success() - // Only the user can mint a new session, so retrying just wakes the radio. - coordinator.status.value.needsReauth -> Result.success() - else -> Result.retry() - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncScheduler.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncScheduler.kt deleted file mode 100644 index e800baab2..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncScheduler.kt +++ /dev/null @@ -1,40 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import androidx.work.Constraints -import androidx.work.ExistingWorkPolicy -import androidx.work.NetworkType -import androidx.work.OneTimeWorkRequestBuilder -import androidx.work.OutOfQuotaPolicy -import androidx.work.WorkManager -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.wear.data.isSignedIn - -/** Pushes a fresh capture to the server as soon as the watch has a network. */ -interface CaptureSyncScheduler { - fun syncSoon() -} - -class WorkManagerCaptureSyncScheduler( - private val workManager: WorkManager, - private val globalSettingsStore: GlobalSettingsStore, -) : CaptureSyncScheduler { - - override fun syncSoon() { - if (!globalSettingsStore.serverSettings.isSignedIn()) return - if (!globalSettingsStore.globalSettings.automaticSyncing) return - - val request = OneTimeWorkRequestBuilder() - .setConstraints(Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build()) - .setExpedited(OutOfQuotaPolicy.RUN_AS_NON_EXPEDITED_WORK_REQUEST) - .build() - // Thar be dragons: REPLACE cancels work that is already RUNNING, so a second capture would - // abort the first one's sync partway through the protocol, leaving a begun-but-never-ended - // session on the server. Captures arriving faster than a sync completes would then never - // upload at all. APPEND_OR_REPLACE queues behind the running sync instead. - workManager.enqueueUniqueWork(WORK_NAME, ExistingWorkPolicy.APPEND_OR_REPLACE, request) - } - - private companion object { - const val WORK_NAME = "hammer_capture_sync" - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncWorker.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncWorker.kt deleted file mode 100644 index fa609057e..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/CaptureSyncWorker.kt +++ /dev/null @@ -1,28 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import android.content.Context -import androidx.work.CoroutineWorker -import androidx.work.WorkerParameters -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject - -class CaptureSyncWorker( - context: Context, - params: WorkerParameters, -) : CoroutineWorker(context, params), KoinComponent { - - private val coordinator: SyncCoordinator by inject() - - override suspend fun doWork(): Result = when (val run = coordinator.sync(SyncTrigger.Capture)) { - SyncRunResult.Skipped -> Result.success() - // The running sync may have passed this project before the capture landed. - SyncRunResult.Busy -> Result.retry() - SyncRunResult.Failed -> Result.retry() - is SyncRunResult.Completed -> when { - run.result.accountSuccess -> Result.success() - // Only the user can mint a new session, so retrying just wakes the radio. - coordinator.status.value.needsReauth -> Result.success() - else -> Result.retry() - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncCoordinator.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncCoordinator.kt deleted file mode 100644 index 9145bfa36..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncCoordinator.kt +++ /dev/null @@ -1,156 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import com.darkrockstudios.apps.hammer.base.http.storyideas.StoryIdea -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SyncedProjectDefinition -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountListener -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountResult -import com.darkrockstudios.apps.hammer.common.data.sync.ideassync.IdeaConflict -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage -import com.darkrockstudios.apps.hammer.common.util.NetworkConnectivity -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.isSignedIn -import com.darkrockstudios.apps.hammer.wear.tile.CaptureSurfaceUpdater -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.flow.MutableStateFlow -import kotlinx.coroutines.flow.StateFlow -import kotlinx.coroutines.flow.update -import kotlinx.coroutines.launch -import kotlinx.coroutines.sync.Mutex -import kotlinx.coroutines.sync.withLock -import java.util.concurrent.atomic.AtomicBoolean - -/** The account sync the watch runs, behind a seam so the coordinator can be tested without a server. */ -fun interface AccountSync { - suspend fun run( - listener: SyncAccountListener, - projectFilter: (SyncedProjectDefinition) -> Boolean, - ): SyncAccountResult -} - -/** - * The one place the watch syncs from. The UI, app-open auto-sync, and background work all go - * through here so two syncs never overlap, and a sync started from the UI outlives the screen. - */ -interface SyncCoordinator { - val status: StateFlow - - /** Starts a sync in the app scope and returns immediately. */ - fun requestSync(trigger: SyncTrigger) - - /** Starts the app-open sync, at most once per process and only when auto sync applies. */ - fun requestAutoSync() - - suspend fun sync(trigger: SyncTrigger): SyncRunResult - - /** Runs [block] once no sync is in progress, holding off new syncs until it returns. */ - suspend fun runExclusive(block: suspend () -> T): T - - /** Clears the once-per-process latch so the next account signed in still syncs on open. */ - fun resetAutoSync() -} - -class DefaultSyncCoordinator( - private val accountSync: AccountSync, - private val subscriptions: SubscribedProjectsRepository, - private val globalSettingsStore: GlobalSettingsStore, - private val networkConnectivity: NetworkConnectivity, - private val surfaces: CaptureSurfaceUpdater, - private val appScope: CoroutineScope, -) : SyncCoordinator { - - private val _status = MutableStateFlow(SyncStatus()) - override val status: StateFlow = _status - - private val mutex = Mutex() - private val autoSynced = AtomicBoolean(false) - - override fun requestSync(trigger: SyncTrigger) { - appScope.launch { sync(trigger) } - } - - override fun requestAutoSync() { - appScope.launch { - if (!globalSettingsStore.serverSettings.isSignedIn()) return@launch - if (!globalSettingsStore.globalSettings.automaticSyncing) return@launch - if (!networkConnectivity.hasActiveConnection()) return@launch - if (autoSynced.getAndSet(true)) return@launch - sync(SyncTrigger.AppOpen) - } - } - - override suspend fun sync(trigger: SyncTrigger): SyncRunResult { - if (!globalSettingsStore.serverSettings.isSignedIn()) return SyncRunResult.Skipped - if (!mutex.tryLock()) return SyncRunResult.Busy - - try { - val subscribed = subscriptions.currentSubscriptions() - _status.value = SyncStatus(running = true, trigger = trigger) - - val result = accountSync.run(listener) { synced -> synced.projectId in subscribed } - - _status.update { it.copy(running = false, lastResult = result) } - return SyncRunResult.Completed(result) - } catch (e: CancellationException) { - _status.update { it.copy(running = false) } - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Watch sync failed", e) - _status.update { it.copy(running = false, lastRunFailed = true) } - return SyncRunResult.Failed - } finally { - mutex.unlock() - // A sync is the only thing that lowers the pending count. - surfaces.refresh() - } - } - - override suspend fun runExclusive(block: suspend () -> T): T = mutex.withLock { block() } - - override fun resetAutoSync() { - autoSynced.set(false) - } - - private val listener = object : SyncAccountListener { - override suspend fun onLog(message: SyncLogMessage) { - Napier.i(message.message) - _status.update { it.copy(log = (it.log + message).takeLast(MAX_LOG_ENTRIES)) } - } - - override suspend fun onProjectsDiscovered(projects: List) { - _status.update { status -> - status.copy(projects = projects.associate { it.name to (status.projects[it.name] ?: ProjectSyncState()) }) - } - } - - override suspend fun onProjectProgress(projectDef: ProjectDef, progress: Float?) { - updateProject(projectDef) { it.copy(progress = progress ?: it.progress, outcome = null) } - } - - override suspend fun onProjectOutcome(projectDef: ProjectDef, outcome: ProjectSyncOutcome) { - updateProject(projectDef) { it.copy(outcome = outcome) } - } - - override suspend fun onUnauthorized() { - _status.update { it.copy(needsReauth = true) } - } - - // The watch has no conflict UI; the idea stays unresolved for a phone or desktop to settle. - override suspend fun onIdeaConflict(conflict: IdeaConflict): StoryIdea? = null - } - - private fun updateProject(projectDef: ProjectDef, block: (ProjectSyncState) -> ProjectSyncState) { - _status.update { status -> - val current = status.projects[projectDef.name] ?: ProjectSyncState() - status.copy(projects = status.projects + (projectDef.name to block(current))) - } - } - - private companion object { - const val MAX_LOG_ENTRIES = 300 - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncScheduler.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncScheduler.kt deleted file mode 100644 index 2a4fe97ac..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncScheduler.kt +++ /dev/null @@ -1,52 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import androidx.work.Constraints -import androidx.work.ExistingPeriodicWorkPolicy -import androidx.work.NetworkType -import androidx.work.PeriodicWorkRequestBuilder -import androidx.work.WorkManager -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.wear.data.isSignedIn -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.launch -import java.util.concurrent.TimeUnit - -/** Keeps the periodic background sync scheduled exactly while an account is signed in. */ -class SyncScheduler( - private val workManager: WorkManager, - private val globalSettingsStore: GlobalSettingsStore, - private val appScope: CoroutineScope, -) { - fun start() { - applySignedIn(globalSettingsStore.serverSettings.isSignedIn()) - appScope.launch { - globalSettingsStore.serverSettingsUpdates.collect { settings -> - applySignedIn(settings.isSignedIn()) - } - } - } - - fun cancel() { - workManager.cancelUniqueWork(WORK_NAME) - } - - private fun applySignedIn(signedIn: Boolean) { - if (signedIn) schedule() else cancel() - } - - private fun schedule() { - val constraints = Constraints.Builder() - .setRequiredNetworkType(NetworkType.CONNECTED) - .setRequiresBatteryNotLow(true) - .build() - val request = PeriodicWorkRequestBuilder(SYNC_INTERVAL_HOURS, TimeUnit.HOURS) - .setConstraints(constraints) - .build() - workManager.enqueueUniquePeriodicWork(WORK_NAME, ExistingPeriodicWorkPolicy.KEEP, request) - } - - private companion object { - const val WORK_NAME = "hammer_account_sync" - const val SYNC_INTERVAL_HOURS = 6L - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncStatus.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncStatus.kt deleted file mode 100644 index 53b22ec38..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/sync/SyncStatus.kt +++ /dev/null @@ -1,36 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountResult -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage - -enum class SyncTrigger { AppOpen, Manual, Periodic, Capture } - -/** Per-project progress, keyed by project name like [SyncAccountResult.projects]. */ -data class ProjectSyncState( - val progress: Float? = null, - val outcome: ProjectSyncOutcome? = null, -) - -data class SyncStatus( - val running: Boolean = false, - val trigger: SyncTrigger? = null, - val projects: Map = emptyMap(), - val log: List = emptyList(), - val lastResult: SyncAccountResult? = null, - val lastRunFailed: Boolean = false, - val needsReauth: Boolean = false, -) - -sealed interface SyncRunResult { - /** There is no account to sync. */ - data object Skipped : SyncRunResult - - /** - * Another sync held the lock. The caller's own writing may not have been part of it, so work - * that needs its captures uploaded has to ask again rather than treat this as done. - */ - data object Busy : SyncRunResult - data class Completed(val result: SyncAccountResult) : SyncRunResult - data object Failed : SyncRunResult -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureSurfaceUpdater.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureSurfaceUpdater.kt deleted file mode 100644 index 8991c4744..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureSurfaceUpdater.kt +++ /dev/null @@ -1,31 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.tile - -import android.content.ComponentName -import android.content.Context -import androidx.wear.tiles.TileService -import androidx.wear.watchface.complications.datasource.ComplicationDataSourceUpdateRequester -import com.darkrockstudios.apps.hammer.wear.complication.CaptureComplicationService -import io.github.aakira.napier.Napier - -/** - * The tile and complication are cached by the system and only re-read on their own slow cadence, so - * anything that changes the pending count has to say so or the watch face keeps showing a stale one. - */ -interface CaptureSurfaceUpdater { - fun refresh() -} - -class WearCaptureSurfaceUpdater(private val context: Context) : CaptureSurfaceUpdater { - - override fun refresh() { - // Refreshing is only ever cosmetic, so it must never take down the capture that triggered it. - try { - TileService.getUpdater(context).requestUpdate(CaptureTileService::class.java) - ComplicationDataSourceUpdateRequester - .create(context, ComponentName(context, CaptureComplicationService::class.java)) - .requestUpdateAll() - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.w("Could not refresh the watch face surfaces", e) - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureTileService.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureTileService.kt deleted file mode 100644 index 6a92e2789..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/tile/CaptureTileService.kt +++ /dev/null @@ -1,176 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.tile - -import androidx.concurrent.futures.CallbackToFutureAdapter -import androidx.wear.protolayout.ActionBuilders -import androidx.wear.protolayout.DeviceParametersBuilders.DeviceParameters -import androidx.wear.protolayout.DimensionBuilders.dp -import androidx.wear.protolayout.DimensionBuilders.expand -import androidx.wear.protolayout.LayoutElementBuilders -import androidx.wear.protolayout.LayoutElementBuilders.LayoutElement -import androidx.wear.protolayout.ResourceBuilders -import androidx.wear.protolayout.TimelineBuilders -import androidx.wear.protolayout.material3.MaterialScope -import androidx.wear.protolayout.material3.Typography -import androidx.wear.protolayout.material3.buttonGroup -import androidx.wear.protolayout.material3.compactButton -import androidx.wear.protolayout.material3.ButtonDefaults.filledTonalButtonColors -import androidx.wear.protolayout.material3.materialScope -import androidx.wear.protolayout.material3.primaryLayout -import androidx.wear.protolayout.material3.text -import androidx.wear.protolayout.material3.textButton -import androidx.wear.protolayout.modifiers.clickable -import androidx.wear.protolayout.types.LayoutString -import androidx.wear.tiles.RequestBuilders -import androidx.wear.tiles.TileBuilders -import androidx.wear.tiles.TileService -import com.darkrockstudios.apps.hammer.wear.CaptureActivity -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture -import com.darkrockstudios.apps.hammer.wear.data.CaptureTileState -import com.darkrockstudios.apps.hammer.wear.data.CaptureTileStateUseCase -import com.google.common.util.concurrent.ListenableFuture -import io.github.aakira.napier.Napier -import kotlinx.coroutines.CancellationException -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.SupervisorJob -import kotlinx.coroutines.cancel -import kotlinx.coroutines.launch -import org.koin.core.component.KoinComponent -import org.koin.core.component.inject -import java.util.concurrent.TimeUnit - -/** One tap from the watch face to dictating a note or an idea. */ -class CaptureTileService : TileService(), KoinComponent { - - private val tileState: CaptureTileStateUseCase by inject() - private val serviceScope = CoroutineScope(SupervisorJob() + Dispatchers.Default) - - override fun onDestroy() { - serviceScope.cancel("Tile service destroyed") - super.onDestroy() - } - - override fun onTileRequest( - requestParams: RequestBuilders.TileRequest, - ): ListenableFuture = future { completer -> - serviceScope.launch { - val state = try { - tileState.load() - } catch (e: CancellationException) { - throw e - } catch (@Suppress("TooGenericExceptionCaught") e: Exception) { - Napier.e("Failed to read the capture tile's state", e) - CaptureTileState() - } - completer.set(buildTile(state, requestParams.deviceConfiguration)) - } - } - - override fun onTileResourcesRequest( - requestParams: RequestBuilders.ResourcesRequest, - ): ListenableFuture = future { completer -> - completer.set(ResourceBuilders.Resources.Builder().setVersion(RESOURCES_VERSION).build()) - } - - private fun buildTile(state: CaptureTileState, device: DeviceParameters): TileBuilders.Tile = - TileBuilders.Tile.Builder() - .setResourcesVersion(RESOURCES_VERSION) - .setTileTimeline( - TimelineBuilders.Timeline.fromLayoutElement(layout(state, device)) - ) - // Nothing tells the tile a sync finished, so it re-reads on its own cadence. - .setFreshnessIntervalMillis(TimeUnit.MINUTES.toMillis(FRESHNESS_MINUTES)) - .build() - - private fun layout(state: CaptureTileState, device: DeviceParameters): LayoutElement = - materialScope(this, device) { - primaryLayout( - // The project sits in the main slot, not the title: the title slot does not - // receive taps, and this one has to be pressable to change where a note goes. - mainSlot = { - LayoutElementBuilders.Column.Builder() - .setWidth(expand()) - .setHeight(expand()) - .addContent(projectButton(state)) - .addContent( - LayoutElementBuilders.Spacer.Builder() - .setHeight(dp(PROJECT_TO_BUTTONS_SPACING_DP)) - .build() - ) - .addContent( - buttonGroup { - buttonGroupItem { captureButton(Capture.Mode.Note, R.string.tile_note) } - buttonGroupItem { captureButton(Capture.Mode.Idea, R.string.tile_idea) } - } - ) - .build() - }, - bottomSlot = state.pending?.takeIf { it > 0 }?.let { pending -> - { pendingText(pending) } - }, - ) - } - - /** A button, not a label: this is how the project a note goes to gets changed. */ - private fun MaterialScope.projectButton(state: CaptureTileState): LayoutElement = compactButton( - onClick = clickable( - action = launchCapture(Capture.Mode.Note, pickProject = true), - id = "pick_project", - ), - labelContent = { - text( - LayoutString(state.projectName ?: getString(R.string.tile_no_project)), - maxLines = 1, - ) - }, - colors = filledTonalButtonColors(), - ) - - private fun MaterialScope.pendingText(pending: Int): LayoutElement = text( - text = LayoutString(getString(R.string.tile_pending, pending)), - typography = Typography.BODY_MEDIUM, - maxLines = 1, - ) - - private fun MaterialScope.captureButton(mode: Capture.Mode, labelRes: Int): LayoutElement = - textButton( - onClick = clickable(action = launchCapture(mode), id = mode.name), - // Two lines so "Story idea" reads in full rather than truncating. - labelContent = { text(LayoutString(getString(labelRes)), maxLines = 2) }, - width = expand(), - height = expand(), - ) - - private fun launchCapture( - mode: Capture.Mode, - pickProject: Boolean = false, - ): ActionBuilders.LaunchAction = ActionBuilders.LaunchAction.Builder() - .setAndroidActivity( - ActionBuilders.AndroidActivity.Builder() - .setPackageName(packageName) - .setClassName(CaptureActivity::class.java.name) - .addKeyToExtraMapping(CaptureActivity.EXTRA_MODE, ActionBuilders.stringExtra(mode.name)) - // Thar be dragons: the tile renderer drops an AndroidBooleanExtra, and the whole - // launch action goes with it, so this travels as a string. - .addKeyToExtraMapping( - CaptureActivity.EXTRA_PICK_PROJECT, - ActionBuilders.stringExtra(pickProject.toString()), - ) - .build() - ) - .build() - - private companion object { - const val RESOURCES_VERSION = "1" - const val FRESHNESS_MINUTES = 15L - const val PROJECT_TO_BUTTONS_SPACING_DP = 4f - } -} - -private fun future( - block: (CallbackToFutureAdapter.Completer) -> Unit, -): ListenableFuture = CallbackToFutureAdapter.getFuture { completer -> - block(completer) - "CaptureTile" -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/CaptureScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/CaptureScreen.kt deleted file mode 100644 index 2d6ef13c0..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/CaptureScreen.kt +++ /dev/null @@ -1,255 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.dp -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.CircularProgressIndicator -import androidx.wear.compose.material3.EdgeButton -import androidx.wear.compose.material3.FilledTonalButton -import androidx.wear.compose.material3.ListHeader -import androidx.wear.compose.material3.MaterialTheme -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture - -@Composable -fun CaptureScreen( - state: Capture.State, - onEditText: () -> Unit, - onShowProjectPicker: () -> Unit, - onSelectProject: (String) -> Unit, - onDismissProjectPicker: () -> Unit, - onCancelDiscard: () -> Unit, - onDiscard: () -> Unit, - onSave: () -> Unit, - onDone: () -> Unit, -) { - val outcome = state.outcome - when { - outcome != null -> CaptureOutcomeContent(outcome = outcome, onDone = onDone) - state.confirmingDiscard -> DiscardConfirmContent( - mode = state.mode, - onKeepEditing = onCancelDiscard, - onDiscard = onDiscard, - ) - - state.pickingProject -> ProjectPickerContent( - state = state, - onSelectProject = onSelectProject, - onCancel = onDismissProjectPicker, - ) - else -> CaptureEntryContent( - state = state, - onEditText = onEditText, - onShowProjectPicker = onShowProjectPicker, - onSave = onSave, - ) - } -} - -@Composable -private fun CaptureEntryContent( - state: Capture.State, - onEditText: () -> Unit, - onShowProjectPicker: () -> Unit, - onSave: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - val notSet = stringResource(R.string.capture_text_empty) - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onSave, enabled = state.canSave) { - if (state.saving) { - CircularProgressIndicator(modifier = Modifier.size(24.dp)) - } else { - Text(stringResource(R.string.capture_save)) - } - } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { - Text( - stringResource( - if (state.mode == Capture.Mode.Idea) R.string.capture_title_idea else R.string.capture_title_note - ) - ) - } - } - item { - FilledTonalButton( - onClick = onEditText, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.capture_text_label)) }, - secondaryLabel = { Text(state.text.ifBlank { notSet }, maxLines = 3) }, - ) - } - if (state.mode == Capture.Mode.Note) { - item { - FilledTonalButton( - onClick = onShowProjectPicker, - enabled = state.projects.size > 1, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.capture_project_label)) }, - secondaryLabel = { - Text( - state.projectName ?: stringResource( - if (state.loading) R.string.capture_project_loading else R.string.capture_project_none - ), - maxLines = 1, - ) - }, - ) - } - } - } - } -} - -@Composable -private fun ProjectPickerContent( - state: Capture.State, - onSelectProject: (String) -> Unit, - onCancel: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onCancel) { Text(stringResource(R.string.capture_project_keep)) } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.capture_project_label)) } - } - items(count = state.projects.size, key = { state.projects[it] }) { index -> - val name = state.projects[index] - FilledTonalButton( - onClick = { onSelectProject(name) }, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(name, maxLines = 2) }, - ) - } - } - } -} - -@Composable -private fun DiscardConfirmContent( - mode: Capture.Mode, - onKeepEditing: () -> Unit, - onDiscard: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - - ScreenScaffold( - scrollState = listState, - // The edge button is the easiest thing to hit, so it is the one that keeps the writing. - edgeButton = { - EdgeButton(onClick = onKeepEditing) { Text(stringResource(R.string.capture_discard_keep)) } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { - Text( - stringResource( - if (mode == Capture.Mode.Idea) { - R.string.capture_discard_title_idea - } else { - R.string.capture_discard_title_note - } - ) - ) - } - } - item { - Text( - text = stringResource(R.string.capture_discard_body), - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - item { - FilledTonalButton( - onClick = onDiscard, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.capture_discard_confirm)) }, - ) - } - } - } -} - -@Composable -private fun CaptureOutcomeContent( - outcome: Capture.Outcome, - onDone: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onDone) { Text(stringResource(R.string.capture_done)) } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { - Text( - stringResource( - when (outcome) { - is Capture.Outcome.Saved -> R.string.capture_saved - Capture.Outcome.NoProjects -> R.string.capture_no_projects_title - Capture.Outcome.Failed -> R.string.capture_failed - } - ) - ) - } - } - item { - Text( - text = when (outcome) { - is Capture.Outcome.Saved -> when { - outcome.pending == null -> stringResource(R.string.capture_pending_checking) - outcome.pending > 0 -> stringResource(R.string.capture_pending_count, outcome.pending) - else -> stringResource(R.string.capture_pending_none) - } - - Capture.Outcome.NoProjects -> stringResource(R.string.capture_no_projects_body) - Capture.Outcome.Failed -> stringResource(R.string.capture_failed_body) - }, - color = when (outcome) { - is Capture.Outcome.Saved -> MaterialTheme.colorScheme.onSurfaceVariant - else -> MaterialTheme.colorScheme.error - }, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ListItemModifiers.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ListItemModifiers.kt deleted file mode 100644 index 8de8ec93a..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ListItemModifiers.kt +++ /dev/null @@ -1,58 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.padding -import androidx.compose.runtime.Composable -import androidx.compose.runtime.remember -import androidx.compose.ui.Modifier -import androidx.compose.ui.graphics.graphicsLayer -import androidx.compose.ui.unit.Dp -import androidx.compose.ui.unit.dp -import androidx.wear.compose.foundation.lazy.TransformingLazyColumnItemScope -import androidx.wear.compose.material3.ButtonDefaults -import androidx.wear.compose.material3.ListHeaderDefaults -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.lazy.TransformationSpec -import androidx.wear.compose.material3.lazy.transformedHeight - -// Items shrink and fade toward the top and bottom of the screen so a round bezel never clips them. - -/** Pair with `transformation = SurfaceTransformation(spec)`. */ -@Composable -fun Modifier.listButton(scope: TransformingLazyColumnItemScope, spec: TransformationSpec): Modifier = - listSurface(scope, spec, ButtonDefaults.minimumVerticalListContentPadding) - -/** Pair with `transformation = SurfaceTransformation(spec)`. */ -@Composable -fun Modifier.listHeader(scope: TransformingLazyColumnItemScope, spec: TransformationSpec): Modifier = - listSurface(scope, spec, ListHeaderDefaults.minimumTopListContentPadding) - -private fun Modifier.listSurface( - scope: TransformingLazyColumnItemScope, - spec: TransformationSpec, - minimumVerticalPadding: Dp, -): Modifier = with(scope) { - fillMaxWidth() - .transformedHeight(scope, spec) - .minimumVerticalContentPadding(minimumVerticalPadding) -} - -// Same inset a ListHeader gives its content. Text has no pill to morph, so at full width its -// outer lines reach the bezel near the top and bottom before the scale shrinks them enough. -private val TextHorizontalPadding = 14.dp - -@Composable -fun Modifier.listText(scope: TransformingLazyColumnItemScope, spec: TransformationSpec): Modifier = - listContent(scope, spec).fillMaxWidth().padding(horizontal = TextHorizontalPadding) - -/** For content with no `transformation` parameter of its own. */ -@Composable -fun Modifier.listContent(scope: TransformingLazyColumnItemScope, spec: TransformationSpec): Modifier { - val transformed = remember(scope, spec) { - val transformation = scope.SurfaceTransformation(spec) - Modifier - .transformedHeight(scope, spec) - .graphicsLayer { with(transformation) { applyContainerTransformation() } } - } - return then(transformed) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/LocalNetworkPermission.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/LocalNetworkPermission.kt deleted file mode 100644 index d4d2ed948..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/LocalNetworkPermission.kt +++ /dev/null @@ -1,38 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.activity.compose.rememberLauncherForActivityResult -import androidx.activity.result.contract.ActivityResultContracts -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.saveable.rememberSaveable -import androidx.compose.runtime.setValue -import com.darkrockstudios.apps.hammer.wear.data.ACCESS_LOCAL_NETWORK - -/** - * Shows the system local network prompt. Whether it is needed at all is the component's call, made - * from the server address; this only asks. [onResult] runs whichever way the user answers. - */ -@Composable -fun rememberLocalNetworkPermissionRequest(onResult: () -> Unit): () -> Unit { - val launcher = rememberLauncherForActivityResult(ActivityResultContracts.RequestPermission()) { - onResult() - } - return { launcher.launch(ACCESS_LOCAL_NETWORK) } -} - -/** - * Asks once, the first time [needed] turns true, rather than on every recomposition or rotation. - * Asking again is left to an explicit tap. - */ -@Composable -fun AskForLocalNetworkOnce(needed: Boolean, request: () -> Unit) { - var asked by rememberSaveable { mutableStateOf(false) } - LaunchedEffect(needed) { - if (needed && !asked) { - asked = true - request() - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ManualSignInScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ManualSignInScreen.kt deleted file mode 100644 index d2f73fd38..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/ManualSignInScreen.kt +++ /dev/null @@ -1,200 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import android.app.Activity -import android.app.RemoteInput -import android.content.Intent -import androidx.activity.compose.rememberLauncherForActivityResult -import androidx.activity.result.contract.ActivityResultContracts -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.dp -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.TransformingLazyColumnItemScope -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.CircularProgressIndicator -import androidx.wear.compose.material3.EdgeButton -import androidx.wear.compose.material3.FilledTonalButton -import androidx.wear.compose.material3.ListHeader -import androidx.wear.compose.material3.MaterialTheme -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.TransformationSpec -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import androidx.wear.input.RemoteInputIntentHelper -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.signin.ManualSignIn - -private enum class SignInField { Server, Email, Password } - -private const val REMOTE_INPUT_KEY = "sign_in_field" - -@Composable -fun ManualSignInUi(component: ManualSignIn) { - val state by component.state.subscribeAsState() - var editing by remember { mutableStateOf(null) } - - val launcher = rememberLauncherForActivityResult(ActivityResultContracts.StartActivityForResult()) { result -> - val field = editing - editing = null - val data = result.data - if (result.resultCode != Activity.RESULT_OK || data == null || field == null) return@rememberLauncherForActivityResult - val text = RemoteInput.getResultsFromIntent(data)?.getCharSequence(REMOTE_INPUT_KEY)?.toString() - ?: return@rememberLauncherForActivityResult - when (field) { - SignInField.Server -> component.updateServer(text) - SignInField.Email -> component.updateEmail(text) - SignInField.Password -> component.updatePassword(text) - } - } - - val requestLocalNetwork = rememberLocalNetworkPermissionRequest(component::onLocalNetworkPermissionResult) - // Every attempt asks, since each one is an explicit tap on Sign in. - LaunchedEffect(state.localNetworkBlocked) { - if (state.localNetworkBlocked) requestLocalNetwork() - } - - val labels = mapOf( - SignInField.Server to stringResource(R.string.sign_in_server), - SignInField.Email to stringResource(R.string.sign_in_email), - SignInField.Password to stringResource(R.string.sign_in_password), - ) - - ManualSignInScreen( - state = state, - onEditField = { field -> - editing = field - val intent: Intent = RemoteInputIntentHelper.createActionRemoteInputIntent() - RemoteInputIntentHelper.putRemoteInputsExtra( - intent, - listOf(RemoteInput.Builder(REMOTE_INPUT_KEY).setLabel(labels.getValue(field)).build()), - ) - launcher.launch(intent) - }, - onSignIn = component::signIn, - ) -} - -@Composable -private fun ManualSignInScreen( - state: ManualSignIn.State, - onEditField: (SignInField) -> Unit, - onSignIn: () -> Unit, -) { - ManualSignInContent( - state = state, - onEditServer = { onEditField(SignInField.Server) }, - onEditEmail = { onEditField(SignInField.Email) }, - onEditPassword = { onEditField(SignInField.Password) }, - onSignIn = onSignIn, - ) -} - -@Composable -fun ManualSignInContent( - state: ManualSignIn.State, - onEditServer: () -> Unit, - onEditEmail: () -> Unit, - onEditPassword: () -> Unit, - onSignIn: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - val notSet = stringResource(R.string.sign_in_not_set) - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onSignIn, enabled = !state.busy) { - if (state.busy) { - CircularProgressIndicator(modifier = Modifier.size(24.dp)) - } else { - Text(stringResource(R.string.sign_in_button)) - } - } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.sign_in_title)) } - } - item { - SignInFieldButton( - spec = spec, - label = stringResource(R.string.sign_in_server), - value = state.server.ifBlank { notSet }, - onClick = onEditServer, - ) - } - if (state.serverInsecure) { - item { - Text( - text = stringResource(R.string.sign_in_insecure_warning), - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - item { - SignInFieldButton( - spec = spec, - label = stringResource(R.string.sign_in_email), - value = state.email.ifBlank { notSet }, - onClick = onEditEmail, - ) - } - item { - SignInFieldButton( - spec = spec, - label = stringResource(R.string.sign_in_password), - value = if (state.hasPassword) "••••••" else notSet, - onClick = onEditPassword, - ) - } - val error = state.error - if (error != null) { - item { - Text( - text = when (error) { - ManualSignIn.SignInError.MissingFields -> stringResource(R.string.sign_in_error_missing) - ManualSignIn.SignInError.TermsRequired -> stringResource(R.string.sign_in_error_terms) - ManualSignIn.SignInError.LocalNetworkDenied -> - stringResource(R.string.sign_in_error_local_network) - is ManualSignIn.SignInError.Message -> - error.text ?: stringResource(R.string.sign_in_error_generic) - }, - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - } - } -} - -@Composable -private fun TransformingLazyColumnItemScope.SignInFieldButton( - spec: TransformationSpec, - label: String, - value: String, - onClick: () -> Unit, -) { - FilledTonalButton( - onClick = onClick, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(label) }, - secondaryLabel = { Text(value, maxLines = 1) }, - ) -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/OnboardingScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/OnboardingScreen.kt deleted file mode 100644 index 1cbea1646..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/OnboardingScreen.kt +++ /dev/null @@ -1,55 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.runtime.Composable -import androidx.compose.ui.Modifier -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.Button -import androidx.wear.compose.material3.FilledTonalButton -import androidx.wear.compose.material3.ListHeader -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import com.darkrockstudios.apps.hammer.wear.R - -@Composable -fun OnboardingScreen( - onPair: () -> Unit, - onManualSignIn: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - ScreenScaffold(scrollState = listState) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.app_name)) } - } - item { - Text( - text = stringResource(R.string.onboarding_body), - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - item { - Button( - onClick = onPair, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.onboarding_pair)) }, - ) - } - item { - FilledTonalButton( - onClick = onManualSignIn, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.onboarding_manual_sign_in)) }, - ) - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/PairingScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/PairingScreen.kt deleted file mode 100644 index 13cc1eb6f..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/PairingScreen.kt +++ /dev/null @@ -1,100 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.dp -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.Button -import androidx.wear.compose.material3.CircularProgressIndicator -import androidx.wear.compose.material3.FilledTonalButton -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.pairing.Pairing -import com.darkrockstudios.apps.hammer.wear.pairing.PairingState - -@Composable -fun PairingUi(component: Pairing) { - val state by component.state.subscribeAsState() - PairingScreen( - state = state, - onRetry = component::startPairing, - onCancel = component::cancel, - ) -} - -@Composable -fun PairingScreen( - state: PairingState, - onRetry: () -> Unit, - onCancel: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - val waiting = state == PairingState.Idle || - state == PairingState.SearchingPhone || - state == PairingState.AwaitingConfirmation - - ScreenScaffold(scrollState = listState) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - if (waiting) { - item { - CircularProgressIndicator(modifier = Modifier.listContent(this, spec).size(36.dp)) - } - } - item { - Text( - text = stringResource(pairingMessage(state)), - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - if (state == PairingState.PhoneNotFound || state is PairingState.Failed) { - item { - Button( - onClick = onRetry, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.pairing_retry)) }, - ) - } - } - if (state != PairingState.Paired) { - item { - FilledTonalButton( - onClick = onCancel, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.pairing_cancel)) }, - ) - } - } - } - } -} - -private fun pairingMessage(state: PairingState): Int = when (state) { - PairingState.Idle, - PairingState.SearchingPhone -> R.string.pairing_searching - - PairingState.AwaitingConfirmation -> R.string.pairing_awaiting - PairingState.Paired -> R.string.pairing_paired - PairingState.PhoneNotFound -> R.string.pairing_not_found - is PairingState.Failed -> when (state.reason) { - PairErrorCode.Declined -> R.string.pairing_failed_declined - PairErrorCode.NotSignedIn -> R.string.pairing_failed_not_signed_in - PairErrorCode.ServerRejected -> R.string.pairing_failed_server - PairErrorCode.Unsupported -> R.string.pairing_failed_unsupported - PairErrorCode.PhoneUnavailable -> R.string.pairing_failed_phone_unavailable - null -> R.string.pairing_failed - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/SyncLogScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/SyncLogScreen.kt deleted file mode 100644 index 79289482c..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/SyncLogScreen.kt +++ /dev/null @@ -1,66 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.text.style.TextOverflow -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.ListHeader -import androidx.wear.compose.material3.MaterialTheme -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogLevel -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.synclog.SyncLog - -@Composable -fun SyncLogUi(component: SyncLog) { - val state by component.state.subscribeAsState() - SyncLogScreen(state) -} - -@Composable -fun SyncLogScreen(state: SyncLog.State) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - ScreenScaffold(scrollState = listState) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.sync_log_title)) } - } - if (state.entries.isEmpty()) { - item { - Text( - text = stringResource(R.string.sync_log_empty), - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - items(count = state.entries.size) { index -> - val entry = state.entries[index] - val prefix = entry.projectName?.let { "$it: " } ?: "" - Text( - text = prefix + entry.message, - style = MaterialTheme.typography.bodySmall, - textAlign = TextAlign.Center, - // Taller entries outgrow the edge transformation and run under the bezel. - maxLines = 5, - overflow = TextOverflow.Ellipsis, - color = when (entry.level) { - SyncLogLevel.ERROR -> MaterialTheme.colorScheme.error - SyncLogLevel.WARN -> MaterialTheme.colorScheme.tertiary - SyncLogLevel.INFO, SyncLogLevel.DEBUG -> MaterialTheme.colorScheme.onSurface - }, - modifier = Modifier.listText(this, spec), - ) - } - } - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearProjectsScreen.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearProjectsScreen.kt deleted file mode 100644 index 4214e48fd..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearProjectsScreen.kt +++ /dev/null @@ -1,309 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.foundation.layout.size -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.ui.Modifier -import androidx.compose.ui.platform.LocalContext -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.unit.dp -import androidx.wear.compose.foundation.lazy.TransformingLazyColumn -import androidx.wear.compose.foundation.lazy.rememberTransformingLazyColumnState -import androidx.wear.compose.material3.CircularProgressIndicator -import androidx.wear.compose.material3.EdgeButton -import androidx.wear.compose.material3.FilledTonalButton -import androidx.wear.compose.material3.ListHeader -import androidx.wear.compose.material3.MaterialTheme -import androidx.wear.compose.material3.ScreenScaffold -import androidx.wear.compose.material3.SurfaceTransformation -import androidx.wear.compose.material3.SwitchButton -import androidx.wear.compose.material3.Text -import androidx.wear.compose.material3.lazy.rememberTransformationSpec -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.wear.CaptureActivity -import com.darkrockstudios.apps.hammer.wear.R -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture -import com.darkrockstudios.apps.hammer.wear.components.projects.WearProjects -import kotlin.math.roundToInt - -@Composable -fun WearProjectsUi(component: WearProjects) { - val state by component.state.subscribeAsState() - val context = LocalContext.current - val requestLocalNetwork = rememberLocalNetworkPermissionRequest(component::onLocalNetworkPermissionResult) - AskForLocalNetworkOnce(needed = state.localNetworkBlocked, request = requestLocalNetwork) - WearProjectsScreen( - state = state, - onAllowLocalNetwork = requestLocalNetwork, - onNewNote = { context.startActivity(CaptureActivity.intent(context, Capture.Mode.Note)) }, - onNewIdea = { context.startActivity(CaptureActivity.intent(context, Capture.Mode.Idea)) }, - onToggleSubscription = component::toggleSubscription, - onSyncNow = component::syncNow, - onShowSyncLog = component::showSyncLog, - onSignOut = component::signOut, - onConfirmSignOut = component::confirmSignOut, - onCancelSignOut = component::cancelSignOut, - onDismissNotice = component::dismissNotice, - ) -} - -@Composable -fun WearProjectsScreen( - state: WearProjects.State, - onAllowLocalNetwork: () -> Unit, - onNewNote: () -> Unit, - onNewIdea: () -> Unit, - onToggleSubscription: (projectName: String) -> Unit, - onSyncNow: () -> Unit, - onShowSyncLog: () -> Unit, - onSignOut: () -> Unit, - onConfirmSignOut: () -> Unit, - onCancelSignOut: () -> Unit, - onDismissNotice: () -> Unit, -) { - val warning = state.signOutWarning - if (warning != null) { - SignOutWarningContent(warning = warning, onConfirm = onConfirmSignOut, onCancel = onCancelSignOut) - } else { - ProjectsContent( - state = state, - onAllowLocalNetwork = onAllowLocalNetwork, - onNewNote = onNewNote, - onNewIdea = onNewIdea, - onToggleSubscription = onToggleSubscription, - onSyncNow = onSyncNow, - onShowSyncLog = onShowSyncLog, - onSignOut = onSignOut, - onDismissNotice = onDismissNotice, - ) - } -} - -@Composable -private fun ProjectsContent( - state: WearProjects.State, - onAllowLocalNetwork: () -> Unit, - onNewNote: () -> Unit, - onNewIdea: () -> Unit, - onToggleSubscription: (projectName: String) -> Unit, - onSyncNow: () -> Unit, - onShowSyncLog: () -> Unit, - onSignOut: () -> Unit, - onDismissNotice: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onSyncNow, enabled = !state.syncing) { - if (state.syncing) { - CircularProgressIndicator(modifier = Modifier.size(24.dp)) - } else { - Text(stringResource(R.string.projects_sync_now)) - } - } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.projects_header)) } - } - state.accountEmail?.let { email -> - item { - Text( - text = stringResource(R.string.projects_signed_in_as, email), - style = MaterialTheme.typography.bodySmall, - color = MaterialTheme.colorScheme.onSurfaceVariant, - textAlign = TextAlign.Center, - maxLines = 1, - modifier = Modifier.listText(this, spec), - ) - } - } - item { - FilledTonalButton( - onClick = onNewNote, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_new_note)) }, - ) - } - item { - FilledTonalButton( - onClick = onNewIdea, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_new_idea)) }, - ) - } - if (state.localNetworkBlocked) { - item { - Text( - text = stringResource(R.string.projects_local_network_needed), - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - item { - FilledTonalButton( - onClick = onAllowLocalNetwork, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_local_network_allow)) }, - ) - } - } - if (state.needsReauth || state.lastSyncFailed) { - item { - Text( - text = stringResource( - if (state.needsReauth) R.string.projects_needs_reauth else R.string.projects_last_sync_failed - ), - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - state.notice?.let { notice -> - item { - Text( - text = when (notice.reason) { - WearProjects.Notice.Reason.UnsyncedKept -> - stringResource(R.string.projects_unsynced_kept, notice.projectName) - - WearProjects.Notice.Reason.Failed -> - stringResource(R.string.projects_unsubscribe_failed, notice.projectName) - }, - color = when (notice.reason) { - WearProjects.Notice.Reason.UnsyncedKept -> MaterialTheme.colorScheme.tertiary - WearProjects.Notice.Reason.Failed -> MaterialTheme.colorScheme.error - }, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - item { - FilledTonalButton( - onClick = onDismissNotice, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_notice_dismiss)) }, - ) - } - } - if (state.projects.isEmpty()) { - item { - Text( - text = stringResource(if (state.loaded) R.string.projects_empty else R.string.projects_loading), - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - } - items(count = state.projects.size, key = { state.projects[it].name }) { index -> - val row = state.projects[index] - SwitchButton( - checked = row.subscribed, - onCheckedChange = { onToggleSubscription(row.name) }, - enabled = row.canSubscribe && !row.unsubscribing, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(row.name, maxLines = 1) }, - secondaryLabel = { Text(projectStatus(row), maxLines = 1) }, - ) - } - item { - FilledTonalButton( - onClick = onShowSyncLog, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_sync_log)) }, - ) - } - item { - FilledTonalButton( - onClick = onSignOut, - enabled = !state.checkingSignOut, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_sign_out)) }, - icon = if (state.checkingSignOut) { - { CircularProgressIndicator(modifier = Modifier.size(20.dp)) } - } else { - null - }, - ) - } - } - } -} - -@Composable -private fun SignOutWarningContent( - warning: WearProjects.SignOutWarning, - onConfirm: () -> Unit, - onCancel: () -> Unit, -) { - val listState = rememberTransformingLazyColumnState() - val spec = rememberTransformationSpec() - - ScreenScaffold( - scrollState = listState, - edgeButton = { - EdgeButton(onClick = onCancel) { - Text(stringResource(R.string.projects_sign_out_cancel)) - } - }, - ) { contentPadding -> - TransformingLazyColumn(state = listState, contentPadding = contentPadding) { - item { - ListHeader(modifier = Modifier.listHeader(this, spec), transformation = SurfaceTransformation(spec)) { Text(stringResource(R.string.projects_sign_out)) } - } - item { - Text( - text = if (warning.items > 0) { - stringResource(R.string.projects_sign_out_warning_count, warning.items) - } else { - stringResource(R.string.projects_sign_out_warning_unknown) - }, - color = MaterialTheme.colorScheme.error, - textAlign = TextAlign.Center, - modifier = Modifier.listText(this, spec), - ) - } - item { - FilledTonalButton( - onClick = onConfirm, - modifier = Modifier.listButton(this, spec), - transformation = SurfaceTransformation(spec), - label = { Text(stringResource(R.string.projects_sign_out_confirm)) }, - ) - } - } - } -} - -@Composable -private fun projectStatus(row: WearProjects.ProjectRow): String { - val progress = row.progress - return when { - !row.canSubscribe -> stringResource(R.string.project_status_not_on_server) - row.unsubscribing -> stringResource(R.string.project_status_unsubscribing) - row.outcome == null && progress != null -> - stringResource(R.string.project_status_syncing, (progress * 100).roundToInt()) - - row.outcome == ProjectSyncOutcome.Success || row.outcome == ProjectSyncOutcome.Unchanged -> - stringResource(R.string.project_status_synced) - - row.outcome == ProjectSyncOutcome.NeedsResolution -> stringResource(R.string.project_status_needs_resolution) - row.outcome == ProjectSyncOutcome.Failed -> stringResource(R.string.project_status_failed) - row.subscribed -> stringResource(R.string.project_status_on_watch) - else -> stringResource(R.string.project_status_not_on_watch) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearRootUi.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearRootUi.kt deleted file mode 100644 index d16cb96fd..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/WearRootUi.kt +++ /dev/null @@ -1,50 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui - -import androidx.compose.runtime.Composable -import androidx.compose.runtime.getValue -import androidx.compose.runtime.saveable.rememberSaveableStateHolder -import androidx.wear.compose.material3.AppScaffold -import androidx.wear.compose.material3.SwipeToDismissBox -import androidx.wear.compose.material3.TimeText -import com.arkivanov.decompose.extensions.compose.subscribeAsState -import com.darkrockstudios.apps.hammer.wear.components.WearRoot - -@Composable -fun WearRootUi(component: WearRoot) { - val stack by component.stack.subscribeAsState() - val saveableStateHolder = rememberSaveableStateHolder() - - AppScaffold(timeText = { TimeText() }) { - val active = stack.active - val previous = stack.backStack.lastOrNull() - - SwipeToDismissBox( - onDismissed = component::onBack, - backgroundKey = previous?.configuration ?: Unit, - contentKey = active.configuration, - userSwipeEnabled = previous != null, - ) { isBackground: Boolean -> - val child = if (isBackground) previous else active - if (child != null) { - saveableStateHolder.SaveableStateProvider(child.configuration.toString()) { - WearDestinationUi(child.instance, component) - } - } - } - } -} - -@Composable -private fun WearDestinationUi(destination: WearRoot.Destination, root: WearRoot) { - when (destination) { - WearRoot.Destination.Onboarding -> OnboardingScreen( - onPair = root::showPairing, - onManualSignIn = root::showManualSignIn, - ) - - is WearRoot.Destination.PairingDestination -> PairingUi(destination.component) - is WearRoot.Destination.ManualSignInDestination -> ManualSignInUi(destination.component) - is WearRoot.Destination.ProjectsDestination -> WearProjectsUi(destination.component) - is WearRoot.Destination.SyncLogDestination -> SyncLogUi(destination.component) - } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/preview/WearScreens.Preview.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/preview/WearScreens.Preview.kt deleted file mode 100644 index acdfaa583..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/preview/WearScreens.Preview.kt +++ /dev/null @@ -1,434 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui.preview - -import androidx.compose.runtime.Composable -import androidx.wear.compose.material3.AppScaffold -import androidx.wear.compose.ui.tooling.preview.WearPreviewDevices -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogLevel -import com.darkrockstudios.apps.hammer.common.data.sync.projectsync.SyncLogMessage -import com.darkrockstudios.apps.hammer.wear.components.capture.Capture -import com.darkrockstudios.apps.hammer.wear.components.projects.WearProjects -import com.darkrockstudios.apps.hammer.wear.components.signin.ManualSignIn -import com.darkrockstudios.apps.hammer.wear.components.synclog.SyncLog -import com.darkrockstudios.apps.hammer.wear.pairing.PairingState -import com.darkrockstudios.apps.hammer.wear.ui.CaptureScreen -import com.darkrockstudios.apps.hammer.wear.ui.ManualSignInContent -import com.darkrockstudios.apps.hammer.wear.ui.OnboardingScreen -import com.darkrockstudios.apps.hammer.wear.ui.PairingScreen -import com.darkrockstudios.apps.hammer.wear.ui.SyncLogScreen -import com.darkrockstudios.apps.hammer.wear.ui.WearProjectsScreen -import com.darkrockstudios.apps.hammer.wear.ui.theme.HammerWearTheme -import kotlin.time.Instant - -@Composable -private fun WearPreviewFrame(content: @Composable () -> Unit) { - HammerWearTheme { - AppScaffold { content() } - } -} - -@WearPreviewDevices -@Composable -private fun OnboardingPreview() { - WearPreviewFrame { OnboardingScreen(onPair = {}, onManualSignIn = {}) } -} - -@WearPreviewDevices -@Composable -private fun PairingAwaitingPreview() { - WearPreviewFrame { - PairingScreen(state = PairingState.AwaitingConfirmation, onRetry = {}, onCancel = {}) - } -} - -@WearPreviewDevices -@Composable -private fun PairingDeclinedPreview() { - WearPreviewFrame { - PairingScreen(state = PairingState.Failed(PairErrorCode.Declined), onRetry = {}, onCancel = {}) - } -} - -@WearPreviewDevices -@Composable -private fun PairingPhoneNotFoundPreview() { - WearPreviewFrame { - PairingScreen(state = PairingState.PhoneNotFound, onRetry = {}, onCancel = {}) - } -} - -@WearPreviewDevices -@Composable -private fun ManualSignInEmptyPreview() { - WearPreviewFrame { - ManualSignInContent( - state = ManualSignIn.State(), - onEditServer = {}, - onEditEmail = {}, - onEditPassword = {}, - onSignIn = {}, - ) - } -} - -@WearPreviewDevices -@Composable -private fun ManualSignInInsecurePreview() { - WearPreviewFrame { - ManualSignInContent( - state = ManualSignIn.State( - server = "http://192.168.1.50:8080", - serverInsecure = true, - email = "writer@example.com", - hasPassword = true, - ), - onEditServer = {}, - onEditEmail = {}, - onEditPassword = {}, - onSignIn = {}, - ) - } -} - -@WearPreviewDevices -@Composable -private fun ManualSignInErrorPreview() { - WearPreviewFrame { - ManualSignInContent( - state = ManualSignIn.State( - server = "hammer.ink", - email = "writer@example.com", - hasPassword = true, - error = ManualSignIn.SignInError.Message("Invalid credentials"), - ), - onEditServer = {}, - onEditEmail = {}, - onEditPassword = {}, - onSignIn = {}, - ) - } -} - -@WearPreviewDevices -@Composable -private fun ManualSignInLocalNetworkDeniedPreview() { - WearPreviewFrame { - ManualSignInContent( - state = ManualSignIn.State( - server = "http://192.168.1.50:8080", - serverInsecure = true, - email = "writer@example.com", - hasPassword = true, - error = ManualSignIn.SignInError.LocalNetworkDenied, - ), - onEditServer = {}, - onEditEmail = {}, - onEditPassword = {}, - onSignIn = {}, - ) - } -} - -@WearPreviewDevices -@Composable -private fun ManualSignInBusyPreview() { - WearPreviewFrame { - ManualSignInContent( - state = ManualSignIn.State(server = "hammer.ink", email = "writer@example.com", hasPassword = true, busy = true), - onEditServer = {}, - onEditEmail = {}, - onEditPassword = {}, - onSignIn = {}, - ) - } -} - -private val previewRows = listOf( - WearProjects.ProjectRow(name = "The Lighthouse", canSubscribe = true, subscribed = true, outcome = ProjectSyncOutcome.Success), - WearProjects.ProjectRow(name = "Salt Roads", canSubscribe = true, subscribed = true, progress = 0.4f), - WearProjects.ProjectRow(name = "Short Stories", canSubscribe = true, subscribed = false), - WearProjects.ProjectRow(name = "New Draft", canSubscribe = false, subscribed = false), -) - -@Composable -private fun ProjectsPreview(state: WearProjects.State) { - WearPreviewFrame { - WearProjectsScreen( - state = state, - onAllowLocalNetwork = {}, - onNewNote = {}, - onNewIdea = {}, - onToggleSubscription = {}, - onSyncNow = {}, - onShowSyncLog = {}, - onSignOut = {}, - onConfirmSignOut = {}, - onCancelSignOut = {}, - onDismissNotice = {}, - ) - } -} - -@WearPreviewDevices -@Composable -private fun ProjectsSyncingPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows, - loaded = true, - syncing = true, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsNeedsReauthPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows.take(1).map { it.copy(outcome = ProjectSyncOutcome.Failed) }, - loaded = true, - needsReauth = true, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsEmptyPreview() { - ProjectsPreview(WearProjects.State(accountEmail = "writer@example.com", loaded = true)) -} - -@WearPreviewDevices -@Composable -private fun ProjectsUnsyncedKeptPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows.take(2).map { it.copy(unsubscribing = true) }, - loaded = true, - notice = WearProjects.Notice("Salt Roads", WearProjects.Notice.Reason.UnsyncedKept), - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsLocalNetworkBlockedPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - loaded = true, - localNetworkBlocked = true, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsUnsubscribeFailedPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows, - loaded = true, - notice = WearProjects.Notice("Salt Roads", WearProjects.Notice.Reason.Failed), - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsCheckingSignOutPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows, - loaded = true, - checkingSignOut = true, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsSignOutWarningPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows, - loaded = true, - signOutWarning = WearProjects.SignOutWarning(items = 3), - ) - ) -} - -@WearPreviewDevices -@Composable -private fun ProjectsSignOutWarningUnknownPreview() { - ProjectsPreview( - WearProjects.State( - accountEmail = "writer@example.com", - projects = previewRows, - loaded = true, - signOutWarning = WearProjects.SignOutWarning(items = 0), - ) - ) -} - -@Composable -private fun CapturePreview(state: Capture.State) { - WearPreviewFrame { - CaptureScreen( - state = state, - onEditText = {}, - onShowProjectPicker = {}, - onSelectProject = {}, - onDismissProjectPicker = {}, - onCancelDiscard = {}, - onDiscard = {}, - onSave = {}, - onDone = {}, - ) - } -} - -private val previewCaptureProjects = listOf("The Lighthouse", "Salt Roads") - -@WearPreviewDevices -@Composable -private fun CaptureNoteEmptyPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Note, - projects = previewCaptureProjects, - projectName = "The Lighthouse", - loading = false, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureNoteDictatedPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Note, - text = "The keeper never lights the lamp on the night his brother visits", - projects = previewCaptureProjects, - projectName = "The Lighthouse", - loading = false, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureIdeaPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Idea, - text = "A town where everyone shares one memory", - loading = false, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureProjectPickerPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Note, - text = "Salt on the stairs", - projects = previewCaptureProjects, - projectName = "The Lighthouse", - pickingProject = true, - loading = false, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureDiscardConfirmPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Note, - text = "The keeper never lights the lamp on the night his brother visits", - projects = previewCaptureProjects, - projectName = "The Lighthouse", - confirmingDiscard = true, - loading = false, - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureSavedPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Note, - text = "Salt on the stairs", - projectName = "The Lighthouse", - loading = false, - outcome = Capture.Outcome.Saved(pending = 3), - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureSavedUncountedPreview() { - CapturePreview( - Capture.State( - mode = Capture.Mode.Idea, - text = "A town where everyone shares one memory", - loading = false, - outcome = Capture.Outcome.Saved(), - ) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureNoProjectsPreview() { - CapturePreview( - Capture.State(mode = Capture.Mode.Note, loading = false, outcome = Capture.Outcome.NoProjects) - ) -} - -@WearPreviewDevices -@Composable -private fun CaptureFailedPreview() { - CapturePreview( - Capture.State(mode = Capture.Mode.Note, loading = false, outcome = Capture.Outcome.Failed) - ) -} - -@WearPreviewDevices -@Composable -private fun SyncLogPreview() { - val now = Instant.fromEpochSeconds(1_800_000_000) - WearPreviewFrame { - SyncLogScreen( - SyncLog.State( - entries = listOf( - SyncLogMessage("Sync failed: timeout", SyncLogLevel.ERROR, "Salt Roads", now), - SyncLogMessage("No changes, skipped", SyncLogLevel.INFO, "The Lighthouse", now), - SyncLogMessage("Syncing Account...", SyncLogLevel.INFO, null, now), - ) - ) - ) - } -} - -@WearPreviewDevices -@Composable -private fun SyncLogEmptyPreview() { - WearPreviewFrame { SyncLogScreen(SyncLog.State()) } -} diff --git a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/theme/HammerWearTheme.kt b/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/theme/HammerWearTheme.kt deleted file mode 100644 index aa5ce9e15..000000000 --- a/wear/src/main/kotlin/com/darkrockstudios/apps/hammer/wear/ui/theme/HammerWearTheme.kt +++ /dev/null @@ -1,9 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.ui.theme - -import androidx.compose.runtime.Composable -import androidx.wear.compose.material3.MaterialTheme - -@Composable -fun HammerWearTheme(content: @Composable () -> Unit) { - MaterialTheme(content = content) -} diff --git a/wear/src/main/res/drawable/ic_launcher_monochrome.xml b/wear/src/main/res/drawable/ic_launcher_monochrome.xml deleted file mode 100644 index d2d786cca..000000000 --- a/wear/src/main/res/drawable/ic_launcher_monochrome.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - diff --git a/wear/src/main/res/drawable/splash_screen.xml b/wear/src/main/res/drawable/splash_screen.xml deleted file mode 100644 index ac6f59463..000000000 --- a/wear/src/main/res/drawable/splash_screen.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - diff --git a/wear/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/wear/src/main/res/mipmap-anydpi-v26/ic_launcher.xml deleted file mode 100644 index 2a6635dca..000000000 --- a/wear/src/main/res/mipmap-anydpi-v26/ic_launcher.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/wear/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/wear/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml deleted file mode 100644 index 2a6635dca..000000000 --- a/wear/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/wear/src/main/res/mipmap-hdpi/ic_launcher.webp b/wear/src/main/res/mipmap-hdpi/ic_launcher.webp deleted file mode 100644 index 16f2781ce..000000000 Binary files a/wear/src/main/res/mipmap-hdpi/ic_launcher.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-hdpi/ic_launcher_foreground.webp b/wear/src/main/res/mipmap-hdpi/ic_launcher_foreground.webp deleted file mode 100644 index 88737f462..000000000 Binary files a/wear/src/main/res/mipmap-hdpi/ic_launcher_foreground.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-hdpi/ic_launcher_round.webp b/wear/src/main/res/mipmap-hdpi/ic_launcher_round.webp deleted file mode 100644 index baf455412..000000000 Binary files a/wear/src/main/res/mipmap-hdpi/ic_launcher_round.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-mdpi/ic_launcher.webp b/wear/src/main/res/mipmap-mdpi/ic_launcher.webp deleted file mode 100644 index 3bd7d3910..000000000 Binary files a/wear/src/main/res/mipmap-mdpi/ic_launcher.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-mdpi/ic_launcher_foreground.webp b/wear/src/main/res/mipmap-mdpi/ic_launcher_foreground.webp deleted file mode 100644 index 2272d6baa..000000000 Binary files a/wear/src/main/res/mipmap-mdpi/ic_launcher_foreground.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-mdpi/ic_launcher_round.webp b/wear/src/main/res/mipmap-mdpi/ic_launcher_round.webp deleted file mode 100644 index 166c48c07..000000000 Binary files a/wear/src/main/res/mipmap-mdpi/ic_launcher_round.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xhdpi/ic_launcher.webp b/wear/src/main/res/mipmap-xhdpi/ic_launcher.webp deleted file mode 100644 index 4eeeee766..000000000 Binary files a/wear/src/main/res/mipmap-xhdpi/ic_launcher.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xhdpi/ic_launcher_foreground.webp b/wear/src/main/res/mipmap-xhdpi/ic_launcher_foreground.webp deleted file mode 100644 index 3a2726a2f..000000000 Binary files a/wear/src/main/res/mipmap-xhdpi/ic_launcher_foreground.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xhdpi/ic_launcher_round.webp b/wear/src/main/res/mipmap-xhdpi/ic_launcher_round.webp deleted file mode 100644 index 4c1c3f7fc..000000000 Binary files a/wear/src/main/res/mipmap-xhdpi/ic_launcher_round.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxhdpi/ic_launcher.webp b/wear/src/main/res/mipmap-xxhdpi/ic_launcher.webp deleted file mode 100644 index ad7097c7c..000000000 Binary files a/wear/src/main/res/mipmap-xxhdpi/ic_launcher.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.webp b/wear/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.webp deleted file mode 100644 index 80e809550..000000000 Binary files a/wear/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp b/wear/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp deleted file mode 100644 index 64ae80f57..000000000 Binary files a/wear/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/wear/src/main/res/mipmap-xxxhdpi/ic_launcher.webp deleted file mode 100644 index 88d680a13..000000000 Binary files a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp b/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp deleted file mode 100644 index 5c59b79aa..000000000 Binary files a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp and /dev/null differ diff --git a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp deleted file mode 100644 index 955385c78..000000000 Binary files a/wear/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp and /dev/null differ diff --git a/wear/src/main/res/values/dimens.xml b/wear/src/main/res/values/dimens.xml deleted file mode 100644 index 928b1cb53..000000000 --- a/wear/src/main/res/values/dimens.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - 48dp - diff --git a/wear/src/main/res/values/ic_launcher_background.xml b/wear/src/main/res/values/ic_launcher_background.xml deleted file mode 100644 index 050bc7d25..000000000 --- a/wear/src/main/res/values/ic_launcher_background.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - #2A2F2D - \ No newline at end of file diff --git a/wear/src/main/res/values/strings_wear.xml b/wear/src/main/res/values/strings_wear.xml deleted file mode 100644 index e0085198b..000000000 --- a/wear/src/main/res/values/strings_wear.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - Hammer - - Capture notes and ideas on your wrist, synced with your Hammer account. - Pair with phone - Sign in on watch - - Looking for your phone - Confirm on your phone - Paired - No phone with Hammer is in range - Pairing failed - Pairing was declined on the phone - Sign in to a sync server on your phone first - The sync server refused to pair this watch - Update Hammer on your phone and watch, then try again - Open Hammer on your phone, then try again - Try again - Cancel - - Sign in - Server - Email - Password - Tap to enter - Plain HTTP: your sign in and writing are not encrypted. Only use this on a network you trust. - Sign in - Enter a server, email and password - Accept this server’s terms on your phone or computer first - Allow local network access to reach this server - Sign in failed - - Projects - %1$s - Sync to fetch your projects - Loading projects - Sync - New note - New story idea - Sync log - Sign out - Your server is on your local network. Allow Hammer to reach it to sync. - Allow - Your session expired. Sign out and sign in again. - The last sync did not finish - - %1$d captures have not synced yet. Signing out deletes them. - Some writing might not have synced yet. Signing out deletes it. - Sign out anyway - Keep my writing - %1$s still has writing that has not synced, so it was kept on the watch. Sync, then try again. - %1$s could not be removed from the watch. Try again. - Got it - - Not on the server yet - Removing from watch - Not on watch - On watch - Syncing %1$d%% - Synced - Resolve on phone - Sync failed - - New note - New story idea - Text - Tap to dictate - Project - Loading - No project on this watch - Cancel - Discard note? - Discard story idea? - This has not been saved yet. Leaving now loses it. - Discard - Keep writing - Save - Done - Saved - Counting what is left to sync - %1$d waiting to sync - Synced - No project yet - Turn on a project in Hammer to keep it on this watch, then you can add notes to it. - Not saved - Something went wrong. Try again. - - Capture - Note - Story idea - No project on watch - %1$d to sync - New note - Capture a note in Hammer - - Sync log - Nothing has synced yet - diff --git a/wear/src/main/res/values/themes.xml b/wear/src/main/res/values/themes.xml deleted file mode 100644 index 5fcf2532b..000000000 --- a/wear/src/main/res/values/themes.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/TestFakes.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/TestFakes.kt deleted file mode 100644 index bfc8c1c53..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/TestFakes.kt +++ /dev/null @@ -1,221 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.base.http.createJsonSerializer -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.isSuccess -import com.darkrockstudios.apps.hammer.common.data.projectmetadata.ProjectMetadataDatasource -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.common.dependencyinjection.createTomlSerializer -import com.darkrockstudios.apps.hammer.common.util.DeviceLocaleResolver -import com.darkrockstudios.apps.hammer.wear.data.CaptureWriter -import com.darkrockstudios.apps.hammer.wear.data.LocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.data.WearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.sync.CaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.sync.SyncCoordinator -import com.darkrockstudios.apps.hammer.wear.tile.CaptureSurfaceUpdater -import com.darkrockstudios.apps.hammer.wear.sync.SyncRunResult -import com.darkrockstudios.apps.hammer.wear.sync.SyncStatus -import com.darkrockstudios.apps.hammer.wear.sync.SyncTrigger -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.CompletableDeferred -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.flow.MutableStateFlow -import okio.IOException -import okio.Path.Companion.toPath -import okio.fakefilesystem.FakeFileSystem - -class FakeWearPrefsDatasource : WearPrefsDatasource { - private val ids = MutableStateFlow>(emptySet()) - private val lastCapture = MutableStateFlow(null) - - override val subscribedProjectIds: Flow> = ids - override val lastCaptureProjectId: Flow = lastCapture - - override suspend fun setSubscribed(projectId: String, subscribed: Boolean) { - ids.value = if (subscribed) ids.value + projectId else ids.value - projectId - } - - override suspend fun setLastCaptureProjectId(projectId: String) { - lastCapture.value = projectId - } - - override suspend fun clear() { - ids.value = emptySet() - lastCapture.value = null - } -} - -class FakeCaptureWriter : CaptureWriter { - val notes = mutableListOf>() - val ideas = mutableListOf() - var succeed = true - var failWith: Exception? = null - - override suspend fun writeNote(projectDef: ProjectDef, text: String): Boolean { - failWith?.let { throw it } - if (succeed) notes += projectDef.name to text - return succeed - } - - override suspend fun writeIdea(text: String): Boolean { - failWith?.let { throw it } - if (succeed) ideas += text - return succeed - } -} - -class FakeCaptureSyncScheduler : CaptureSyncScheduler { - var requests = 0 - - override fun syncSoon() { - requests++ - } -} - -class FakeCaptureSurfaceUpdater : CaptureSurfaceUpdater { - var refreshes = 0 - - override fun refresh() { - refreshes++ - } -} - -/** Blocks [pendingIn] until released, to model counting being slower than the save. */ -class GatedUnsyncedContentSource(private val gate: CompletableDeferred) : UnsyncedContentSource { - override suspend fun pendingIn(projectDef: ProjectDef): Int { - gate.await() - return 0 - } - - override suspend fun pendingIdeas(): Int { - gate.await() - return 0 - } -} - -/** Pending counts keyed by project name, so a test can say what has not reached the server. */ -class FakeUnsyncedContentSource : UnsyncedContentSource { - val pendingByProject = mutableMapOf() - var pendingIdeas = 0 - var failWith: Exception? = null - - /** Counts full sweeps, so a test can show a second one was never started. */ - var pendingCalls = 0 - - override suspend fun pendingIn(projectDef: ProjectDef): Int { - failWith?.let { throw it } - return pendingByProject[projectDef.name] ?: 0 - } - - override suspend fun pendingIdeas(): Int { - pendingCalls++ - failWith?.let { throw it } - return pendingIdeas - } -} - -/** Subscribing works; dropping a subscription does not, which is the unsubscribe failure path. */ -class FailingUnsubscribeDatasource : WearPrefsDatasource { - private val delegate = FakeWearPrefsDatasource() - - override val subscribedProjectIds: Flow> get() = delegate.subscribedProjectIds - override val lastCaptureProjectId: Flow get() = delegate.lastCaptureProjectId - - override suspend fun setSubscribed(projectId: String, subscribed: Boolean) { - if (!subscribed) throw IOException("the preference store is unwritable") - delegate.setSubscribed(projectId, subscribed) - } - - override suspend fun setLastCaptureProjectId(projectId: String) = - delegate.setLastCaptureProjectId(projectId) - - override suspend fun clear() = delegate.clear() -} - -class FakeSyncCoordinator : SyncCoordinator { - override val status = MutableStateFlow(SyncStatus()) - val requested = mutableListOf() - var autoSyncRequests = 0 - var autoSyncResets = 0 - - override fun requestSync(trigger: SyncTrigger) { - requested += trigger - } - - override fun requestAutoSync() { - autoSyncRequests++ - } - - /** Set to mimic a sync that uploads, so a test can clear what was pending. */ - var onSync: (suspend () -> Unit)? = null - - override suspend fun sync(trigger: SyncTrigger): SyncRunResult { - requested += trigger - onSync?.invoke() - return SyncRunResult.Skipped - } - - override suspend fun runExclusive(block: suspend () -> T): T = block() - - override fun resetAutoSync() { - autoSyncResets++ - } -} - -/** A real [ProjectsRepository] over a fake filesystem. Needs Koin started for its dispatcher. */ -class TestProjects { - val fileSystem = FakeFileSystem().apply { createDirectories("/projects".toPath()) } - private val toml = createTomlSerializer() - val metadataDatasource = ProjectMetadataDatasource(fileSystem, toml) - val repository: ProjectsRepository - - init { - val globalSettingsStore = mockk() - every { globalSettingsStore.globalSettings } returns GlobalSettings(projectsDirectory = "/projects") - every { globalSettingsStore.globalSettingsUpdates } returns MutableSharedFlow() - repository = ProjectsRepository( - fileSystem = fileSystem, - globalSettingsStore = globalSettingsStore, - projectsMetadataDatasource = metadataDatasource, - toml = toml, - json = createJsonSerializer(), - deviceLocaleResolver = mockk(relaxed = true), - ) - } - - fun create(name: String, serverId: String? = null): ProjectDef { - val result = repository.createProject(name, seedDefaultLanguage = false) - if (!isSuccess(result)) error("Failed to create $name") - val projectDef = result.data - if (serverId != null) { - metadataDatasource.updateMetadata(projectDef) { - it.copy(info = it.info.copy(serverProjectId = ProjectId(serverId))) - } - } - return projectDef - } -} - -/** Blocks the addresses in [blocked] until [grant] is called, like an ungranted Android 17 app. */ -class FakeLocalNetworkAccess(private val blocked: MutableSet = mutableSetOf()) : LocalNetworkAccess { - val checked = mutableListOf() - - fun block(address: String) { - blocked += address - } - - fun grant() { - blocked.clear() - } - - override suspend fun isBlocked(serverAddress: String): Boolean { - checked += serverAddress - return serverAddress in blocked - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/WearTestBase.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/WearTestBase.kt deleted file mode 100644 index 37419899c..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/WearTestBase.kt +++ /dev/null @@ -1,69 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear - -import com.arkivanov.decompose.DefaultComponentContext -import com.arkivanov.essenty.lifecycle.Lifecycle -import com.arkivanov.essenty.lifecycle.LifecycleRegistry -import com.arkivanov.essenty.lifecycle.destroy -import com.arkivanov.essenty.lifecycle.resume -import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_DEFAULT -import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_IO -import com.darkrockstudios.apps.hammer.common.dependencyinjection.DISPATCHER_MAIN -import com.darkrockstudios.apps.hammer.common.util.StrRes -import kotlinx.coroutines.Dispatchers -import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.test.StandardTestDispatcher -import kotlinx.coroutines.test.TestCoroutineScheduler -import kotlinx.coroutines.test.resetMain -import kotlinx.coroutines.test.setMain -import org.jetbrains.compose.resources.StringResource -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.BeforeEach -import org.koin.core.context.startKoin -import org.koin.core.context.stopKoin -import org.koin.core.qualifier.named -import org.koin.dsl.module -import kotlin.coroutines.CoroutineContext - -/** - * Starts Koin with the dispatchers every [com.darkrockstudios.apps.hammer.common.components.ComponentBase] - * injects, all driven by one scheduler, and provides a real Decompose context to build components on. - */ -@OptIn(ExperimentalCoroutinesApi::class) -abstract class WearTestBase { - - protected val scheduler = TestCoroutineScheduler() - protected val dispatcher = StandardTestDispatcher(scheduler) - - protected lateinit var lifecycle: LifecycleRegistry - protected lateinit var componentContext: DefaultComponentContext - - @BeforeEach - open fun setUp() { - Dispatchers.setMain(dispatcher) - startKoin { - modules( - module { - single(named(DISPATCHER_MAIN)) { dispatcher } - single(named(DISPATCHER_DEFAULT)) { dispatcher } - single(named(DISPATCHER_IO)) { dispatcher } - } - ) - } - lifecycle = LifecycleRegistry() - componentContext = DefaultComponentContext(lifecycle = lifecycle) - } - - @AfterEach - open fun tearDown() { - if (lifecycle.state != Lifecycle.State.DESTROYED) lifecycle.destroy() - stopKoin() - Dispatchers.resetMain() - } - - protected fun resumeLifecycle() = lifecycle.resume() -} - -class FakeStrRes : StrRes { - override suspend fun get(str: StringResource) = "text" - override suspend fun get(str: StringResource, vararg args: Any) = "text" -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponentTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponentTest.kt deleted file mode 100644 index 5523a6e33..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/WearRootComponentTest.kt +++ /dev/null @@ -1,217 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components - -import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import com.darkrockstudios.apps.hammer.wear.FakeLocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.FakeStrRes -import com.darkrockstudios.apps.hammer.wear.FakeSyncCoordinator -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import com.darkrockstudios.apps.hammer.wear.pairing.PairingState -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingClient -import com.darkrockstudios.apps.hammer.wear.pairing.PhonePairingUseCase -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.flow.MutableSharedFlow -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertInstanceOf -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class WearRootComponentTest : WearTestBase() { - - private val signedIn = ServerSettings( - url = "hammer.ink", - email = "writer@example.com", - userId = 7, - bearerToken = "auth", - refreshToken = "refresh", - ) - - private val sentRequests = mutableListOf() - private lateinit var settingsUpdates: MutableSharedFlow - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var phonePairing: PhonePairingUseCase - - @BeforeEach - override fun setUp() { - super.setUp() - settingsUpdates = MutableSharedFlow(extraBufferCapacity = 1) - globalSettingsStore = mockk(relaxed = true) - every { globalSettingsStore.serverSettingsUpdates } returns settingsUpdates - every { globalSettingsStore.serverSettings } returns null - coEvery { globalSettingsStore.ensureInstallId() } returns "watch-install" - - val client = object : PhonePairingClient { - override suspend fun findPhone(): String = "phone-node" - override suspend fun sendRequest(nodeId: String, request: PairRequest) { - sentRequests += request - } - } - val accountUseCase = mockk(relaxed = true) - every { accountUseCase.applyPairedSettings(any()) } returns CResult.success() - phonePairing = PhonePairingUseCase(client, globalSettingsStore, accountUseCase) - } - - private fun newRoot(): WearRootComponent { - val subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - val projects = TestProjects() - return WearRootComponent( - componentContext = componentContext, - globalSettingsStore = globalSettingsStore, - phonePairing = phonePairing, - accountUseCase = mockk(relaxed = true), - listProjects = ListWatchProjectsUseCase(projects.repository, subscriptions), - projectsRepository = projects.repository, - subscriptions = subscriptions, - unsyncedContent = UnsyncedContentUseCase( - ListWatchProjectsUseCase(projects.repository, subscriptions), - FakeUnsyncedContentSource(), - ), - syncCoordinator = FakeSyncCoordinator(), - signOutUseCase = mockk(relaxed = true), - localNetworkAccess = FakeLocalNetworkAccess(), - appScope = CoroutineScope(dispatcher), - strRes = FakeStrRes(), - deviceLabel = "Pixel Watch", - ) - } - - @Test - fun `a signed out watch starts on onboarding`() = runTest(dispatcher) { - val root = newRoot() - - assertEquals(WearRoot.Destination.Onboarding, root.stack.value.active.instance) - } - - @Test - fun `a signed in watch starts on its projects`() = runTest(dispatcher) { - every { globalSettingsStore.serverSettings } returns signedIn - - val root = newRoot() - - assertInstanceOf(WearRoot.Destination.ProjectsDestination::class.java, root.stack.value.active.instance) - } - - @Test - fun `opening pairing asks the phone straight away`() = runTest(dispatcher) { - val root = newRoot() - resumeLifecycle() - - root.showPairing() - scheduler.advanceUntilIdle() - - assertInstanceOf(WearRoot.Destination.PairingDestination::class.java, root.stack.value.active.instance) - assertEquals(1, sentRequests.size) - assertEquals(PairingState.AwaitingConfirmation, phonePairing.state.value) - } - - @Test - fun `signing in from pairing lands on projects with nothing to go back to`() = runTest(dispatcher) { - val root = newRoot() - resumeLifecycle() - root.showPairing() - scheduler.advanceUntilIdle() - - settingsUpdates.emit(signedIn) - scheduler.advanceUntilIdle() - - assertInstanceOf(WearRoot.Destination.ProjectsDestination::class.java, root.stack.value.active.instance) - assertEquals(0, root.stack.value.backStack.size) - } - - @Test - fun `signing out returns to onboarding`() = runTest(dispatcher) { - every { globalSettingsStore.serverSettings } returns signedIn - val root = newRoot() - resumeLifecycle() - scheduler.advanceUntilIdle() - - settingsUpdates.emit(null) - scheduler.advanceUntilIdle() - - assertEquals(WearRoot.Destination.Onboarding, root.stack.value.active.instance) - } - - @Test - fun `signing out from the sync log also returns to onboarding`() = runTest(dispatcher) { - every { globalSettingsStore.serverSettings } returns signedIn - val root = newRoot() - resumeLifecycle() - scheduler.advanceUntilIdle() - val projects = root.stack.value.active.instance as WearRoot.Destination.ProjectsDestination - projects.component.showSyncLog() - scheduler.advanceUntilIdle() - assertInstanceOf(WearRoot.Destination.SyncLogDestination::class.java, root.stack.value.active.instance) - - settingsUpdates.emit(null) - scheduler.advanceUntilIdle() - - assertEquals(WearRoot.Destination.Onboarding, root.stack.value.active.instance) - assertEquals(0, root.stack.value.backStack.size) - } - - @Test - fun `leaving pairing keeps the request pending so a late reply still lands`() = runTest(dispatcher) { - val root = newRoot() - resumeLifecycle() - root.showPairing() - scheduler.advanceUntilIdle() - - root.onBack() - scheduler.advanceUntilIdle() - - assertEquals(WearRoot.Destination.Onboarding, root.stack.value.active.instance) - // The phone may still be showing its prompt. Abandoning here strands the session the server - // mints when the user approves it, leaving the watch signed out with no way to recover it. - assertEquals(PairingState.AwaitingConfirmation, phonePairing.state.value) - } - - @Test - fun `cancelling pairing abandons the pending request`() = runTest(dispatcher) { - val root = newRoot() - resumeLifecycle() - root.showPairing() - scheduler.advanceUntilIdle() - - val pairing = root.stack.value.active.instance as WearRoot.Destination.PairingDestination - pairing.component.cancel() - scheduler.advanceUntilIdle() - - assertEquals(WearRoot.Destination.Onboarding, root.stack.value.active.instance) - assertEquals(PairingState.Idle, phonePairing.state.value) - } - - @Test - fun `pairing again after signing out asks the phone afresh`() = runTest(dispatcher) { - val root = newRoot() - resumeLifecycle() - root.showPairing() - scheduler.advanceUntilIdle() - val firstRequest = sentRequests.single() - phonePairing.onResponse(PairingProtocol.encodeResponse(PairResponse.Success(firstRequest.requestId, signedIn))) - settingsUpdates.emit(signedIn) - scheduler.advanceUntilIdle() - settingsUpdates.emit(null) - scheduler.advanceUntilIdle() - - root.showPairing() - scheduler.advanceUntilIdle() - - assertEquals(2, sentRequests.size) - assertEquals(PairingState.AwaitingConfirmation, phonePairing.state.value) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponentTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponentTest.kt deleted file mode 100644 index 568852dec..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/capture/CaptureComponentTest.kt +++ /dev/null @@ -1,339 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.capture - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeCaptureSurfaceUpdater -import com.darkrockstudios.apps.hammer.wear.FakeCaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.FakeCaptureWriter -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.GatedUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import com.darkrockstudios.apps.hammer.wear.data.CaptureTargetsUseCase -import com.darkrockstudios.apps.hammer.wear.data.CaptureUseCase -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import kotlinx.coroutines.CompletableDeferred -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class CaptureComponentTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var writer: FakeCaptureWriter - private lateinit var unsynced: FakeUnsyncedContentSource - private lateinit var captureSync: FakeCaptureSyncScheduler - private lateinit var surfaces: FakeCaptureSurfaceUpdater - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - writer = FakeCaptureWriter() - unsynced = FakeUnsyncedContentSource() - captureSync = FakeCaptureSyncScheduler() - surfaces = FakeCaptureSurfaceUpdater() - } - - private fun newComponent(mode: Capture.Mode, startWithPicker: Boolean = false): CaptureComponent { - val listProjects = ListWatchProjectsUseCase(projects.repository, subscriptions) - return CaptureComponent( - componentContext = componentContext, - mode = mode, - startWithPicker = startWithPicker, - captureTargets = CaptureTargetsUseCase(listProjects, subscriptions), - subscriptions = subscriptions, - captureUseCase = CaptureUseCase( - writer = writer, - unsyncedContent = UnsyncedContentUseCase(listProjects, unsynced), - captureSync = captureSync, - surfaces = surfaces, - ), - appScope = CoroutineScope(dispatcher), - ).also { - resumeLifecycle() - scheduler.advanceUntilIdle() - } - } - - @Test - fun `a note defaults to the project last captured to`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - subscriptions.setLastCaptureProject(ProjectId("b")) - - val component = newComponent(Capture.Mode.Note) - - assertEquals("Beta", component.state.value.projectName) - assertEquals(listOf("Alpha", "Beta"), component.state.value.projects) - } - - @Test - fun `a first capture falls back to the first project on the watch`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - - val component = newComponent(Capture.Mode.Note) - - assertEquals("Alpha", component.state.value.projectName) - } - - @Test - fun `projects that are not kept on the watch are not capture targets`() = runTest(dispatcher) { - // A note in an unsynced project would take id 1 and collide on every later sync. - projects.create("Alpha", serverId = "a") - - val component = newComponent(Capture.Mode.Note) - - assertEquals(emptyList(), component.state.value.projects) - assertEquals(Capture.Outcome.NoProjects, component.state.value.outcome) - } - - @Test - fun `an idea needs no project to be saveable`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - - component.onTextEntered("a town where everyone shares one memory") - - assertFalse(component.state.value.loading) - assertNull(component.state.value.projectName) - assertTrue(component.state.value.canSave) - } - - @Test - fun `a note cannot be saved before its text arrives`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - - val component = newComponent(Capture.Mode.Note) - - assertFalse(component.state.value.canSave) - - component.onTextEntered("salt on the stairs") - - assertTrue(component.state.value.canSave) - } - - @Test - fun `saving a note writes it and reports what is waiting to sync`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 4 - val component = newComponent(Capture.Mode.Note) - component.onTextEntered("salt on the stairs") - - component.save() - scheduler.advanceUntilIdle() - - assertEquals(listOf("Alpha" to "salt on the stairs"), writer.notes) - assertEquals(Capture.Outcome.Saved(pending = 4), component.state.value.outcome) - assertFalse(component.state.value.saving) - assertEquals(1, captureSync.requests) - } - - @Test - fun `saving an idea writes it`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a town with one memory") - - component.save() - scheduler.advanceUntilIdle() - - assertEquals(listOf("a town with one memory"), writer.ideas) - assertEquals(Capture.Outcome.Saved(pending = 0), component.state.value.outcome) - } - - @Test - fun `a write that fails is reported rather than looking saved`() = runTest(dispatcher) { - writer.succeed = false - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a thought") - - component.save() - scheduler.advanceUntilIdle() - - assertEquals(Capture.Outcome.Failed, component.state.value.outcome) - } - - @Test - fun `choosing a project remembers it for the next capture`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - val component = newComponent(Capture.Mode.Note) - - component.showProjectPicker() - assertTrue(component.state.value.pickingProject) - - component.selectProject("Beta") - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.pickingProject) - assertEquals("Beta", component.state.value.projectName) - assertEquals(ProjectId("b"), subscriptions.lastCaptureProjectId()) - } - - @Test - fun `the save is confirmed before the count is gathered`() = runTest(dispatcher) { - val gate = CompletableDeferred() - val listProjects = ListWatchProjectsUseCase(projects.repository, subscriptions) - val component = CaptureComponent( - componentContext = componentContext, - mode = Capture.Mode.Idea, - captureTargets = CaptureTargetsUseCase(listProjects, subscriptions), - subscriptions = subscriptions, - captureUseCase = CaptureUseCase( - writer = writer, - unsyncedContent = UnsyncedContentUseCase(listProjects, GatedUnsyncedContentSource(gate)), - captureSync = captureSync, - surfaces = surfaces, - ), - appScope = CoroutineScope(dispatcher), - ).also { - resumeLifecycle() - scheduler.advanceUntilIdle() - } - component.onTextEntered("a thought worth keeping") - - component.save() - scheduler.advanceUntilIdle() - - // Counting is still blocked, but the user has already been told their words are safe. - assertEquals(listOf("a thought worth keeping"), writer.ideas) - assertEquals(Capture.Outcome.Saved(pending = null), component.state.value.outcome) - - gate.complete(Unit) - scheduler.advanceUntilIdle() - - assertEquals(Capture.Outcome.Saved(pending = 0), component.state.value.outcome) - } - - @Test - fun `a count that cannot be read leaves the save confirmed`() = runTest(dispatcher) { - unsynced.failWith = IllegalStateException("no journal") - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a thought worth keeping") - - component.save() - scheduler.advanceUntilIdle() - - assertEquals(Capture.Outcome.Saved(pending = null), component.state.value.outcome) - } - - @Test - fun `leaving the project picker keeps the current project`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - val component = newComponent(Capture.Mode.Note) - component.showProjectPicker() - - component.dismissProjectPicker() - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.pickingProject) - assertEquals("Alpha", component.state.value.projectName) - assertNull(subscriptions.lastCaptureProjectId()) - } - - @Test - fun `leaving with dictated text asks before dropping it`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a town where everyone shares one memory") - - assertTrue(component.state.value.hasUnsavedWork) - component.requestDiscard() - - assertTrue(component.state.value.confirmingDiscard) - - component.cancelDiscard() - - assertFalse(component.state.value.confirmingDiscard) - assertEquals("a town where everyone shares one memory", component.state.value.text) - } - - @Test - fun `leaving with nothing dictated has nothing to ask about`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - - assertFalse(component.state.value.hasUnsavedWork) - component.requestDiscard() - - assertFalse(component.state.value.confirmingDiscard) - } - - @Test - fun `a saved capture is not unsaved work`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a thought worth keeping") - component.save() - scheduler.advanceUntilIdle() - - // The words are on disk, so the swipe out should just leave. - assertFalse(component.state.value.hasUnsavedWork) - component.requestDiscard() - - assertFalse(component.state.value.confirmingDiscard) - } - - @Test - fun `saving clears a confirmation left open behind it`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a thought worth keeping") - component.requestDiscard() - - component.save() - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.confirmingDiscard) - assertEquals(Capture.Outcome.Saved(pending = 0), component.state.value.outcome) - } - - @Test - fun `the tile can send you straight to the project picker`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - - val component = newComponent(Capture.Mode.Note, startWithPicker = true) - - assertTrue(component.state.value.pickingProject) - } - - @Test - fun `there is no picker to show when only one project is on the watch`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - - val component = newComponent(Capture.Mode.Note, startWithPicker = true) - - assertFalse(component.state.value.pickingProject) - assertEquals("Alpha", component.state.value.projectName) - } - - @Test - fun `saving twice does not write the capture twice`() = runTest(dispatcher) { - val component = newComponent(Capture.Mode.Idea) - component.onTextEntered("a thought worth keeping") - - component.save() - component.save() - scheduler.advanceUntilIdle() - - assertEquals(1, writer.ideas.size) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponentTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponentTest.kt deleted file mode 100644 index 1a9c8ab42..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/projects/WearProjectsComponentTest.kt +++ /dev/null @@ -1,461 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.projects - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.fileio.okio.toOkioPath -import com.darkrockstudios.apps.hammer.wear.FakeLocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.FakeSyncCoordinator -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FailingUnsubscribeDatasource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import com.darkrockstudios.apps.hammer.wear.data.ListWatchProjectsUseCase -import com.darkrockstudios.apps.hammer.wear.data.SignOutUseCase -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import com.darkrockstudios.apps.hammer.wear.data.UnsyncedContentUseCase -import com.darkrockstudios.apps.hammer.wear.sync.ProjectSyncState -import com.darkrockstudios.apps.hammer.wear.sync.SyncStatus -import com.darkrockstudios.apps.hammer.wear.sync.SyncTrigger -import io.mockk.coVerify -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class WearProjectsComponentTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var coordinator: FakeSyncCoordinator - private lateinit var unsynced: FakeUnsyncedContentSource - private lateinit var signOutUseCase: SignOutUseCase - private lateinit var localNetwork: FakeLocalNetworkAccess - private var syncLogShown = false - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - coordinator = FakeSyncCoordinator() - unsynced = FakeUnsyncedContentSource() - signOutUseCase = mockk(relaxed = true) - localNetwork = FakeLocalNetworkAccess() - syncLogShown = false - } - - private fun newComponent( - advanceToIdle: Boolean = true, - serverUrl: String = "hammer.ink", - ): WearProjectsComponent { - val globalSettingsStore = mockk() - every { globalSettingsStore.serverSettings } returns ServerSettings( - url = serverUrl, - email = "writer@example.com", - userId = 7, - bearerToken = "auth", - refreshToken = "refresh", - ) - val listProjects = ListWatchProjectsUseCase(projects.repository, subscriptions) - return WearProjectsComponent( - componentContext = componentContext, - globalSettingsStore = globalSettingsStore, - listProjects = listProjects, - projectsRepository = projects.repository, - subscriptions = subscriptions, - unsyncedContent = UnsyncedContentUseCase(listProjects, unsynced), - syncCoordinator = coordinator, - signOutUseCase = signOutUseCase, - localNetworkAccess = localNetwork, - appScope = CoroutineScope(dispatcher), - onShowSyncLog = { syncLogShown = true }, - ).also { - resumeLifecycle() - if (advanceToIdle) scheduler.advanceUntilIdle() - } - } - - private fun WearProjectsComponent.row(name: String) = state.value.projects.single { it.name == name } - - @Test - fun `opening the screen lists projects and asks for the app-open sync`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Draft") - - val component = newComponent() - - assertEquals(listOf("Alpha", "Draft"), component.state.value.projects.map { it.name }) - assertTrue(component.row("Alpha").canSubscribe) - assertFalse(component.row("Draft").canSubscribe) - assertEquals("writer@example.com", component.state.value.accountEmail) - assertEquals(1, coordinator.autoSyncRequests) - } - - @Test - fun `a local server the watch may not reach yet holds the first sync back`() = runTest(dispatcher) { - localNetwork.block("192.168.1.46:8081") - - val component = newComponent(serverUrl = "192.168.1.46:8081") - - // Pairing lands here and would sync at once; that sync would only time out. - assertTrue(component.state.value.localNetworkBlocked) - assertEquals(0, coordinator.autoSyncRequests) - } - - @Test - fun `granting local network access releases the sync`() = runTest(dispatcher) { - localNetwork.block("192.168.1.46:8081") - val component = newComponent(serverUrl = "192.168.1.46:8081") - - localNetwork.grant() - component.onLocalNetworkPermissionResult() - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.localNetworkBlocked) - assertEquals(1, coordinator.autoSyncRequests) - } - - @Test - fun `a refusal keeps the sync held and the explanation showing`() = runTest(dispatcher) { - localNetwork.block("192.168.1.46:8081") - val component = newComponent(serverUrl = "192.168.1.46:8081") - - component.onLocalNetworkPermissionResult() - scheduler.advanceUntilIdle() - - assertTrue(component.state.value.localNetworkBlocked) - assertEquals(0, coordinator.autoSyncRequests) - } - - @Test - fun `a public server is never held back`() = runTest(dispatcher) { - val component = newComponent(serverUrl = "hammer.ink") - - assertFalse(component.state.value.localNetworkBlocked) - assertEquals(listOf("hammer.ink"), localNetwork.checked) - assertEquals(1, coordinator.autoSyncRequests) - } - - @Test - fun `subscribing to a project keeps it on the watch and syncs it`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - assertTrue(component.row("Alpha").subscribed) - assertEquals(setOf(ProjectId("a")), subscriptions.currentSubscriptions()) - assertEquals(listOf(SyncTrigger.Manual), coordinator.requested) - } - - @Test - fun `unsubscribing drops the content but leaves the project listed`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = "a") - val sceneDir = projectDef.path.toOkioPath() / "scenes" - projects.fileSystem.createDirectories(sceneDir) - projects.fileSystem.write(sceneDir / "1.md") { writeUtf8("a scene synced to the watch") } - subscriptions.setSubscribed(ProjectId("a"), true) - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - assertFalse(projects.fileSystem.exists(sceneDir)) - // The row has to survive, or the project cannot be subscribed to again without a sync first. - assertFalse(component.row("Alpha").subscribed) - assertTrue(component.row("Alpha").canSubscribe) - assertEquals(emptySet(), subscriptions.currentSubscriptions()) - assertEquals(emptyList(), coordinator.requested) - } - - @Test - fun `the list is not reported as empty until it has loaded`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - - val component = newComponent(advanceToIdle = false) - - assertFalse(component.state.value.loaded) - - scheduler.advanceUntilIdle() - - assertTrue(component.state.value.loaded) - assertEquals(listOf("Alpha"), component.state.value.projects.map { it.name }) - } - - @Test - fun `a project the server does not know yet cannot be subscribed`() = runTest(dispatcher) { - projects.create("Draft") - val component = newComponent() - - component.toggleSubscription("Draft") - scheduler.advanceUntilIdle() - - assertFalse(component.row("Draft").subscribed) - assertEquals(emptySet(), subscriptions.currentSubscriptions()) - } - - @Test - fun `sync progress shows on the project row`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - val component = newComponent() - - coordinator.status.value = SyncStatus(running = true, projects = mapOf("Alpha" to ProjectSyncState(progress = 0.25f))) - scheduler.advanceUntilIdle() - - assertTrue(component.state.value.syncing) - assertEquals(0.25f, component.row("Alpha").progress) - } - - @Test - fun `a project that is not on the watch does not report a sync it never attempted`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - val component = newComponent() - - // A failed account sync marks every project failed, including ones it filtered out. - coordinator.status.value = SyncStatus( - projects = mapOf( - "Alpha" to ProjectSyncState(outcome = ProjectSyncOutcome.Failed), - "Beta" to ProjectSyncState(outcome = ProjectSyncOutcome.Failed), - ), - ) - scheduler.advanceUntilIdle() - - assertEquals(ProjectSyncOutcome.Failed, component.row("Alpha").outcome) - assertNull(component.row("Beta").outcome) - } - - @Test - fun `projects that arrive during a sync appear once it finishes`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - val component = newComponent() - coordinator.status.value = SyncStatus(running = true) - scheduler.advanceUntilIdle() - - projects.create("Beta", serverId = "b") - coordinator.status.value = SyncStatus( - running = false, - projects = mapOf("Beta" to ProjectSyncState(outcome = ProjectSyncOutcome.Skipped)), - ) - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.syncing) - assertEquals(listOf("Alpha", "Beta"), component.state.value.projects.map { it.name }) - } - - @Test - fun `sync now and the sync log reach their destinations`() = runTest(dispatcher) { - val component = newComponent() - - component.syncNow() - component.showSyncLog() - - assertEquals(listOf(SyncTrigger.Manual), coordinator.requested) - assertTrue(syncLogShown) - } - - @Test - fun `unsubscribing uploads first when the project has writing the server has not seen`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = "a") - val sceneDir = projectDef.path.toOkioPath() / "scenes" - projects.fileSystem.createDirectories(sceneDir) - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 2 - coordinator.onSync = { unsynced.pendingByProject["Alpha"] = 0 } - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - assertEquals(listOf(SyncTrigger.Manual), coordinator.requested) - assertFalse(projects.fileSystem.exists(sceneDir)) - assertEquals(emptySet(), subscriptions.currentSubscriptions()) - assertNull(component.state.value.notice) - } - - @Test - fun `unsubscribing keeps content and the subscription while writing is still unsynced`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = "a") - val sceneDir = projectDef.path.toOkioPath() / "scenes" - projects.fileSystem.createDirectories(sceneDir) - projects.fileSystem.write(sceneDir / "1.md") { writeUtf8("a note dictated on a run") } - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 1 - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - assertTrue(projects.fileSystem.exists(sceneDir / "1.md")) - // Unsubscribing here would filter the project out of every later sync, stranding the note. - assertEquals(setOf(ProjectId("a")), subscriptions.currentSubscriptions()) - assertTrue(component.row("Alpha").subscribed) - assertEquals( - WearProjects.Notice("Alpha", WearProjects.Notice.Reason.UnsyncedKept), - component.state.value.notice, - ) - assertFalse(component.row("Alpha").unsubscribing) - } - - @Test - fun `a count that cannot be read never authorises a delete`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = "a") - val sceneDir = projectDef.path.toOkioPath() / "scenes" - projects.fileSystem.createDirectories(sceneDir) - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.failWith = IllegalStateException("no project scope") - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - assertTrue(projects.fileSystem.exists(sceneDir)) - assertEquals(setOf(ProjectId("a")), subscriptions.currentSubscriptions()) - assertEquals( - WearProjects.Notice("Alpha", WearProjects.Notice.Reason.UnsyncedKept), - component.state.value.notice, - ) - } - - @Test - fun `an unsubscribe that breaks is not reported as unsynced writing`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - // Nothing is pending, so the only thing left that can go wrong is the unsubscribe itself. - subscriptions = SubscribedProjectsRepository(FailingUnsubscribeDatasource()) - subscriptions.setSubscribed(ProjectId("a"), true) - val component = newComponent() - - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - // Telling the user to sync and retry would be advice that cannot possibly help. - assertEquals( - WearProjects.Notice("Alpha", WearProjects.Notice.Reason.Failed), - component.state.value.notice, - ) - } - - @Test - fun `dismissing the notice clears it`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 1 - val component = newComponent() - component.toggleSubscription("Alpha") - scheduler.advanceUntilIdle() - - component.dismissNotice() - - assertNull(component.state.value.notice) - } - - @Test - fun `signing out with nothing outstanding does not stop to ask`() = runTest(dispatcher) { - val component = newComponent() - - component.signOut() - scheduler.advanceUntilIdle() - - assertNull(component.state.value.signOutWarning) - coVerify(exactly = 1) { signOutUseCase.signOut() } - } - - @Test - fun `signing out warns before wiping captures that have not synced`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 2 - unsynced.pendingIdeas = 1 - val component = newComponent() - - component.signOut() - scheduler.advanceUntilIdle() - - assertEquals(WearProjects.SignOutWarning(items = 3), component.state.value.signOutWarning) - coVerify(exactly = 0) { signOutUseCase.signOut() } - } - - @Test - fun `an uncountable state still warns rather than wiping silently`() = runTest(dispatcher) { - val component = newComponent() - unsynced.failWith = IllegalStateException("no project scope") - - component.signOut() - scheduler.advanceUntilIdle() - - assertEquals(WearProjects.SignOutWarning(items = 0), component.state.value.signOutWarning) - coVerify(exactly = 0) { signOutUseCase.signOut() } - } - - @Test - fun `confirming the warning signs out`() = runTest(dispatcher) { - unsynced.pendingIdeas = 1 - val component = newComponent() - component.signOut() - scheduler.advanceUntilIdle() - - component.confirmSignOut() - scheduler.advanceUntilIdle() - - assertNull(component.state.value.signOutWarning) - coVerify(exactly = 1) { signOutUseCase.signOut() } - } - - @Test - fun `the sign out button reports that it is counting`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 1 - val component = newComponent() - - component.signOut() - - // Counting opens every subscribed project, so a dead-looking button is a real hazard. - assertTrue(component.state.value.checkingSignOut) - - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.checkingSignOut) - } - - @Test - fun `tapping sign out twice only counts once`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - unsynced.pendingByProject["Alpha"] = 1 - val component = newComponent() - - component.signOut() - component.signOut() - scheduler.advanceUntilIdle() - - assertEquals(WearProjects.SignOutWarning(items = 1), component.state.value.signOutWarning) - assertEquals(1, unsynced.pendingCalls) - } - - @Test - fun `cancelling the warning keeps the account`() = runTest(dispatcher) { - unsynced.pendingIdeas = 1 - val component = newComponent() - component.signOut() - scheduler.advanceUntilIdle() - - component.cancelSignOut() - scheduler.advanceUntilIdle() - - assertNull(component.state.value.signOutWarning) - coVerify(exactly = 0) { signOutUseCase.signOut() } - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponentTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponentTest.kt deleted file mode 100644 index fd7fcd917..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/components/signin/ManualSignInComponentTest.kt +++ /dev/null @@ -1,215 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.components.signin - -import com.darkrockstudios.apps.hammer.base.http.TermsOfServiceChallenge -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.account.ServerSetupResult -import com.darkrockstudios.apps.hammer.common.data.toMsg -import com.darkrockstudios.apps.hammer.wear.FakeLocalNetworkAccess -import com.darkrockstudios.apps.hammer.wear.FakeStrRes -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import io.mockk.coEvery -import io.mockk.coVerify -import io.mockk.mockk -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class ManualSignInComponentTest : WearTestBase() { - - private lateinit var accountUseCase: AccountUseCase - private lateinit var localNetwork: FakeLocalNetworkAccess - - @BeforeEach - override fun setUp() { - super.setUp() - accountUseCase = mockk() - localNetwork = FakeLocalNetworkAccess() - } - - private fun newComponent() = ManualSignInComponent( - componentContext = componentContext, - accountUseCase = accountUseCase, - localNetworkAccess = localNetwork, - strRes = FakeStrRes(), - ).also { resumeLifecycle() } - - private fun ManualSignInComponent.fillIn() { - updateServer(" hammer.ink ") - updateEmail("writer@example.com") - updatePassword("hunter2") - } - - @Test - fun `the watch keyboard's capitals are folded away`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns ServerSetupResult.Success - val component = newComponent() - // What the Wear RemoteInput keyboard hands back when it capitalises the first letter. - component.updateServer("Hammer.ink") - component.updateEmail("Writer@example.com") - component.updatePassword("hunter2") - - assertEquals("hammer.ink", component.state.value.server) - assertEquals("writer@example.com", component.state.value.email) - - component.signIn() - scheduler.advanceUntilIdle() - - // The password is passed through untouched; only the user can fix a capital there. - coVerify { accountUseCase.setupServer("hammer.ink", "writer@example.com", "hunter2", false, null) } - } - - @Test - fun `a local server the watch may not reach yet waits for the prompt before logging in`() = - runTest(dispatcher) { - localNetwork.block("192.168.1.46:8081") - val component = newComponent() - component.updateServer("http://192.168.1.46:8081") - component.updateEmail("writer@example.com") - component.updatePassword("hunter2") - - component.signIn() - scheduler.advanceUntilIdle() - - // The login is the first request, and a blocked one would only time out. - assertTrue(component.state.value.localNetworkBlocked) - assertFalse(component.state.value.busy) - coVerify(exactly = 0) { accountUseCase.setupServer(any(), any(), any(), any(), any(), any()) } - } - - @Test - fun `granting local network access carries on with the sign in`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any(), any()) } returns - ServerSetupResult.Success - localNetwork.block("192.168.1.46:8081") - val component = newComponent() - component.updateServer("http://192.168.1.46:8081") - component.updateEmail("writer@example.com") - component.updatePassword("hunter2") - component.signIn() - scheduler.advanceUntilIdle() - - localNetwork.grant() - component.onLocalNetworkPermissionResult() - scheduler.advanceUntilIdle() - - assertFalse(component.state.value.localNetworkBlocked) - coVerify(exactly = 1) { - accountUseCase.setupServer("192.168.1.46:8081", "writer@example.com", "hunter2", false, null, false) - } - } - - @Test - fun `refusing local network access explains why the sign in stopped`() = runTest(dispatcher) { - localNetwork.block("192.168.1.46:8081") - val component = newComponent() - component.updateServer("http://192.168.1.46:8081") - component.updateEmail("writer@example.com") - component.updatePassword("hunter2") - component.signIn() - scheduler.advanceUntilIdle() - - component.onLocalNetworkPermissionResult() - scheduler.advanceUntilIdle() - - assertEquals(ManualSignIn.SignInError.LocalNetworkDenied, component.state.value.error) - coVerify(exactly = 0) { accountUseCase.setupServer(any(), any(), any(), any(), any(), any()) } - } - - @Test - fun `signing in with a field missing asks for it without calling the server`() = runTest(dispatcher) { - val component = newComponent() - component.updateServer("hammer.ink") - component.updateEmail("writer@example.com") - - component.signIn() - scheduler.advanceUntilIdle() - - assertEquals(ManualSignIn.SignInError.MissingFields, component.state.value.error) - coVerify(exactly = 0) { accountUseCase.setupServer(any(), any(), any(), any(), any()) } - } - - @Test - fun `a successful sign in logs in rather than creating an account`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns ServerSetupResult.Success - val component = newComponent() - component.fillIn() - - component.signIn() - scheduler.advanceUntilIdle() - - coVerify { accountUseCase.setupServer("hammer.ink", "writer@example.com", "hunter2", false, null) } - assertFalse(component.state.value.busy) - assertEquals(null, component.state.value.error) - } - - @Test - fun `an http server is signed in to in the clear`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any(), any()) } returns - ServerSetupResult.Success - val component = newComponent() - component.updateServer("http://192.168.1.50:8080") - component.updateEmail("writer@example.com") - component.updatePassword("hunter2") - - component.signIn() - scheduler.advanceUntilIdle() - - coVerify { - accountUseCase.setupServer("192.168.1.50:8080", "writer@example.com", "hunter2", false, null, false) - } - } - - @Test - fun `an http server is flagged as insecure and an https one is not`() = runTest(dispatcher) { - val component = newComponent() - - component.updateServer("http://192.168.1.50:8080") - assertTrue(component.state.value.serverInsecure) - - component.updateServer("hammer.ink") - assertFalse(component.state.value.serverInsecure) - - component.updateServer("https://hammer.ink") - assertFalse(component.state.value.serverInsecure) - } - - @Test - fun `the password is never exposed in state`() = runTest(dispatcher) { - val component = newComponent() - - component.updatePassword("hunter2") - - assertTrue(component.state.value.hasPassword) - assertFalse(component.state.value.toString().contains("hunter2")) - } - - @Test - fun `a server that needs its terms accepted is reported as such`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns - ServerSetupResult.TermsRequired(TermsOfServiceChallenge(text = "Be kind", version = "v1")) - val component = newComponent() - component.fillIn() - - component.signIn() - scheduler.advanceUntilIdle() - - assertEquals(ManualSignIn.SignInError.TermsRequired, component.state.value.error) - } - - @Test - fun `a rejected sign in shows the server's message`() = runTest(dispatcher) { - coEvery { accountUseCase.setupServer(any(), any(), any(), any(), any()) } returns - ServerSetupResult.Failure(displayMessage = "Invalid credentials".toMsg(), exception = null) - val component = newComponent() - component.fillIn() - - component.signIn() - scheduler.advanceUntilIdle() - - assertEquals(ManualSignIn.SignInError.Message("Invalid credentials"), component.state.value.error) - assertFalse(component.state.value.busy) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCaseTest.kt deleted file mode 100644 index d837368a7..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureTileStateUseCaseTest.kt +++ /dev/null @@ -1,83 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class CaptureTileStateUseCaseTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var unsynced: FakeUnsyncedContentSource - private lateinit var targets: CaptureTargetsUseCase - private lateinit var useCase: CaptureTileStateUseCase - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - unsynced = FakeUnsyncedContentSource() - val listProjects = ListWatchProjectsUseCase(projects.repository, subscriptions) - targets = CaptureTargetsUseCase(listProjects, subscriptions) - useCase = CaptureTileStateUseCase(targets, UnsyncedContentUseCase(listProjects, unsynced)) - } - - @Test - fun `the tile shows the project a note would go to and what is waiting`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - subscriptions.setLastCaptureProject(ProjectId("b")) - unsynced.pendingByProject["Beta"] = 2 - unsynced.pendingIdeas = 1 - - val state = useCase.load() - - assertEquals("Beta", state.projectName) - assertEquals(3, state.pending) - } - - @Test - fun `a watch with no project kept on it names none`() = runTest(dispatcher) { - // The project exists but is not subscribed, so a note still has nowhere to go. - projects.create("Alpha", serverId = "a") - - val state = useCase.load() - - assertNull(state.projectName) - assertEquals(0, state.pending) - } - - @Test - fun `the default falls back to the first project before anything has been captured`() = - runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - - assertEquals("Alpha", useCase.load().projectName) - } - - @Test - fun `a project that is gone is not offered as a target`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - // Unsubscribing elsewhere leaves the remembered id pointing at nothing on the watch. - subscriptions.setLastCaptureProject(ProjectId("gone")) - - val loaded = targets.load() - - assertEquals(listOf("Alpha"), loaded.projects.map { it.projectDef.name }) - assertEquals("Alpha", loaded.default?.projectDef?.name) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCaseTest.kt deleted file mode 100644 index 4b029f7e2..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/CaptureUseCaseTest.kt +++ /dev/null @@ -1,127 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeCaptureSurfaceUpdater -import com.darkrockstudios.apps.hammer.wear.FakeCaptureSyncScheduler -import com.darkrockstudios.apps.hammer.wear.FakeCaptureWriter -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertNull -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class CaptureUseCaseTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var writer: FakeCaptureWriter - private lateinit var unsynced: FakeUnsyncedContentSource - private lateinit var captureSync: FakeCaptureSyncScheduler - private lateinit var surfaces: FakeCaptureSurfaceUpdater - private lateinit var useCase: CaptureUseCase - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - writer = FakeCaptureWriter() - unsynced = FakeUnsyncedContentSource() - captureSync = FakeCaptureSyncScheduler() - surfaces = FakeCaptureSurfaceUpdater() - val subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - useCase = CaptureUseCase( - writer = writer, - unsyncedContent = UnsyncedContentUseCase( - ListWatchProjectsUseCase(projects.repository, subscriptions), - unsynced, - ), - captureSync = captureSync, - surfaces = surfaces, - ) - } - - @Test - fun `a dictated note is saved and pushed to the server`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = "a") - unsynced.pendingIdeas = 2 - - val result = useCase.capture(CaptureTarget.Note(projectDef), " salt on the stairs ") - - assertEquals(listOf("Alpha" to "salt on the stairs"), writer.notes) - assertEquals(CaptureResult.Saved, result) - assertEquals(1, captureSync.requests) - assertEquals(2, useCase.pendingCount()) - } - - @Test - fun `an idea needs no project`() = runTest(dispatcher) { - val result = useCase.capture(CaptureTarget.Idea, "a town with one memory") - - assertEquals(listOf("a town with one memory"), writer.ideas) - assertEquals(CaptureResult.Saved, result) - assertEquals(1, captureSync.requests) - } - - @Test - fun `a capture tells the watch face surfaces to re-read`() = runTest(dispatcher) { - useCase.capture(CaptureTarget.Idea, "a thought worth keeping") - - // The tile and complication are cached, so without this they keep showing a stale count. - assertEquals(1, surfaces.refreshes) - } - - @Test - fun `a capture that was not saved does not refresh anything`() = runTest(dispatcher) { - writer.succeed = false - - useCase.capture(CaptureTarget.Idea, "a thought") - - assertEquals(0, surfaces.refreshes) - } - - @Test - fun `blank text is not a capture`() = runTest(dispatcher) { - val result = useCase.capture(CaptureTarget.Idea, " ") - - assertEquals(CaptureResult.Empty, result) - assertEquals(emptyList(), writer.ideas) - assertEquals(0, captureSync.requests) - } - - @Test - fun `a rejected write is not reported as saved`() = runTest(dispatcher) { - writer.succeed = false - - val result = useCase.capture(CaptureTarget.Idea, "too long, perhaps") - - assertEquals(CaptureResult.Failed, result) - assertEquals(0, captureSync.requests) - } - - @Test - fun `a thrown write is not reported as saved`() = runTest(dispatcher) { - writer.failWith = IllegalStateException("disk full") - - val result = useCase.capture(CaptureTarget.Idea, "a thought") - - assertEquals(CaptureResult.Failed, result) - assertEquals(0, captureSync.requests) - } - - @Test - fun `a count that cannot be read never affects the capture`() = runTest(dispatcher) { - val projectDef = projects.create("Alpha", serverId = ProjectId("a").id) - unsynced.failWith = IllegalStateException("no journal") - - val result = useCase.capture(CaptureTarget.Note(projectDef), "a line worth keeping") - - assertEquals(CaptureResult.Saved, result) - assertEquals(1, writer.notes.size) - assertEquals(1, captureSync.requests) - // Null, not zero: the user must not be told nothing is waiting when we could not look. - assertNull(useCase.pendingCount()) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCaseTest.kt deleted file mode 100644 index a393f3edb..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/ListWatchProjectsUseCaseTest.kt +++ /dev/null @@ -1,58 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class ListWatchProjectsUseCaseTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var useCase: ListWatchProjectsUseCase - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - useCase = ListWatchProjectsUseCase(projects.repository, subscriptions) - } - - @Test - fun `a project is subscribed only when its server id is`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - - val listed = useCase.list().associateBy { it.projectDef.name } - - assertTrue(listed.getValue("Alpha").subscribed) - assertFalse(listed.getValue("Beta").subscribed) - } - - @Test - fun `a project the server does not know yet has no id and is never subscribed`() = runTest(dispatcher) { - projects.create("Draft") - - val draft = useCase.list().single() - - assertEquals(null, draft.projectId) - assertFalse(draft.subscribed) - } - - @Test - fun `projects are listed by name regardless of case`() = runTest(dispatcher) { - projects.create("beta", serverId = "b") - projects.create("Alpha", serverId = "a") - projects.create("Charlie", serverId = "c") - - assertEquals(listOf("Alpha", "beta", "Charlie"), useCase.list().map { it.projectDef.name }) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddressTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddressTest.kt deleted file mode 100644 index 0eccfb5f4..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/LocalNetworkAddressTest.kt +++ /dev/null @@ -1,77 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.Test -import java.net.InetAddress -import java.net.UnknownHostException - -class LocalNetworkAddressTest { - - /** Literal addresses never touch DNS, so these run offline. */ - private fun literal(host: String): List = listOf(InetAddress.getByName(host)) - - private fun unresolvable(@Suppress("UNUSED_PARAMETER") host: String): List = - throw UnknownHostException(host) - - @Test - fun `the port is not part of the host`() { - assertEquals("192.168.1.46", hostOf("192.168.1.46:8081")) - assertEquals("nas.lan", hostOf("nas.lan")) - assertEquals("fd00::1", hostOf("[fd00::1]:8080")) - assertEquals("fe80::1", hostOf("fe80::1")) - } - - @Test - fun `home network ranges need local network access`() { - listOf("192.168.1.46:8081", "10.0.0.5", "172.20.1.1:8080", "127.0.0.1:8443").forEach { address -> - assertTrue(isLocalNetworkServer(address, ::literal), address) - } - } - - @Test - fun `a public address does not`() { - listOf("93.184.216.34", "8.8.8.8:443", "172.32.0.1").forEach { address -> - assertFalse(isLocalNetworkServer(address, ::literal), address) - } - } - - @Test - fun `a mesh VPN address counts as local`() { - // Tailscale hands out the carrier-grade NAT range. - assertTrue(isLocalNetworkServer("100.101.102.103:8080", ::literal)) - assertFalse(isLocalNetworkServer("100.128.0.1", ::literal)) - } - - @Test - fun `IPv6 unique local and link-local addresses count as local`() { - assertTrue(isLocalNetworkServer("[fd12:3456::1]:8080", ::literal)) - assertTrue(isLocalNetworkServer("[fe80::1]:8080", ::literal)) - assertFalse(isLocalNetworkServer("[2606:4700::1111]:443", ::literal)) - } - - @Test - fun `a name is judged by what it resolves to`() { - val resolvesToLan = { _: String -> literal("192.168.1.46") } - val resolvesToPublic = { _: String -> literal("93.184.216.34") } - - // A public-looking name with a LAN record is exactly the case that looking alone misses. - assertTrue(isLocalNetworkServer("hammer.example.com", resolvesToLan)) - assertFalse(isLocalNetworkServer("hammer.ink", resolvesToPublic)) - } - - @Test - fun `an unresolvable name falls back to how it looks`() { - assertTrue(isLocalNetworkServer("nas.local:8080", ::unresolvable)) - assertTrue(isLocalNetworkServer("server.lan", ::unresolvable)) - assertTrue(isLocalNetworkServer("mynas", ::unresolvable)) - assertTrue(isLocalNetworkServer("localhost:8080", ::unresolvable)) - assertFalse(isLocalNetworkServer("hammer.ink", ::unresolvable)) - } - - @Test - fun `an empty address is not local`() { - assertFalse(isLocalNetworkServer("", ::unresolvable)) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCaseTest.kt deleted file mode 100644 index d774e5be5..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SignOutUseCaseTest.kt +++ /dev/null @@ -1,68 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.projectsrepository.ProjectsRepository -import com.darkrockstudios.apps.hammer.wear.FakeSyncCoordinator -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.sync.SyncScheduler -import io.mockk.every -import io.mockk.mockk -import io.mockk.verify -import kotlinx.coroutines.test.runTest -import okio.IOException -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class SignOutUseCaseTest { - - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var projectsRepository: ProjectsRepository - private lateinit var coordinator: FakeSyncCoordinator - private lateinit var syncScheduler: SyncScheduler - private lateinit var globalSettingsStore: GlobalSettingsStore - - @BeforeEach - fun setUp() { - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - projectsRepository = mockk(relaxed = true) - coordinator = FakeSyncCoordinator() - syncScheduler = mockk(relaxed = true) - globalSettingsStore = mockk(relaxed = true) - } - - private fun useCase() = SignOutUseCase( - globalSettingsStore = globalSettingsStore, - projectsRepository = projectsRepository, - subscriptions = subscriptions, - syncScheduler = syncScheduler, - syncCoordinator = coordinator, - ) - - @Test - fun `signing out forgets the account, its data and its subscriptions`() = runTest { - subscriptions.setSubscribed(ProjectId("a"), true) - - useCase().signOut() - - verify(exactly = 1) { syncScheduler.cancel() } - verify(exactly = 1) { projectsRepository.deleteAllLocalData() } - assertEquals(emptySet(), subscriptions.currentSubscriptions()) - assertEquals(1, coordinator.autoSyncResets) - } - - @Test - fun `a wipe that fails still clears the subscriptions and the auto sync latch`() = runTest { - subscriptions.setSubscribed(ProjectId("a"), true) - every { projectsRepository.deleteAllLocalData() } throws IOException("the disk went away") - - val failure = runCatching { useCase().signOut() }.exceptionOrNull() - - assertTrue(failure is IOException) - // Otherwise the next account signed in inherits this one's subscriptions. - assertEquals(emptySet(), subscriptions.currentSubscriptions()) - assertEquals(1, coordinator.autoSyncResets) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepositoryTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepositoryTest.kt deleted file mode 100644 index e848cd53b..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/SubscribedProjectsRepositoryTest.kt +++ /dev/null @@ -1,30 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test - -class SubscribedProjectsRepositoryTest { - - private val repository = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - - @Test - fun `subscribing and unsubscribing is reflected in the current subscriptions`() = runTest { - repository.setSubscribed(ProjectId("a"), true) - repository.setSubscribed(ProjectId("b"), true) - repository.setSubscribed(ProjectId("a"), false) - - assertEquals(setOf(ProjectId("b")), repository.currentSubscriptions()) - } - - @Test - fun `clearing forgets every subscription`() = runTest { - repository.setSubscribed(ProjectId("a"), true) - - repository.clear() - - assertEquals(emptySet(), repository.currentSubscriptions()) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContentUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContentUseCaseTest.kt deleted file mode 100644 index 7a7e19610..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/data/UnsyncedContentUseCaseTest.kt +++ /dev/null @@ -1,84 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.data - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.wear.FakeUnsyncedContentSource -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.TestProjects -import com.darkrockstudios.apps.hammer.wear.WearTestBase -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class UnsyncedContentUseCaseTest : WearTestBase() { - - private lateinit var projects: TestProjects - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var source: FakeUnsyncedContentSource - private lateinit var useCase: UnsyncedContentUseCase - - @BeforeEach - override fun setUp() { - super.setUp() - projects = TestProjects() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - source = FakeUnsyncedContentSource() - useCase = UnsyncedContentUseCase( - ListWatchProjectsUseCase(projects.repository, subscriptions), - source, - ) - } - - @Test - fun `a watch holding nothing outstanding reports empty`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - - val pending = useCase.pending() - - assertTrue(pending.isEmpty) - assertEquals(0, pending.total) - } - - @Test - fun `notes and ideas are counted together`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - subscriptions.setSubscribed(ProjectId("a"), true) - source.pendingByProject["Alpha"] = 2 - source.pendingIdeas = 3 - - val pending = useCase.pending() - - assertFalse(pending.isEmpty) - assertEquals(mapOf("Alpha" to 2), pending.projects) - assertEquals(5, pending.total) - } - - @Test - fun `projects that are not on the watch are not counted`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - // Beta holds no content on the watch, so a stale count for it must not be reported. - source.pendingByProject["Beta"] = 9 - - val pending = useCase.pending() - - assertTrue(pending.isEmpty) - } - - @Test - fun `a project with nothing outstanding is left out of the breakdown`() = runTest(dispatcher) { - projects.create("Alpha", serverId = "a") - projects.create("Beta", serverId = "b") - subscriptions.setSubscribed(ProjectId("a"), true) - subscriptions.setSubscribed(ProjectId("b"), true) - source.pendingByProject["Beta"] = 1 - - val pending = useCase.pending() - - assertEquals(mapOf("Beta" to 1), pending.projects) - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCaseTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCaseTest.kt deleted file mode 100644 index cae884487..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/pairing/PhonePairingUseCaseTest.kt +++ /dev/null @@ -1,177 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.pairing - -import com.darkrockstudios.apps.hammer.common.data.CResult -import com.darkrockstudios.apps.hammer.common.data.account.AccountUseCase -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.pairing.PairErrorCode -import com.darkrockstudios.apps.hammer.common.data.pairing.PairRequest -import com.darkrockstudios.apps.hammer.common.data.pairing.PairResponse -import com.darkrockstudios.apps.hammer.common.data.pairing.PairingProtocol -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import io.mockk.verify -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class PhonePairingUseCaseTest { - - private class FakePhoneClient : PhonePairingClient { - var phoneNodeId: String? = "phone-node" - var lookupFailure: Exception? = null - var sendFailure: Exception? = null - val sent = mutableListOf>() - - override suspend fun findPhone(): String? { - lookupFailure?.let { throw it } - return phoneNodeId - } - - override suspend fun sendRequest(nodeId: String, request: PairRequest) { - sendFailure?.let { throw it } - sent += nodeId to request - } - } - - private val watchSettings = ServerSettings( - url = "hammer.ink", - email = "writer@example.com", - userId = 7, - bearerToken = "watch-auth", - refreshToken = "watch-refresh", - ) - - private lateinit var client: FakePhoneClient - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var accountUseCase: AccountUseCase - private lateinit var useCase: PhonePairingUseCase - - @BeforeEach - fun setUp() { - client = FakePhoneClient() - globalSettingsStore = mockk() - coEvery { globalSettingsStore.ensureInstallId() } returns "watch-install" - accountUseCase = mockk() - every { accountUseCase.applyPairedSettings(any()) } returns CResult.success() - useCase = PhonePairingUseCase(client, globalSettingsStore, accountUseCase) - } - - private fun pendingRequestId(): String = client.sent.single().second.requestId - - @Test - fun `no reachable phone reports it and sends nothing`() = runTest { - client.phoneNodeId = null - - useCase.startPairing("Pixel Watch") - - assertEquals(PairingState.PhoneNotFound, useCase.state.value) - assertEquals(emptyList>(), client.sent) - } - - @Test - fun `an unavailable wearable api counts as no phone`() = runTest { - client.lookupFailure = IllegalStateException("Wearable API unavailable") - - useCase.startPairing("Pixel Watch") - - assertEquals(PairingState.PhoneNotFound, useCase.state.value) - } - - @Test - fun `a request for this install goes to the phone and waits for confirmation`() = runTest { - useCase.startPairing("Pixel Watch") - - val (nodeId, request) = client.sent.single() - assertEquals("phone-node", nodeId) - assertEquals("watch-install", request.installId) - assertEquals("Pixel Watch", request.deviceLabel) - assertEquals(PairingState.AwaitingConfirmation, useCase.state.value) - } - - @Test - fun `a failed send is reported as a local failure`() = runTest { - client.sendFailure = IllegalStateException("out of range") - - useCase.startPairing("Pixel Watch") - - assertEquals(PairingState.Failed(reason = null), useCase.state.value) - } - - @Test - fun `the phone's session is adopted when it answers the pending request`() = runTest { - useCase.startPairing("Pixel Watch") - - useCase.onResponse(PairingProtocol.encodeResponse(PairResponse.Success(pendingRequestId(), watchSettings))) - - assertEquals(PairingState.Paired, useCase.state.value) - verify(exactly = 1) { accountUseCase.applyPairedSettings(watchSettings) } - } - - @Test - fun `an answer to some other request is ignored`() = runTest { - useCase.startPairing("Pixel Watch") - - useCase.onResponse(PairingProtocol.encodeResponse(PairResponse.Success("stale-request", watchSettings))) - - assertEquals(PairingState.AwaitingConfirmation, useCase.state.value) - verify(exactly = 0) { accountUseCase.applyPairedSettings(any()) } - } - - @Test - fun `a declined request surfaces the reason`() = runTest { - useCase.startPairing("Pixel Watch") - - useCase.onResponse( - PairingProtocol.encodeResponse(PairResponse.Error(pendingRequestId(), PairErrorCode.Declined)) - ) - - assertEquals(PairingState.Failed(PairErrorCode.Declined), useCase.state.value) - } - - @Test - fun `a reply the phone could not address is applied to the pending request`() = runTest { - useCase.startPairing("Pixel Watch") - - useCase.onResponse( - PairingProtocol.encodeResponse(PairResponse.Error(requestId = "", code = PairErrorCode.Unsupported)) - ) - - assertEquals(PairingState.Failed(PairErrorCode.Unsupported), useCase.state.value) - } - - @Test - fun `a reply with no request pending is ignored even when it is unaddressed`() = runTest { - useCase.onResponse( - PairingProtocol.encodeResponse(PairResponse.Error(requestId = "", code = PairErrorCode.Unsupported)) - ) - - assertEquals(PairingState.Idle, useCase.state.value) - } - - @Test - fun `a reply that lands after the screen is gone is still adopted`() = runTest { - useCase.startPairing("Pixel Watch") - val requestId = pendingRequestId() - - // Leaving the pairing screen no longer abandons the request, so this still applies. - useCase.onResponse(PairingProtocol.encodeResponse(PairResponse.Success(requestId, watchSettings))) - - assertEquals(PairingState.Paired, useCase.state.value) - verify(exactly = 1) { accountUseCase.applyPairedSettings(watchSettings) } - } - - @Test - fun `a reply after reset is ignored`() = runTest { - useCase.startPairing("Pixel Watch") - val requestId = pendingRequestId() - useCase.reset() - - useCase.onResponse(PairingProtocol.encodeResponse(PairResponse.Success(requestId, watchSettings))) - - assertEquals(PairingState.Idle, useCase.state.value) - verify(exactly = 0) { accountUseCase.applyPairedSettings(any()) } - } -} diff --git a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/sync/DefaultSyncCoordinatorTest.kt b/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/sync/DefaultSyncCoordinatorTest.kt deleted file mode 100644 index dc1f912ba..000000000 --- a/wear/src/test/kotlin/com/darkrockstudios/apps/hammer/wear/sync/DefaultSyncCoordinatorTest.kt +++ /dev/null @@ -1,274 +0,0 @@ -package com.darkrockstudios.apps.hammer.wear.sync - -import com.darkrockstudios.apps.hammer.base.ProjectId -import com.darkrockstudios.apps.hammer.common.data.ProjectDef -import com.darkrockstudios.apps.hammer.common.data.SyncedProjectDefinition -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettings -import com.darkrockstudios.apps.hammer.common.data.globalsettings.GlobalSettingsStore -import com.darkrockstudios.apps.hammer.common.data.globalsettings.ServerSettings -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.ProjectSyncOutcome -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountListener -import com.darkrockstudios.apps.hammer.common.data.sync.accountsync.SyncAccountResult -import com.darkrockstudios.apps.hammer.common.fileio.HPath -import com.darkrockstudios.apps.hammer.common.util.NetworkConnectivity -import com.darkrockstudios.apps.hammer.wear.FakeCaptureSurfaceUpdater -import com.darkrockstudios.apps.hammer.wear.FakeWearPrefsDatasource -import com.darkrockstudios.apps.hammer.wear.data.SubscribedProjectsRepository -import io.mockk.coEvery -import io.mockk.every -import io.mockk.mockk -import kotlinx.coroutines.CompletableDeferred -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.async -import kotlinx.coroutines.cancel -import kotlinx.coroutines.launch -import kotlinx.coroutines.test.StandardTestDispatcher -import kotlinx.coroutines.test.TestCoroutineScheduler -import kotlinx.coroutines.test.runTest -import org.junit.jupiter.api.AfterEach -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Assertions.assertFalse -import org.junit.jupiter.api.Assertions.assertInstanceOf -import org.junit.jupiter.api.Assertions.assertTrue -import org.junit.jupiter.api.BeforeEach -import org.junit.jupiter.api.Test - -class DefaultSyncCoordinatorTest { - - private val alpha = ProjectDef("Alpha", HPath("/projects/Alpha", "Alpha", false)) - private val beta = ProjectDef("Beta", HPath("/projects/Beta", "Beta", false)) - private val candidates = listOf( - SyncedProjectDefinition(alpha, ProjectId("a")), - SyncedProjectDefinition(beta, ProjectId("b")), - ) - - private val signedIn = ServerSettings( - url = "hammer.ink", - email = "writer@example.com", - userId = 7, - bearerToken = "auth", - refreshToken = "refresh", - ) - - /** Reports which candidates the filter admits, then runs [behaviour] against the listener. */ - private inner class FakeAccountSync : AccountSync { - var runs = 0 - var admitted: List = emptyList() - var behaviour: suspend (SyncAccountListener) -> SyncAccountResult = { successResult() } - - override suspend fun run( - listener: SyncAccountListener, - projectFilter: (SyncedProjectDefinition) -> Boolean, - ): SyncAccountResult { - runs++ - admitted = candidates.filter(projectFilter).map { it.projectDef.name } - return behaviour(listener) - } - } - - private fun successResult() = SyncAccountResult( - accountSuccess = true, - ideasSuccess = true, - projects = mapOf("Alpha" to ProjectSyncOutcome.Success), - ) - - private val scheduler = TestCoroutineScheduler() - private val dispatcher = StandardTestDispatcher(scheduler) - private lateinit var appScope: CoroutineScope - - private lateinit var accountSync: FakeAccountSync - private lateinit var subscriptions: SubscribedProjectsRepository - private lateinit var globalSettingsStore: GlobalSettingsStore - private lateinit var networkConnectivity: NetworkConnectivity - private lateinit var surfaces: FakeCaptureSurfaceUpdater - private lateinit var coordinator: DefaultSyncCoordinator - - @BeforeEach - fun setUp() { - appScope = CoroutineScope(dispatcher) - accountSync = FakeAccountSync() - subscriptions = SubscribedProjectsRepository(FakeWearPrefsDatasource()) - globalSettingsStore = mockk() - every { globalSettingsStore.serverSettings } returns signedIn - every { globalSettingsStore.globalSettings } returns GlobalSettings(projectsDirectory = "/projects", automaticSyncing = true) - networkConnectivity = mockk() - coEvery { networkConnectivity.hasActiveConnection() } returns true - surfaces = FakeCaptureSurfaceUpdater() - coordinator = DefaultSyncCoordinator( - accountSync = accountSync, - subscriptions = subscriptions, - globalSettingsStore = globalSettingsStore, - networkConnectivity = networkConnectivity, - surfaces = surfaces, - appScope = appScope, - ) - } - - @AfterEach - fun tearDown() { - appScope.cancel() - } - - @Test - fun `only subscribed projects are admitted to the sync`() = runTest(dispatcher) { - subscriptions.setSubscribed(ProjectId("b"), true) - - coordinator.sync(SyncTrigger.Manual) - - assertEquals(listOf("Beta"), accountSync.admitted) - } - - @Test - fun `status tracks a sync from start to finish`() = runTest(dispatcher) { - val gate = CompletableDeferred() - accountSync.behaviour = { listener -> - listener.onProjectsDiscovered(listOf(alpha)) - listener.onProjectProgress(alpha, 0.5f) - gate.await() - listener.onProjectOutcome(alpha, ProjectSyncOutcome.Success) - successResult() - } - - val run = async { coordinator.sync(SyncTrigger.Manual) } - scheduler.advanceUntilIdle() - - val during = coordinator.status.value - assertTrue(during.running) - assertEquals(SyncTrigger.Manual, during.trigger) - assertEquals(ProjectSyncState(progress = 0.5f), during.projects["Alpha"]) - - gate.complete(Unit) - assertInstanceOf(SyncRunResult.Completed::class.java, run.await()) - - val after = coordinator.status.value - assertFalse(after.running) - assertEquals(ProjectSyncOutcome.Success, after.projects.getValue("Alpha").outcome) - assertEquals(successResult(), after.lastResult) - } - - @Test - fun `a sync requested while one is running reports the lock, not completion`() = runTest(dispatcher) { - val gate = CompletableDeferred() - accountSync.behaviour = { - gate.await() - successResult() - } - val first = async { coordinator.sync(SyncTrigger.Manual) } - scheduler.advanceUntilIdle() - - val second = coordinator.sync(SyncTrigger.Periodic) - gate.complete(Unit) - first.await() - - assertEquals(SyncRunResult.Busy, second) - assertEquals(1, accountSync.runs) - } - - @Test - fun `a finished sync tells the watch face surfaces to re-read`() = runTest(dispatcher) { - coordinator.sync(SyncTrigger.Manual) - - // A sync is the only thing that lowers the pending count the tile shows. - assertEquals(1, surfaces.refreshes) - } - - @Test - fun `a failed sync still refreshes, since it may have uploaded some of it`() = runTest(dispatcher) { - accountSync.behaviour = { error("network gone") } - - coordinator.sync(SyncTrigger.Manual) - - assertEquals(1, surfaces.refreshes) - } - - @Test - fun `an expired session is flagged for re-authentication`() = runTest(dispatcher) { - accountSync.behaviour = { listener -> - listener.onUnauthorized() - successResult().copy(accountSuccess = false) - } - - coordinator.sync(SyncTrigger.Manual) - - assertTrue(coordinator.status.value.needsReauth) - } - - @Test - fun `a thrown sync is reported as failed and releases the lock`() = runTest(dispatcher) { - accountSync.behaviour = { error("network gone") } - - val result = coordinator.sync(SyncTrigger.Manual) - - assertEquals(SyncRunResult.Failed, result) - assertFalse(coordinator.status.value.running) - assertTrue(coordinator.status.value.lastRunFailed) - accountSync.behaviour = { successResult() } - assertInstanceOf(SyncRunResult.Completed::class.java, coordinator.sync(SyncTrigger.Manual)) - } - - @Test - fun `a signed out watch does not sync`() = runTest(dispatcher) { - every { globalSettingsStore.serverSettings } returns null - - assertEquals(SyncRunResult.Skipped, coordinator.sync(SyncTrigger.Manual)) - assertEquals(0, accountSync.runs) - } - - @Test - fun `the app-open sync runs once per process`() = runTest(dispatcher) { - coordinator.requestAutoSync() - scheduler.advanceUntilIdle() - coordinator.requestAutoSync() - scheduler.advanceUntilIdle() - - assertEquals(1, accountSync.runs) - } - - @Test - fun `an app-open while offline does not use up the once-per-process sync`() = runTest(dispatcher) { - coEvery { networkConnectivity.hasActiveConnection() } returns false - coordinator.requestAutoSync() - scheduler.advanceUntilIdle() - assertEquals(0, accountSync.runs) - - coEvery { networkConnectivity.hasActiveConnection() } returns true - coordinator.requestAutoSync() - scheduler.advanceUntilIdle() - - assertEquals(1, accountSync.runs) - } - - @Test - fun `the app-open sync respects the automatic syncing setting`() = runTest(dispatcher) { - every { globalSettingsStore.globalSettings } returns - GlobalSettings(projectsDirectory = "/projects", automaticSyncing = false) - - coordinator.requestAutoSync() - scheduler.advanceUntilIdle() - - assertEquals(0, accountSync.runs) - } - - @Test - fun `exclusive work waits for a running sync to finish`() = runTest(dispatcher) { - val gate = CompletableDeferred() - val events = mutableListOf() - accountSync.behaviour = { - gate.await() - events += "sync finished" - successResult() - } - val sync = async { coordinator.sync(SyncTrigger.Manual) } - scheduler.advanceUntilIdle() - - val exclusive = launch { coordinator.runExclusive { events += "exclusive ran" } } - scheduler.advanceUntilIdle() - assertEquals(emptyList(), events) - - gate.complete(Unit) - sync.await() - exclusive.join() - - assertEquals(listOf("sync finished", "exclusive ran"), events) - } -}