Compare commits
5 Commits
d9639561ce
...
v0.2.5
| Author | SHA1 | Date | |
|---|---|---|---|
|
2593c95b5c | ||
|
|
12509cd4e2 | ||
|
|
3df11be5e9 | ||
|
|
72c735c3ee | ||
|
|
381a62046b |
376
AGENTS.md
376
AGENTS.md
@@ -1,376 +0,0 @@
|
||||
# AGENTS.md
|
||||
|
||||
This file is the entry point for agent guidance in this repository.
|
||||
|
||||
It is intentionally generic and reusable across projects. Keep this file focused on non-project-specific constraints, working style, and the structure used to link more detailed guidance.
|
||||
|
||||
# Purpose
|
||||
|
||||
- Provide a small default rule set for agents working in this repository.
|
||||
- Keep the base guidance modular and easy to extend.
|
||||
- Separate reusable agent behavior from project-specific requirements.
|
||||
|
||||
# Comment Syntax
|
||||
|
||||
- A segment wrapped in `<!--` and `-->` is a comment and must be ignored by agents.
|
||||
- Use HTML comments for optional guidance that should stay inactive until enabled.
|
||||
- To enable an optional segment, remove the surrounding `<!--` and `-->` markers.
|
||||
|
||||
# Core Principles
|
||||
|
||||
- Prefer the simplest solution that satisfies the current goal.
|
||||
- Keep guidance lightweight: only add detail when it meaningfully improves outcomes.
|
||||
- Reuse modular guideline files instead of expanding this file indefinitely.
|
||||
- Treat project-specific documents as the source of truth for project behavior.
|
||||
- When guidance conflicts, use the most specific applicable document.
|
||||
|
||||
# Rule Terms
|
||||
|
||||
- A `rule` is the general term for any constraint, requirement, definition, or similar guidance item.
|
||||
- A `rule set` addresses all rules inside one file that share the same rule set ID.
|
||||
- Any rule inside a rule set shall use an ID following the schema `RULESET-0001`, `RULESET-0002`, and so on.
|
||||
- Rules without a rule set ID are also valid, but they are not addressable by rule ID.
|
||||
|
||||
# Scope Of This File
|
||||
|
||||
This file should contain:
|
||||
|
||||
- Generic agent behavior and constraints.
|
||||
- Rules that are reusable across multiple projects.
|
||||
- Links to optional guideline modules.
|
||||
- Links to project-specific requirements.
|
||||
- Commented optional templates for released-product documentation and agent-output locations.
|
||||
|
||||
This file should not contain:
|
||||
|
||||
- Project business requirements.
|
||||
- Project architecture decisions.
|
||||
- Stack-specific implementation details unless they are universally applicable.
|
||||
- Task-specific runbooks that belong in dedicated modules.
|
||||
|
||||
# Default Agent Behavior
|
||||
|
||||
- Read the relevant context before making changes.
|
||||
- Prefer small, understandable edits over broad refactors.
|
||||
- Preserve existing patterns unless there is a clear reason to change them.
|
||||
- Document assumptions when context is missing.
|
||||
- Ignore HTML comment segments.
|
||||
- If a more specific enabled guideline exists for the current task, follow it.
|
||||
|
||||
# Guideline Structure
|
||||
|
||||
Use the following structure for reusable guidance files and project-specific documentation as needed:
|
||||
|
||||
```text
|
||||
/
|
||||
|-- AGENTS.md
|
||||
|-- guidance/
|
||||
| |-- stacks/
|
||||
| |-- conventions/
|
||||
| `-- workflows/
|
||||
|-- prompts/
|
||||
`-- requirements/
|
||||
|
||||
Optional files and directories
|
||||
|-- SCRATCHPAD.md
|
||||
|-- docs/
|
||||
| |-- readme.md
|
||||
| |-- installation.md
|
||||
| `-- history.md
|
||||
|-- process/
|
||||
| |-- log.md
|
||||
| `-- coding-handbook.md
|
||||
```
|
||||
|
||||
# Optional Reusable Modules
|
||||
|
||||
Add files under `guidance/` only when they are needed.
|
||||
|
||||
# Optional Scratchpad
|
||||
|
||||
- `SCRATCHPAD.md` is an optional repo-root scratchpad for temporary
|
||||
information aimed at the next iteration.
|
||||
- Developers may create or delete `SCRATCHPAD.md` at any time.
|
||||
- Developers may refer to `SCRATCHPAD.md` as `scratchpad` when giving agents a
|
||||
source or target for information.
|
||||
- Agents may read, update, create, or remove the scratchpad when the task
|
||||
explicitly calls for it.
|
||||
- Treat the scratchpad as low-formality working context rather than canonical
|
||||
project truth.
|
||||
- Use the scratchpad for short-lived notes, open questions, sketches, and
|
||||
temporary decisions that should be resolved away.
|
||||
- Move durable outcomes into `requirements/`, `guidance/`, code, tests, or
|
||||
another long-lived location.
|
||||
- If `SCRATCHPAD.md` is absent, agents should continue normally.
|
||||
|
||||
# Optional Rule Sets
|
||||
|
||||
- Optional rule sets may be stored in `guidance/optional/` or in `guidance/{section}/optional/`.
|
||||
- Optional rule sets are inactive by default and shall only be applied when a prompt explicitly requests them, for example by phrases such as `Apply rules for lean interface iteration in the following steps.` or `Apply LII rules.`
|
||||
- An optional rule set may be requested by its descriptive name, by its rule set ID, or by another equally clear explicit reference.
|
||||
- Agents shall never infer or auto-enable optional rule sets from general intent alone.
|
||||
- If an optional rule or rule set cannot be identified and addressed clearly, agents shall stop and ask before proceeding.
|
||||
|
||||
# Prepared Orders
|
||||
|
||||
- An `order` is a prepared prompt for one isolated operation rather than a general workflow or standing rule set.
|
||||
- Orders shall be stored under `prompts/`.
|
||||
- Order files shall use the naming schema `ORDER-0001-<slug>.md`, `ORDER-0002-<slug>.md`, and so on.
|
||||
- The canonical order identifier is the `ORDER-0001` style prefix. The trailing slug is descriptive only.
|
||||
- Recommended internal order file structure is: prompt ID, prompt name, purpose, trigger examples, scope, operation, and expected output.
|
||||
- Orders shall only be executed when they are explicitly requested by a prompt such as `Execute ORDER-0007.` or `Execute ORDER 7.`
|
||||
- Agents may accept an unambiguous short numeric reference such as `ORDER 7` as an alias for `ORDER-0007`.
|
||||
- If an order cannot be identified uniquely and clearly, agents shall stop and ask before proceeding.
|
||||
|
||||
# Toolstack Guides
|
||||
|
||||
Location:
|
||||
|
||||
```text
|
||||
guidance/stacks/
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `guidance/stacks/python.md`
|
||||
- `guidance/stacks/typescript.md`
|
||||
- `guidance/stacks/docker.md`
|
||||
- `guidance/stacks/terraform.md`
|
||||
|
||||
Use for:
|
||||
|
||||
- Language or framework expectations.
|
||||
- Tooling and environment conventions.
|
||||
- Build, test, and runtime guidance tied to a specific stack.
|
||||
|
||||
# Coding Conventions
|
||||
|
||||
Location:
|
||||
|
||||
```text
|
||||
guidance/conventions/
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `guidance/conventions/naming.md`
|
||||
- `guidance/conventions/testing.md`
|
||||
- `guidance/conventions/review.md`
|
||||
|
||||
Use for:
|
||||
|
||||
- Naming and structure conventions.
|
||||
- Testing expectations.
|
||||
- Code review and quality rules.
|
||||
|
||||
# Recurring Workflows
|
||||
|
||||
Location:
|
||||
|
||||
```text
|
||||
guidance/workflows/
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `guidance/workflows/feature-delivery.md`
|
||||
- `guidance/workflows/bugfix.md`
|
||||
- `guidance/workflows/release.md`
|
||||
- `guidance/workflows/incident-response.md`
|
||||
|
||||
Use for:
|
||||
|
||||
- Repeatable task flows.
|
||||
- Checklists for common delivery work.
|
||||
- Operational or maintenance procedures.
|
||||
|
||||
|
||||
<!-- Enable this optional section by removing the outer HTML comment markers from this segment
|
||||
when you want agents to create, update, and consult released-product
|
||||
documentation in `docs/`.
|
||||
|
||||
# Released Product Documentation
|
||||
|
||||
Released-product documentation should live outside the generic sections above.
|
||||
|
||||
Recommended location:
|
||||
|
||||
```text
|
||||
docs/
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `docs/readme.md`
|
||||
- `docs/installation.md`
|
||||
- `docs/history.md`
|
||||
|
||||
Agent rules for docs output:
|
||||
|
||||
- Keep content compact but comprehensive.
|
||||
- Write for end users, operators, or other consumers of the released product.
|
||||
- Prefer shipped behavior, supported workflows, and stable terminology over
|
||||
internal implementation detail.
|
||||
- Keep documentation synchronized with released behavior.
|
||||
- Update release history when user-visible changes are shipped.
|
||||
|
||||
Recommended topics:
|
||||
|
||||
- Product overview and intended use.
|
||||
- Installation, configuration, and upgrade guidance.
|
||||
- Usage patterns, operational instructions, and support boundaries.
|
||||
- Compatibility notes, migration notes, and release history.
|
||||
- Troubleshooting and common pitfalls when relevant. -->
|
||||
|
||||
|
||||
<!-- Enable this optional section by removing the outer HTML comment markers from this
|
||||
segment when you want agents to produce and consult workflow output in `process/`.
|
||||
|
||||
# Agent Output In `process/`
|
||||
|
||||
The `process/` directory is primarily for agent output created during
|
||||
delivery, maintenance, and review work.
|
||||
|
||||
Recommended location:
|
||||
|
||||
```text
|
||||
process/
|
||||
```
|
||||
|
||||
Agent rules for process output:
|
||||
|
||||
- Use `process/` for agent-produced artifacts rather than released-product
|
||||
documentation.
|
||||
- Keep entries concise, traceable, and tied to resulting changes.
|
||||
- Treat `process/` as workflow output, not as the primary source of product
|
||||
truth.
|
||||
- Prefer summaries and rationale over raw transcript dumps unless a workflow
|
||||
explicitly requires full prompt history.
|
||||
|
||||
# Agent Change Log
|
||||
|
||||
Location:
|
||||
|
||||
```text
|
||||
process/log.md
|
||||
```
|
||||
|
||||
Use for:
|
||||
|
||||
- Capturing prompts given to agents.
|
||||
- Recording concise explanations of the resulting changes made by agents.
|
||||
- Preserving task-by-task rationale, decisions, and implementation notes.
|
||||
|
||||
# Coding Handbook
|
||||
|
||||
Location:
|
||||
|
||||
```text
|
||||
process/coding-handbook.md
|
||||
```
|
||||
|
||||
Use for:
|
||||
|
||||
- A tutorial-style handbook that explains the programming components used in
|
||||
the project.
|
||||
- Compact but comprehensive technical onboarding material for future
|
||||
contributors.
|
||||
- Written explanations that connect code structure, concepts, and
|
||||
implementation patterns. -->
|
||||
|
||||
|
||||
# Project-Specific Requirements
|
||||
|
||||
|
||||
Project-specific material should live outside the generic sections above.
|
||||
|
||||
Recommended location:
|
||||
|
||||
```text
|
||||
requirements/
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
- `requirements/project.md`
|
||||
- `requirements/architecture.md`
|
||||
- `requirements/decisions.md`
|
||||
- `requirements/domain.md`
|
||||
|
||||
Use for:
|
||||
|
||||
- Product and business requirements.
|
||||
- Project goals and constraints.
|
||||
- Architecture and design decisions.
|
||||
- Domain knowledge that is specific to this repository.
|
||||
|
||||
# Agent-Level Variables
|
||||
|
||||
When present, `requirements/identifiers.yml` is an optional project-specific
|
||||
input that defines agent-level variables for use inside `requirements/` and
|
||||
`guidance/`.
|
||||
|
||||
Variable schema:
|
||||
|
||||
- Use `@{VARIABLE_NAME}` for agent-level variables.
|
||||
- Prefer uppercase snake case names such as `@{PROJECT_ID}` or `@{VENDOR_ID}`.
|
||||
- Do not treat `${...}` as an agent-level variable form; that syntax may appear
|
||||
in Bash or other code and should not be interpreted as agent metadata.
|
||||
|
||||
Scope:
|
||||
|
||||
- The effective scope of `requirements/identifiers.yml` is limited to
|
||||
`requirements/` and `guidance/`.
|
||||
- Definitions from `requirements/identifiers.yml` must not leak into product code.
|
||||
|
||||
Defaults:
|
||||
|
||||
- Default `@{VENDOR_ID}` is `osgw`.
|
||||
- Default `@{PROJECT_ID}` is the current repository directory name.
|
||||
|
||||
Resolution rules:
|
||||
|
||||
- Treat `requirements/identifiers.yml` as optional; when it is absent, agents
|
||||
may still resolve the defaults defined above.
|
||||
- If a variable is used in `requirements/` or `guidance/` and it is not
|
||||
defined in `requirements/identifiers.yml` and does not have a default in this
|
||||
file, agents may stop and report the undefined variable.
|
||||
- Prefer updating duplicated identifier values in `requirements/` and
|
||||
`guidance/` to use the variable schema when that improves consistency.
|
||||
|
||||
# Precedence
|
||||
|
||||
Some precedence levels may be absent because optional levels can remain inside
|
||||
HTML comments. The smaller numeric index wins.
|
||||
|
||||
Apply guidance in this order:
|
||||
|
||||
1. Direct user or task instructions.
|
||||
2. Project-specific documents in `requirements/`.
|
||||
<!-- 3. Released-product documentation in `docs/` when shipped behavior or
|
||||
user-facing expectations are relevant. -->
|
||||
4. Relevant modular guides in `guidance/stacks/`, `guidance/conventions/`, or `guidance/workflows/`.
|
||||
<!-- 5. Agent output in `process/` when prior prompts, rationale, or
|
||||
implementation notes are relevant. -->
|
||||
6. This `AGENTS.md`.
|
||||
|
||||
# Maintenance
|
||||
|
||||
- Keep this file short and stable.
|
||||
- Move detail into dedicated modules when a section becomes too specific or too long.
|
||||
- Add new guideline files only when they solve a recurring need.
|
||||
- Remove outdated references when the repository structure changes.
|
||||
|
||||
# Current Status
|
||||
|
||||
This repository defines the base `AGENTS.md` structure plus project-specific
|
||||
requirements and modular guidance.
|
||||
|
||||
Future project work can add:
|
||||
|
||||
- Reusable modules under `guidance/`
|
||||
- Project-specific documentation under `requirements/`
|
||||
- Optional temporary iteration context in `SCRATCHPAD.md`
|
||||
- Optional released-product documentation under `docs/` by uncommenting its segment
|
||||
- Optional agent output under `process/` by uncommenting its segment
|
||||
- Cross-references from this file once those documents exist
|
||||
@@ -1,71 +0,0 @@
|
||||
# Scratchpad
|
||||
|
||||
## Goal
|
||||
|
||||
- Capture a compact, project-wide list of optimization candidates after a broad scan of the current FFX codebase, tooling, and requirements.
|
||||
|
||||
## Focused Snapshot
|
||||
|
||||
- Highest-leverage application optimizations:
|
||||
- Decide whether placeholder help/settings screens should ship or disappear.
|
||||
- Trim dead helpers and other dormant surface that still looks active.
|
||||
|
||||
- Highest-leverage repo and workflow optimizations:
|
||||
- Continue migrating the oversized legacy test/combinator surface into focused modern tests so it is easier to run, debug, and extend.
|
||||
|
||||
## Optimization Candidates
|
||||
|
||||
1. Placeholder UI surfaces should either ship or disappear
|
||||
- [`src/ffx/help_screen.py`](/home/osgw/.local/src/codex/ffx/src/ffx/help_screen.py) and [`src/ffx/settings_screen.py`](/home/osgw/.local/src/codex/ffx/src/ffx/settings_screen.py) are placeholders.
|
||||
- Optimization:
|
||||
- Either remove them from the active UI surface or complete them.
|
||||
- Avoid paying ongoing maintenance cost for unfinished navigation targets.
|
||||
- Expected value:
|
||||
- Leaner interface.
|
||||
- Lower UX ambiguity.
|
||||
|
||||
2. Several helper functions are unfinished or dead-weight
|
||||
- [`src/ffx/helper.py`](/home/osgw/.local/src/codex/ffx/src/ffx/helper.py) contains `permutateList(...): pass`.
|
||||
- There are many combinator and conversion placeholders across tests and migrations.
|
||||
- Optimization:
|
||||
- Remove dead code, finish it, or isolate it behind a clearly dormant area.
|
||||
- Avoid carrying stubbed utility surface that looks reusable but is not.
|
||||
- Expected value:
|
||||
- Smaller mental model.
|
||||
- Less time spent re-evaluating inactive paths.
|
||||
|
||||
3. Test suite shape is expensive to understand and likely expensive to run
|
||||
- The project still carries a large legacy matrix of combinator files under [`tests/legacy`](/home/osgw/.local/src/codex/ffx/tests/legacy), several placeholder `pass` implementations, and at least one suspicious filename with an embedded space: [`tests/legacy/disposition_combinator_2_3 .py`](/home/osgw/.local/src/codex/ffx/tests/legacy/disposition_combinator_2_3 .py).
|
||||
- A first focused replacement slice now exists in [`tests/integration/subtrack_mapping/test_cli_bundle.py`](/home/osgw/.local/src/codex/ffx/tests/integration/subtrack_mapping/test_cli_bundle.py), so the remaining work is migration and consolidation rather than creating the modern test shape from scratch.
|
||||
- Optimization:
|
||||
- Continue replacing broad combinator matrices with focused parametrized integration and unit tests.
|
||||
- Retire the bespoke legacy discovery and runner path once equivalent coverage exists.
|
||||
- Normalize file naming and test discovery conventions.
|
||||
- Expected value:
|
||||
- Faster contributor onboarding.
|
||||
- Easier CI adoption later.
|
||||
|
||||
## Open
|
||||
|
||||
- Durable shipped items have been moved into [`README.md`](/home/osgw/.local/src/codex/ffx/README.md) version history through `0.2.5`.
|
||||
- Should optimization work focus first on operator-perceived latency, internal maintainability, or correctness-risk cleanup that also has performance upside?
|
||||
- Is the long-term supported model still “local Linux workstation plus Textual UI,” or should optimization decisions bias toward a more scriptable/headless CLI?
|
||||
|
||||
## Gaps Right Now
|
||||
|
||||
- No explicit prioritization owner or milestone for the optimization backlog.
|
||||
- No benchmark or timing harness exists for startup, probe, DB, or conversion orchestration overhead.
|
||||
- Repo hygiene is still mixed with generated artifacts and some clearly unfinished files.
|
||||
- The legacy TMDB-backed `Scenario 4` path is currently blocked by a pattern/track regression: `Patterns must define at least one track before they can be stored.` This surfaced while rerunning TMDB-dependent checks after the zero-track pattern hardening.
|
||||
|
||||
## Next
|
||||
|
||||
1. Triage the list into quick wins, medium refactors, and long-horizon cleanup.
|
||||
2. Tackle the cheapest remaining product-surface cleanup first:
|
||||
- placeholder UI surfaces and dead helper cleanup.
|
||||
3. Continue replacing oversized legacy test matrices with focused modern integration and unit coverage.
|
||||
4. Triage the legacy `Scenario 4` pattern/track failure and decide whether to fix the harness, adapt it to the zero-track guard, or retire that path during the ongoing test-suite migration.
|
||||
|
||||
## Delete When
|
||||
|
||||
- Delete this scratchpad once the optimization backlog is either converted into issues/work items or distilled into durable project guidance.
|
||||
@@ -1,28 +0,0 @@
|
||||
# Lean Interface Iteration
|
||||
|
||||
Rule set name: `lean-interface-iteration`
|
||||
|
||||
Rule set ID: `LII`
|
||||
|
||||
Status: optional, prompt-activated only
|
||||
|
||||
Trigger examples:
|
||||
|
||||
- `Apply the lean-interface-iteration rules.`
|
||||
- `Apply LII rules.`
|
||||
|
||||
LII-0001: Apply this rule set only when it is explicitly requested in the prompt.
|
||||
|
||||
LII-0002: The target of work under this rule set is the iterated product state for the addressed iteration only.
|
||||
|
||||
LII-0003: Optimize the addressed interface toward the leanest and least complex model that still satisfies the iteration order.
|
||||
|
||||
LII-0004: Backward compatibility, legacy aliases, and compatibility shims are not required unless the prompt explicitly asks to preserve them.
|
||||
|
||||
LII-0005: Prefer one authoritative interface over multiple overlapping parameters, flags, or naming variants.
|
||||
|
||||
LII-0006: Remove or avoid transitional interface layers when they are not required by the addressed iteration order.
|
||||
|
||||
LII-0007: Update affected tests, guidance, requirements, and documentation so they describe the simplified interface model rather than a mixed legacy-and-new model.
|
||||
|
||||
LII-0008: Never change behavior, interfaces, or surrounding areas that are not addressed by the current iteration order.
|
||||
@@ -1,56 +0,0 @@
|
||||
# Preparation Script Design
|
||||
|
||||
Rule set name: `preparation-script-design`
|
||||
|
||||
Rule set ID: `PSD`
|
||||
|
||||
Status: optional, prompt-activated only
|
||||
|
||||
Trigger examples:
|
||||
|
||||
- `Apply the preparation-script-design rules.`
|
||||
- `Apply PSD rules.`
|
||||
|
||||
PSD-0001: Apply this rule set only when it is explicitly requested in the prompt.
|
||||
|
||||
PSD-0002: Use this rule set for scripts whose purpose is to prepare, verify, or expose a local development or automation environment rather than to perform product runtime behavior.
|
||||
|
||||
PSD-0003: Keep a preparation script focused on environment readiness, dependency installation, local helper exposure, and clear verification output; do not mix unrelated product logic into the script.
|
||||
|
||||
PSD-0004: Design the script to be idempotent so repeated runs converge on the same prepared state without unnecessary reinstallation or destructive side effects.
|
||||
|
||||
PSD-0005: Provide a verification-only mode such as `--check` that reports readiness without installing, modifying, or creating dependencies.
|
||||
|
||||
PSD-0006: Separate component checks from installation steps so the script can report what is missing before or after attempted remediation.
|
||||
|
||||
PSD-0007: Group required capabilities into clear purpose-oriented sections such as support toolchains, local package bundles, generated environment helpers, or other relevant readiness areas instead of presenting one undifferentiated dependency list.
|
||||
|
||||
PSD-0008: Prefer explicit per-component check helpers over opaque one-shot checks so failures remain traceable and easy to extend.
|
||||
|
||||
PSD-0009: Generate or update environment helper files only when they provide a stable, reusable way to expose repo-local or workspace-local tools, paths, or environment variables.
|
||||
|
||||
PSD-0010: Generated environment helper files shall be safe to source multiple times and should avoid duplicating path entries or clobbering unrelated user environment state.
|
||||
|
||||
PSD-0011: When a preparation flow seeds optional user-owned files such as config templates, do so non-destructively by creating them only when absent unless the prompt explicitly requests overwrite behavior.
|
||||
|
||||
PSD-0012: Report status in a concise scan-friendly line format of the shape `[status] Label: detail`, where the label names the checked component and the detail string stays short and specific.
|
||||
|
||||
PSD-0013: Prefer a small canonical status vocabulary in those report lines, with `ok` for satisfied checks, `warn` for non-blocking gaps, and a failure status such as `failed` for blocking or unsuccessful states.
|
||||
|
||||
PSD-0014: When a preparation script uses terminal colors in its status output, apply a consistent severity mapping so `ok` is green, `warn` is yellow, and all other status levels are red.
|
||||
|
||||
PSD-0015: In bracketed status markers such as `[ok]` or `[warn]`, keep the square brackets uncolored and apply the severity color only to the inner status text.
|
||||
|
||||
PSD-0016: Colorized status output shall degrade safely in non-terminal or non-color contexts so the script remains readable and automation-friendly without ANSI support.
|
||||
|
||||
PSD-0017: End with an explicit readiness conclusion that distinguishes between successful preparation, incomplete prerequisites, and failed installation attempts.
|
||||
|
||||
PSD-0018: Installation logic should use the narrowest supported platform-specific package-manager actions necessary for the declared scope and should fail clearly when no supported installation path is available.
|
||||
|
||||
PSD-0019: Treat repo-local helper tooling and local package installation boundaries explicitly rather than assuming global installs, especially when the prepared environment is intended to be reproducible.
|
||||
|
||||
PSD-0020: Keep the script suitable for both interactive local developer use and non-interactive automation checks by avoiding prompts during normal execution unless the prompt explicitly requires interactivity.
|
||||
|
||||
PSD-0021: When a script depends on generated helper files or adjacent validation helpers, update those supporting files only as needed to keep the preparation flow coherent and usable.
|
||||
|
||||
PSD-0022: Verify shell syntax after changes and, when feasible, run a dry readiness check so the resulting preparation flow is validated rather than only written.
|
||||
@@ -1,98 +0,0 @@
|
||||
# Architecture
|
||||
|
||||
## Architecture Goals
|
||||
|
||||
- Keep the tool small, local, and easy to reason about.
|
||||
- Separate media inspection, stored normalization rules, and conversion execution clearly enough that users can inspect and adjust behavior.
|
||||
- Favor explicit local state and deterministic rule application over opaque automation.
|
||||
- Make external runtime dependencies and platform assumptions visible.
|
||||
|
||||
## System Context
|
||||
|
||||
- Primary actors:
|
||||
- Local operator running the CLI.
|
||||
- Local operator using the Textual TUI to inspect files and maintain rules.
|
||||
- External systems:
|
||||
- `ffprobe` for media introspection.
|
||||
- `ffmpeg` for conversion and extraction.
|
||||
- TMDB API for optional show and episode metadata.
|
||||
- Local filesystem for source media, generated outputs, subtitles, logs, config, and database files.
|
||||
- Data entering the system:
|
||||
- Media container and stream metadata from source files.
|
||||
- Regex patterns and per-show normalization rules entered in the TUI.
|
||||
- Optional config values from `~/.local/etc/ffx.json`.
|
||||
- Optional TMDB identifiers and CLI overrides.
|
||||
- Optional external subtitle files.
|
||||
- Data leaving the system:
|
||||
- Normalized output media files.
|
||||
- Extracted stream files from unmux operations.
|
||||
- SQLite rows representing shows, patterns, tracks, tags, shifted seasons, and properties.
|
||||
- Local log output and console messages.
|
||||
|
||||
## High-Level Building Blocks
|
||||
|
||||
- Frontend, CLI, API, or worker:
|
||||
- A Click-based CLI in [`src/ffx/cli.py`](/home/osgw/.local/src/codex/ffx/src/ffx/cli.py), exposed as the `ffx` command and via `python -m ffx`, including lightweight maintenance wrappers for bundle setup, workstation preparation, and upgrade tasks.
|
||||
- A Textual terminal UI rooted in [`src/ffx/ffx_app.py`](/home/osgw/.local/src/codex/ffx/src/ffx/ffx_app.py) with screens for shows, patterns, file inspection, tracks, tags, and shifted seasons.
|
||||
- Core business logic:
|
||||
- Descriptor objects model media files, shows, and tracks.
|
||||
- Controllers encapsulate CRUD operations and workflow orchestration for shows, patterns, tags, tracks, season shifts, configuration, and conversion.
|
||||
- `MediaDescriptorChangeSet` computes differences between a file and its stored target schema to drive metadata and disposition updates.
|
||||
- File inspection caches combined `ffprobe` data and crop-detection results per source and sampling window within one process to avoid repeated subprocess work.
|
||||
- Storage:
|
||||
- SQLite via SQLAlchemy ORM, with schema rooted in shows, patterns, tracks, media tags, track tags, shifted seasons, and generic properties.
|
||||
- Ordered schema migrations are loaded dynamically from per-version-step modules under [`src/ffx/model/migration/`](/home/osgw/.local/src/codex/ffx/src/ffx/model/migration/).
|
||||
- A configuration JSON file supplies optional path, metadata-filtering, and filename-template settings.
|
||||
- Integration adapters:
|
||||
- Process execution wrapper for `ffmpeg`, `ffprobe`, `nice`, and `cpulimit`, with explicit disabled states for niceness and CPU limiting, support for both absolute `cpulimit` values and machine-wide percent input, and a combined `cpulimit -- nice -n ... <command>` execution shape when both limits are configured.
|
||||
- HTTP adapter for TMDB via `requests`.
|
||||
|
||||
## Data And Interface Notes
|
||||
|
||||
- Key entities or records:
|
||||
- `Show`: canonical TV show metadata plus digit-formatting rules, optional show-level notes, and an optional show-level encoding-quality fallback.
|
||||
- `Pattern`: regex rule tying filenames to one show and one target media schema.
|
||||
- `Track` and `TrackTag`: persisted target stream records, codec, dispositions, audio layout, and stream-level tags. Detailed source-to-target mapping rules live in `requirements/subtrack_mapping.md`.
|
||||
- `MediaTag`: persisted container-level metadata for a pattern.
|
||||
- `ShiftedSeason`: mapping from source numbering ranges to adjusted season and episode numbers, owned either by a show as fallback or by a pattern as override.
|
||||
- `Property`: internal key-value storage currently used for database versioning.
|
||||
- External interfaces:
|
||||
- CLI commands for conversion, inspection, extraction, and crop detection.
|
||||
- TUI workflows for rule authoring and rule maintenance.
|
||||
- Environment variable `TMDB_API_KEY` for TMDB access.
|
||||
- Config keys `databasePath`, `logDirectory`, and `outputFilenameTemplate`, plus optional metadata-filter rules.
|
||||
- Validation rules:
|
||||
- Only supported media-file extensions are accepted for conversion.
|
||||
- Stored database version must either match the runtime-required version already or have a supported sequential migration path to it.
|
||||
- A normalized descriptor may have at most one default and one forced stream per relevant track type.
|
||||
- Shifted-season ranges are intended not to overlap within the same owner scope and season, and runtime resolution prefers pattern-owned matches over show-owned matches.
|
||||
- TMDB lookups require a show ID and season and episode numbers.
|
||||
- Error-handling approach:
|
||||
- User-facing operational failures are raised as `click.ClickException` or warnings.
|
||||
- Ambiguous default and forced stream states trigger prompts unless `--no-prompt` is set, in which case the command fails fast.
|
||||
- External-process failures and invalid media are surfaced through logs and command errors rather than retries, except for TMDB rate-limit retries.
|
||||
|
||||
## Deployment And Operations
|
||||
|
||||
- Runtime environment:
|
||||
- Local Python environment with the package installed and `ffmpeg`, `ffprobe`, `nice`, and `cpulimit` available on `PATH`.
|
||||
- Deployment shape:
|
||||
- Single-process command execution on demand; no daemon, queue, or network service of its own.
|
||||
- Secrets and configuration handling:
|
||||
- TMDB secret is read from `TMDB_API_KEY`.
|
||||
- User config is read from `~/.local/etc/ffx.json`.
|
||||
- Database path may also be overridden per command via `--database-file`.
|
||||
- Logging and monitoring approach:
|
||||
- File and console logging configured per invocation.
|
||||
- Default log file path is `~/.local/var/log/ffx.log`.
|
||||
- No dedicated monitoring integration is present.
|
||||
|
||||
## Open Technical Questions
|
||||
|
||||
- Question: Should Linux-specific assumptions such as `/dev/null`, `nice`, `cpulimit`, and `~/.local` remain part of the supported-platform contract?
|
||||
- Risk: Portability and operational behavior are underspecified for non-Linux environments.
|
||||
- Next decision needed: Either document Linux-like systems as the official support boundary or refactor the process and path handling for broader portability.
|
||||
|
||||
- Question: Should placeholder TUI surfaces such as settings and help become part of the required product surface or stay explicitly out of scope?
|
||||
- Risk: The UI appears broader than the actually finished feature set.
|
||||
- Next decision needed: Either remove or complete placeholder screens and update requirements accordingly.
|
||||
@@ -1,68 +0,0 @@
|
||||
# Pattern Management
|
||||
|
||||
This file defines the behavioral contract for managing shows, patterns, and
|
||||
pattern-backed filename matching.
|
||||
|
||||
Primary source: actual tool code in `src/ffx/`.
|
||||
Secondary source: operator intent captured in task discussion.
|
||||
|
||||
## Scope
|
||||
|
||||
- The show, pattern, and track hierarchy stored in SQLite.
|
||||
- The role of a pattern as a reusable normalization definition for related media files.
|
||||
- Filename-driven assignment of a scanned media file to one show through one matching pattern.
|
||||
- Duplicate-match handling when more than one pattern matches the same filename.
|
||||
|
||||
## Terms
|
||||
|
||||
- `show`: logical series identity such as one TV show entry in the database.
|
||||
- `pattern`: regex-backed normalization definition attached to one show.
|
||||
- `track`: one persisted target-track definition attached to one pattern.
|
||||
- `scanned media file`: one source file currently being inspected or converted.
|
||||
- `duplicate pattern match`: a filename state where more than one stored pattern matches the same scanned media file.
|
||||
- `pattern-backed target schema`: the combination of one pattern's stored media tags and stored track definitions.
|
||||
|
||||
## Rules
|
||||
|
||||
- `PATTERN_MANAGEMENT-0001`: The domain model shall treat a show as the parent entity for patterns that describe distinct release families or normalization schemas for that show. A show may temporarily exist without patterns during editing or initial TUI creation.
|
||||
- `PATTERN_MANAGEMENT-0002`: Each persisted pattern shall belong to exactly one show.
|
||||
- `PATTERN_MANAGEMENT-0003`: The domain model shall treat a pattern as the reusable normalization definition for a series of media files expected to share the same internal track layout and materially similar stream and container metadata.
|
||||
- `PATTERN_MANAGEMENT-0004`: Each persisted track definition shall belong to exactly one pattern.
|
||||
- `PATTERN_MANAGEMENT-0005`: A pattern may also carry pattern-level media tags. The pattern's media tags plus its track definitions together form the pattern-backed target schema.
|
||||
- `PATTERN_MANAGEMENT-0006`: A scanned media file shall resolve to at most one pattern and therefore at most one show.
|
||||
- `PATTERN_MANAGEMENT-0007`: If no pattern matches a filename, the file shall remain unmatched rather than being assigned implicitly.
|
||||
- `PATTERN_MANAGEMENT-0008`: If more than one pattern matches the same filename, the system shall raise a duplicate pattern match error instead of silently selecting one.
|
||||
- `PATTERN_MANAGEMENT-0009`: Duplicate-match detection shall apply regardless of whether the competing patterns belong to the same show or to different shows.
|
||||
- `PATTERN_MANAGEMENT-0010`: Exact duplicate pattern definitions for the same show should not create multiple persisted pattern rows.
|
||||
- `PATTERN_MANAGEMENT-0011`: A persisted pattern shall define one or more tracks. Creating or retaining a zero-track pattern in the database is invalid managed state and shall be prohibited.
|
||||
- `PATTERN_MANAGEMENT-0012`: A show may exist without patterns as an intermediate editing state, for example when a user creates the show first in the TUI and adds patterns later.
|
||||
- `PATTERN_MANAGEMENT-0013`: Operator-facing pattern management should expose the owning show, regex pattern, stored track set, and stored media-tag set so a user can reason about matching and normalization behavior.
|
||||
- `PATTERN_MANAGEMENT-0014`: Matching semantics shall be deterministic and documented. Implicit "last matching pattern wins" behavior is not acceptable released behavior.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- A filename that matches exactly one pattern yields one matched pattern and one show identity.
|
||||
- A filename that matches no pattern yields no matched pattern and an unmatched state.
|
||||
- A filename that matches more than one pattern yields an explicit duplicate-match error.
|
||||
- A pattern-backed target schema can be reconstructed from one pattern's stored media tags and stored track definitions.
|
||||
- A show may be stored before any patterns are attached to it.
|
||||
- A pattern cannot be stored or retained as a valid managed pattern unless at least one track is defined for it.
|
||||
- Pattern-backed conversion never proceeds with two competing matching patterns for the same input filename.
|
||||
|
||||
## Current Code Fit
|
||||
|
||||
- `src/ffx/model/show.py` implements a one-to-many `Show -> Pattern` relationship.
|
||||
- `src/ffx/model/pattern.py` implements `Pattern.show_id`, a one-to-many `Pattern -> Track` relationship, a one-to-many `Pattern -> MediaTag` relationship, and a unique `(show_id, pattern)` constraint for freshly created databases.
|
||||
- `src/ffx/model/track.py` implements `Track.pattern_id`, so each persisted track belongs to one pattern.
|
||||
- `src/ffx/model/pattern.py` reconstructs a pattern-backed target schema through `Pattern.getMediaDescriptor(...)`, combining stored media tags and stored tracks.
|
||||
- `src/ffx/file_properties.py` assumes a scanned file resolves to at most one pattern, because it stores only one `self.__pattern` and derives one `show_id` from it.
|
||||
- `src/ffx/pattern_controller.py` prevents exact duplicate `(show_id, pattern)` definitions during create and update flows, and it refreshes cached compiled regexes when stored pattern expressions change.
|
||||
- `src/ffx/pattern_controller.py` now complies with duplicate-match safety. `matchFilename(...)` scans deterministically, returns exactly one match, returns `{}` for no match, and raises an explicit duplicate-pattern-match error when more than one pattern matches the same filename.
|
||||
- The current persistence layer already aligns with the intended empty-show workflow because a show can exist without patterns.
|
||||
- New pattern creation and schema replacement flows now require at least one track, and `TrackController.deleteTrack(...)` prevents deleting the last persisted track from a pattern.
|
||||
- Trackless legacy rows can still exist in preexisting databases, but matching now rejects them explicitly instead of letting them participate silently.
|
||||
|
||||
## Risks
|
||||
|
||||
- The intended "release family" meaning of a pattern is a domain assumption, not something the code verifies automatically across all files matching that pattern.
|
||||
- Preexisting databases created before the newer validation rules may still contain invalid rows, so upgrade and cleanup paths should continue to treat explicit validation failures as recoverable operator signals.
|
||||
@@ -1,124 +0,0 @@
|
||||
## Purpose And Scope
|
||||
|
||||
- Project name: FFX
|
||||
- User problem: TV episode files from mixed sources arrive with inconsistent codecs, stream metadata, subtitle layouts, season and episode numbering, and output filenames, which makes them awkward to archive and use in media-player applications.
|
||||
- Target users: Individual operators curating a local TV media library on a workstation, especially users willing to define normalization rules per show.
|
||||
- Success outcome: A user can inspect source files, define reusable show and pattern rules, and produce output files whose streams, metadata, and filenames follow a predictable schema for web playback and library import.
|
||||
- Out of scope:
|
||||
- Multi-user or hosted service workflows.
|
||||
- General movie-library management.
|
||||
- Distributed transcoding or remote job orchestration.
|
||||
- Broad media-server administration beyond file preparation.
|
||||
|
||||
## Required Product
|
||||
|
||||
- Deliverable type: Installable Python command-line application with a Textual terminal UI for inspection and rule editing.
|
||||
- Core capabilities:
|
||||
- Maintain an SQLite-backed database of shows, filename-matching patterns, per-pattern stream layouts and metadata tags, and optional season-shift rules.
|
||||
- Inspect existing media files through `ffprobe` and compare discovered stream metadata with stored normalization rules.
|
||||
- Convert media files through `ffmpeg` into a normalized output layout, including video recoding, audio transcoding to Opus, metadata cleanup and rewrite, and controlled disposition flags.
|
||||
- Build output filenames from detected or configured show, season, and episode information, optionally enriched from TMDB and a configurable Jinja-style filename template.
|
||||
- Support auxiliary file operations such as subtitle import, unmuxing, crop detection, rename-only conversion runs, and direct in-place episode renaming.
|
||||
- Supported environments:
|
||||
- Local execution on a Python-capable workstation.
|
||||
- Best-supported on Linux-like systems because the implementation assumes `~/.local`, `/dev/null`, `nice`, and `cpulimit`.
|
||||
- Requires `ffmpeg`, `ffprobe`, and `cpulimit` on `PATH`.
|
||||
- Operational owner: The local user running the tool and maintaining its config, database, and external tooling.
|
||||
|
||||
## Suggested User Stories
|
||||
|
||||
- As a library maintainer, I want to define show-specific matching rules once so that future source files can be normalized automatically.
|
||||
- As an operator, I want to inspect a file before conversion so that I can compare its actual streams and tags against the stored target schema.
|
||||
- As a user preparing web-playback files, I want to recode video and audio with a small set of predictable options so that results are compatible and consistently named.
|
||||
- As a user dealing with nonstandard releases, I want CLI overrides for language, title, stream order, default and forced tracks, and season and episode data so that one-off fixes do not require database edits first.
|
||||
- As a user importing anime or other shifted numbering schemes, I want season and episode offsets at the show level with optional pattern-specific overrides so that generated filenames align with TMDB and media-library expectations.
|
||||
|
||||
## Functional Requirements
|
||||
|
||||
- The system shall provide a CLI entrypoint named `ffx` with commands for `convert`, `inspect`, `shows`, `rename`, `unmux`, `cropdetect`, `setup`, `configure_workstation`, `upgrade`, `version`, and `help`.
|
||||
- The system shall support a two-step local installation and preparation flow:
|
||||
- `tools/setup.sh` is the bootstrap entrypoint for the first step and shall own bundle virtualenv creation, package installation, shell alias exposure, and optional Python test-package installation.
|
||||
- `tools/configure_workstation.sh` is the bootstrap entrypoint for the second step and shall own workstation dependency checks and installation plus local config and directory seeding.
|
||||
- After the bundle is installed, `ffx setup` and `ffx configure_workstation` shall remain aligned wrapper entrypoints for those same two steps.
|
||||
- The CLI command `ffx setup` shall act as a wrapper for the first-step bundle-preparation flow in `tools/setup.sh`.
|
||||
- The CLI command `ffx configure_workstation` shall act as a wrapper for the second-step preparation flow in `tools/configure_workstation.sh`.
|
||||
- The system shall persist reusable normalization rules in SQLite for:
|
||||
- shows and show formatting digits,
|
||||
- optional show-level notes,
|
||||
- optional show-level quality defaults,
|
||||
- regex-based filename patterns,
|
||||
- per-pattern media tags,
|
||||
- per-pattern stream definitions,
|
||||
- show-level and pattern-level shifted-season mappings,
|
||||
- internal database version properties.
|
||||
- The system shall apply supported ordered database migrations automatically when opening an older local database file and shall fail fast when no supported path exists.
|
||||
- Before applying a required database migration, the system shall show the current version, target version, required sequential steps, and whether each corresponding migration module is present, then require user confirmation.
|
||||
- Before applying a confirmed file-backed database migration, the system shall create an in-place backup copy whose filename includes the covered version range.
|
||||
- Detailed show, pattern, and duplicate-match management rules live in `requirements/pattern_management.md`.
|
||||
- The system shall inspect source media using `ffprobe` and derive a structured description of container metadata and streams.
|
||||
- The system shall optionally open a Textual UI to browse shows, inspect files, and create, edit, or delete shows, patterns, stream definitions, tags, and shifted-season rules.
|
||||
- The system shall match filenames against stored regex patterns to decide whether an input file should inherit a target stream and metadata schema.
|
||||
- The system shall convert supported input files (`mkv`, `mp4`, `avi`, `flv`, `webm`) with `ffmpeg`, supporting at least:
|
||||
- VP9, AV1, and H.264 video encoding,
|
||||
- Opus audio encoding with bitrate selection based on channel layout,
|
||||
- metadata and disposition rewriting,
|
||||
- optional crop detection and crop application,
|
||||
- optional deinterlacing and denoising,
|
||||
- optional subtitle import from external files,
|
||||
- rename-only move mode.
|
||||
- The system shall support optional TMDB lookups to resolve show names, years, and episode titles when a show ID, season, and episode are available.
|
||||
- The system shall generate output filenames from show metadata, season and episode indices, and episode names using the configured filename template.
|
||||
- The system shall allow CLI overrides for stream languages, stream titles, default and forced tracks, stream order, TMDB show and episode data, output directory, label prefix, and processing resource limits.
|
||||
- The system shall resolve encoding quality by precedence `CLI override -> pattern -> show -> encoder default` and shall report the chosen value and source.
|
||||
- The system shall resolve season shifting by precedence `pattern -> show -> identity default` and shall report the chosen mapping and source.
|
||||
- Processing resource limit rules:
|
||||
- `--nice` shall accept niceness values from `-20` through `19`; omitting the option shall disable niceness adjustment.
|
||||
- `--cpu` shall accept either a positive absolute `cpulimit` value such as `200`, or a percentage suffixed with `%` such as `25%` to represent a share of present CPUs; omitting the option or using `0` shall disable CPU limiting.
|
||||
- When both limits are configured, the process wrapper shall execute the target command through `cpulimit` around a `nice -n ...` invocation so both limits apply to the launched media command.
|
||||
- The system shall support extracting streams into separate files via `unmux` and reporting suggested crop parameters via `cropdetect`.
|
||||
- The system shall support in-place episode renaming via `rename`, requiring a `--prefix`, accepting optional `--season` and `--suffix` overrides, preserving the source extension, and supporting dry-run output without moving files.
|
||||
- Crop detection shall use a configurable sampling window, defaulting to a 60-second seek and a 180-second analysis duration, and repeated crop-detection requests for the same source plus sampling window shall reuse cached results within one process.
|
||||
- The system shall handle invalid input and system failures gracefully by logging warnings or raising `click` errors for missing files, invalid media, missing TMDB credentials, incompatible database versions, and ambiguous track dispositions when prompting is disabled.
|
||||
|
||||
## Quality Requirements
|
||||
|
||||
- The system should stay understandable as a small local tool: controllers, descriptors, models, and screens should remain separate enough for contributors to trace a workflow end to end.
|
||||
- The system should produce predictable output for the same database rules, CLI overrides, and source files.
|
||||
- The system should preserve a lightweight operational footprint: local SQLite state, local log file, no mandatory background services.
|
||||
- The system should be testable through modern automatically discovered tests and through remaining legacy harness coverage during migration.
|
||||
- The system should expose enough logging to diagnose failed probes, failed conversions, and rule mismatches without requiring a debugger.
|
||||
|
||||
## Constraints And Assumptions
|
||||
|
||||
- Technology constraints:
|
||||
- Python package built with setuptools.
|
||||
- Primary libraries: `click`, `textual`, `sqlalchemy`, `jinja2`, `requests`.
|
||||
- Conversion and inspection rely on external executables rather than pure-Python media libraries.
|
||||
- Hosting or infrastructure constraints:
|
||||
- Intended for local execution, not server deployment.
|
||||
- Stores default state in `~/.local/etc/ffx.json`, `~/.local/var/ffx/ffx.db`, and `~/.local/var/log/ffx.log`.
|
||||
- Timeline constraints:
|
||||
- The current implemented scope reflects a compact alpha release stream up to version `0.2.5`.
|
||||
- Team capacity assumptions:
|
||||
- Maintained as a small codebase where simple patterns and direct controller logic are preferred over framework-heavy abstractions.
|
||||
- Third-party dependencies:
|
||||
- `ffmpeg`, `ffprobe`, and `cpulimit`.
|
||||
- TMDB API access through `TMDB_API_KEY` for metadata enrichment.
|
||||
- Installation assumptions:
|
||||
- The Python-side bundle install step and optional Python test extras are managed by `tools/setup.sh`, with `ffx setup` as the aligned wrapper after bootstrap.
|
||||
- The workstation-preparation step is managed separately by `tools/configure_workstation.sh` or `ffx configure_workstation`.
|
||||
|
||||
## Acceptance Scope
|
||||
|
||||
- First release boundary:
|
||||
- Local installation through `pip`.
|
||||
- Working SQLite-backed rule storage.
|
||||
- Functional CLI conversion and inspection workflows.
|
||||
- Textual CRUD flows for shows, patterns, tags, tracks, and shifted seasons.
|
||||
- TMDB-assisted filename generation, subtitle import, season shifting, database versioning, and configurable output filename templating.
|
||||
- Excluded follow-up ideas:
|
||||
- Completing placeholder screens such as settings and help.
|
||||
- Hardening platform portability beyond Linux-like systems.
|
||||
- Broader media types, richer release packaging, and production-grade background processing.
|
||||
- Demonstration scenario:
|
||||
- Inspect a TV episode file, define or update the matching show and pattern in the TUI, then run `ffx convert` so the result uses the stored stream schema, optional TMDB episode naming, and a normalized output filename.
|
||||
@@ -1,177 +0,0 @@
|
||||
# Shifted Seasons Handling
|
||||
|
||||
This file defines the behavioral contract for mapping source season and episode
|
||||
numbering to target season and episode numbering through stored shifted-season
|
||||
rules.
|
||||
|
||||
Primary sources:
|
||||
- `requirements/project.md`
|
||||
- `requirements/architecture.md`
|
||||
- actual tool code in `src/ffx/`
|
||||
|
||||
Secondary source:
|
||||
- `SCRATCHPAD.md`, used only to clarify current hardening gaps and not as the
|
||||
primary contract source.
|
||||
|
||||
## Scope
|
||||
|
||||
- Persisting shifted-season rules in SQLite.
|
||||
- Allowing shifted-season rules to be attached either to a show or to a
|
||||
specific pattern.
|
||||
- Selecting at most one active shifted-season rule for one concrete source
|
||||
season and episode tuple.
|
||||
- Applying additive season and episode offsets to produce target numbering.
|
||||
- Using shifted target numbering during `convert` for TMDB episode lookup and
|
||||
generated season and episode filename tokens.
|
||||
- Managing show-level default mappings and pattern-level override mappings from
|
||||
the Textual editing workflows.
|
||||
|
||||
## Out Of Scope
|
||||
|
||||
- General filename parsing rules for detecting season and episode values.
|
||||
- Standalone `rename` command behavior, which currently uses explicit rename
|
||||
inputs rather than stored shifted-season rules.
|
||||
- Stream or track mapping behavior unrelated to season and episode numbering.
|
||||
|
||||
## Terms
|
||||
|
||||
- `shifted-season rule`: one persisted row describing how one source-numbering
|
||||
range maps to target numbering through additive offsets.
|
||||
- `show-level shifted-season rule`: a rule attached directly to a show and used
|
||||
as the fallback mapping layer for that show.
|
||||
- `pattern-level shifted-season rule`: a rule attached directly to a pattern and
|
||||
used as the override mapping layer for that pattern.
|
||||
- `source numbering`: the season and episode values detected from the current
|
||||
source file or supplied as source-side conversion inputs before shifting.
|
||||
- `target numbering`: the season and episode values after one active
|
||||
shifted-season rule has been applied.
|
||||
- `original season`: the source-domain season number a shifted-season rule is
|
||||
eligible to match.
|
||||
- `episode range`: the optional source-domain episode interval covered by one
|
||||
shifted-season rule.
|
||||
- `open bound`: an unbounded start or end of the episode range. Current storage
|
||||
uses `-1` as the internal sentinel for an open bound.
|
||||
- `active shifted-season rule`: the single rule selected for one concrete input
|
||||
after precedence resolution.
|
||||
- `identity mapping`: the default `1:1` outcome where source numbering is used
|
||||
unchanged.
|
||||
|
||||
## Rules
|
||||
|
||||
- `SHIFTED_SEASONS_HANDLING-0001`: The domain model shall allow a
|
||||
shifted-season rule to be owned by exactly one of:
|
||||
- one show
|
||||
- one pattern
|
||||
- `SHIFTED_SEASONS_HANDLING-0002`: A single shifted-season rule shall not
|
||||
belong to both a show and a pattern at the same time.
|
||||
- `SHIFTED_SEASONS_HANDLING-0003`: A shifted-season rule shall carry these
|
||||
fields: `original_season`, `first_episode`, `last_episode`,
|
||||
`season_offset`, and `episode_offset`.
|
||||
- `SHIFTED_SEASONS_HANDLING-0004`: `season_offset` and `episode_offset` shall
|
||||
be additive signed integers applied to matched source numbering to produce
|
||||
target numbering.
|
||||
- `SHIFTED_SEASONS_HANDLING-0005`: A shifted-season rule shall match a source
|
||||
tuple only when:
|
||||
- the source season equals `original_season`
|
||||
- the source episode is greater than or equal to `first_episode` when the
|
||||
lower bound is closed
|
||||
- the source episode is less than or equal to `last_episode` when the upper
|
||||
bound is closed
|
||||
- `SHIFTED_SEASONS_HANDLING-0006`: An open lower or upper episode bound shall
|
||||
represent an unbounded side of the covered source episode range.
|
||||
- `SHIFTED_SEASONS_HANDLING-0007`: If one shifted-season rule matches, target
|
||||
numbering shall be:
|
||||
- `target season = source season + season_offset`
|
||||
- `target episode = source episode + episode_offset`
|
||||
- `SHIFTED_SEASONS_HANDLING-0008`: If no shifted-season rule matches, source
|
||||
numbering shall pass through unchanged.
|
||||
- `SHIFTED_SEASONS_HANDLING-0009`: Shifted-season handling shall operate in a
|
||||
source-to-target numbering model. Stored rules map detected source numbering
|
||||
to the target numbering used by conversion-facing metadata and output naming.
|
||||
- `SHIFTED_SEASONS_HANDLING-0010`: Pattern matching identifies the owning show
|
||||
and optionally a more specific owning pattern. Resolution of the active
|
||||
shifted-season rule shall use this precedence order:
|
||||
- matching pattern-level rule
|
||||
- matching show-level rule
|
||||
- identity mapping
|
||||
- `SHIFTED_SEASONS_HANDLING-0011`: At most one shifted-season rule may be
|
||||
active for one concrete source season and episode tuple. Shifted-season rules
|
||||
shall never stack or compose.
|
||||
- `SHIFTED_SEASONS_HANDLING-0012`: Within one owner scope, shifted-season rules
|
||||
shall not overlap in their effective episode coverage for the same
|
||||
`original_season`.
|
||||
- `SHIFTED_SEASONS_HANDLING-0013`: If a shifted-season rule uses two closed
|
||||
episode bounds, `last_episode` shall be greater than or equal to
|
||||
`first_episode`.
|
||||
- `SHIFTED_SEASONS_HANDLING-0014`: Shifted-season rule evaluation shall be
|
||||
deterministic. Released behavior shall not depend on arbitrary database row
|
||||
order when invalid overlapping rules exist.
|
||||
- `SHIFTED_SEASONS_HANDLING-0015`: A pattern-level rule is permitted to map to
|
||||
zero offsets. Such a rule is a valid explicit override that beats show-level
|
||||
fallback and produces identity mapping for its covered source range.
|
||||
- `SHIFTED_SEASONS_HANDLING-0016`: During `convert`, when show, season, and
|
||||
episode values are available and stored shifting is active, the shifted target
|
||||
numbering shall drive:
|
||||
- TMDB episode lookup
|
||||
- season and episode filename tokens such as `S01E02`
|
||||
- generated episode basenames that include season and episode numbering
|
||||
- `SHIFTED_SEASONS_HANDLING-0017`: When conversion is supplied explicit
|
||||
target-domain season or episode values for TMDB naming, the system shall not
|
||||
apply stored shifting on top of those already-targeted values.
|
||||
- `SHIFTED_SEASONS_HANDLING-0018`: Operator-facing editing shall expose
|
||||
shifted-season rule management in both of these places:
|
||||
- show editing for show-level default mappings
|
||||
- pattern editing for pattern-level override mappings
|
||||
- `SHIFTED_SEASONS_HANDLING-0019`: User-facing shifted-season editing should
|
||||
present open episode bounds as a natural empty-state input rather than forcing
|
||||
operators to type the internal sentinel directly.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- A show can exist with zero or more show-level shifted-season rules.
|
||||
- A pattern can exist with zero or more pattern-level shifted-season rules.
|
||||
- A shifted-season rule is stored against exactly one owner scope.
|
||||
- A source tuple matching a pattern-level rule yields target numbering from that
|
||||
rule even when a matching show-level rule also exists.
|
||||
- A source tuple matching no pattern-level rule but matching a show-level rule
|
||||
yields target numbering from the show-level rule.
|
||||
- A source tuple matching neither scope yields identity mapping.
|
||||
- A pattern-level zero-offset rule can explicitly override a nonzero show-level
|
||||
rule for the same covered source range.
|
||||
- Two shifted-season rules for the same owner scope and original season cannot
|
||||
both be valid if they cover overlapping episode ranges.
|
||||
- During `convert`, shifted numbering is what TMDB episode lookup and generated
|
||||
season and episode tokens see when stored shifting is active.
|
||||
- The TUI can display and maintain shifted-season rules from both the show and
|
||||
pattern editing flows.
|
||||
|
||||
## Current Code Fit
|
||||
|
||||
- `src/ffx/model/show.py` and `src/ffx/model/pattern.py` now both expose
|
||||
shifted-season relationships, and `src/ffx/model/shifted_season.py` stores
|
||||
each rule against exactly one owner scope through `show_id` or `pattern_id`.
|
||||
- `src/ffx/shifted_season_controller.py` now resolves mappings with
|
||||
pattern-over-show precedence and applies at most one active rule for a source
|
||||
tuple.
|
||||
- `src/ffx/show_details_screen.py`,
|
||||
`src/ffx/shifted_season_details_screen.py`, and
|
||||
`src/ffx/shifted_season_delete_screen.py` provide reusable shifted-season
|
||||
editing dialogs, and `src/ffx/pattern_details_screen.py` now exposes the
|
||||
pattern-level override flow.
|
||||
- `src/ffx/cli.py` now resolves shifted numbering during `convert` from:
|
||||
pattern-level match, then show-level match, then identity mapping.
|
||||
- `src/ffx/database.py` now migrates version-2 databases to version 3 by
|
||||
preserving existing show-level rows and extending the schema for pattern-level
|
||||
ownership.
|
||||
|
||||
## Risks
|
||||
|
||||
- The current CLI groups `--show`, `--season`, and `--episode` under one
|
||||
override bucket used for TMDB-related behavior. Source-domain versus
|
||||
target-domain semantics of each override must stay documented clearly so
|
||||
stored shifting is neither skipped nor double-applied unexpectedly.
|
||||
- Existing version-2 databases only contain show-owned shifted-season rows, so a
|
||||
version-3 migration must preserve those rows as the show-level fallback layer.
|
||||
- Current modern automated test coverage for shifted-season behavior is light,
|
||||
so precedence, migration, and convert-time numbering behavior need focused
|
||||
tests.
|
||||
@@ -1,74 +0,0 @@
|
||||
# Subtrack Mapping
|
||||
|
||||
This file defines the behavioral contract for mapping input subtracks to output
|
||||
subtracks during conversion.
|
||||
|
||||
Primary source: actual tool code in `src/ffx/`.
|
||||
Secondary source: `tests/legacy/`, used only to clarify intent and reveal gaps.
|
||||
|
||||
## Scope
|
||||
|
||||
- Ensuring each target subtrack is created from the corresponding source-subtrack information, including stream-level metadata.
|
||||
- Mapping input streams to output streams during conversion.
|
||||
- Using persisted pattern-track definitions from the database as the target schema.
|
||||
- Allowing omission and reordering of retained tracks.
|
||||
- Keeping stream-level metadata attached to the correct source-derived logical track after remapping.
|
||||
- Normalizing target output into ordered track groups: video, audio, subtitle, then special types such as fonts or images.
|
||||
|
||||
## Terms
|
||||
|
||||
- `source_index`: identity of the originating input stream from ffprobe or an imported source descriptor.
|
||||
- `index`: final output-track order across all retained tracks.
|
||||
- `sub_index`: per-type position within the retained tracks of one type, for example audio stream `0` or subtitle stream `1`.
|
||||
- `target schema`: stored or constructed output-track definition that decides which tracks are kept, omitted, reordered, and rewritten.
|
||||
- `separate source file`: additional file bound to one target track slot whose media payload replaces the regular source payload for that slot.
|
||||
|
||||
## Rules
|
||||
|
||||
- `SUBTRACK_MAPPING-0001`: The system shall represent source-stream identity separately from output order. `source_index`, `index`, and `sub_index` are distinct concepts and shall not be collapsed into one field.
|
||||
- `SUBTRACK_MAPPING-0002`: The system shall derive `source_index` for probed tracks from the original ffprobe stream index and preserve that identity through conversion planning.
|
||||
- `SUBTRACK_MAPPING-0003`: Pattern-backed track definitions stored in the database shall persist both target output order and originating source-stream identity.
|
||||
- `SUBTRACK_MAPPING-0004`: When a filename matches a pattern, the pattern target schema shall be the source of truth for which source tracks are retained, which are omitted, and in what order retained tracks appear in the output.
|
||||
- `SUBTRACK_MAPPING-0005`: A target track may refer only to an existing source track of the same type. Conversion shall fail fast when a target track refers to a nonexistent source stream or a source stream of a different type.
|
||||
- `SUBTRACK_MAPPING-0006`: The ffmpeg mapping phase shall be generated from target output order while resolving each retained output track back to its originating source stream via `source_index`.
|
||||
- `SUBTRACK_MAPPING-0007`: Reordering and omission shall preserve logical track identity. Stream-level metadata, titles, languages, and disposition decisions shall stay attached to the correct source-derived logical track after mapping.
|
||||
- `SUBTRACK_MAPPING-0008`: The system shall support one-off CLI stream-order overrides without requiring prior database edits.
|
||||
- `SUBTRACK_MAPPING-0009`: Operator-facing inspection and editing surfaces shall expose enough source-versus-target information to let a user reason about subtrack mapping decisions.
|
||||
- `SUBTRACK_MAPPING-0010`: Test coverage for subtrack mapping shall assert source-derived identity, omission, and output order explicitly. Final track counts or final type sequences alone are insufficient proof of correct mapping.
|
||||
- `SUBTRACK_MAPPING-0011`: Retained target tracks shall appear in ordered groups: video track or tracks first, then audio tracks, then subtitle tracks, then special types such as fonts or images. Within each group, the target schema shall define the order.
|
||||
- `SUBTRACK_MAPPING-0012`: Track omission is valid when required by output compatibility, when needed to normalize source tracks into the required target group order and schema, or when explicitly requested by database rules or CLI options.
|
||||
- `SUBTRACK_MAPPING-0013`: If source tracks do not already comply with the required target group order, conversion shall reorder retained tracks to match the target ordering contract without losing source-track identity or stream-level metadata lineage.
|
||||
|
||||
## Separate Additional Source Files
|
||||
|
||||
- `SUBTRACK_MAPPING-0014`: A separate source file may substitute the media payload of one target subtrack without changing that target track's intended output position.
|
||||
- `SUBTRACK_MAPPING-0015`: When a separate source file is used, the target track shall remain bound to the corresponding logical source track for mapping, validation, and metadata lineage.
|
||||
- `SUBTRACK_MAPPING-0016`: Metadata for a substituted target track shall be merged from the regular source track and the separate source file when available.
|
||||
- `SUBTRACK_MAPPING-0017`: If the separate source file provides a metadata field that is also present on the regular source track, the separate source file value shall win in the target output.
|
||||
- `SUBTRACK_MAPPING-0018`: If a metadata field is absent from the separate source file, the system shall fall back to the corresponding metadata from the regular source track or target schema rewrite rules.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- Given a source media descriptor and a pattern-backed target schema, the planned output tracks can be listed in final output order and each retained track can still be traced to one originating source stream.
|
||||
- Planned output order follows grouped target order: video, audio, subtitle, then special types.
|
||||
- Tracks not referenced by the target schema are omitted from output mapping.
|
||||
- Tracks may also be omitted when they are incompatible with the chosen output format or explicitly excluded by database or CLI rules.
|
||||
- Two retained target tracks never originate from the same source stream unless duplication is implemented explicitly as a separate feature.
|
||||
- If target-track metadata is rewritten after reordering, it is written onto the correct source-derived logical track rather than the track that merely occupies the same final output position.
|
||||
- Invalid target-to-source references fail deterministically before the conversion job is launched.
|
||||
- If a separate source file substitutes one target track, that track keeps its target slot and ordering while metadata is merged with separate-file values taking precedence when both sides provide the same field.
|
||||
- A test proving subtrack mapping must assert at least one of: exact `source_index` to output-order mapping, omission of named source tracks, or preservation of per-track metadata after reorder.
|
||||
|
||||
## Test Notes
|
||||
|
||||
- `tests/legacy/scenario.py` names pattern behavior as `Filter/Reorder Tracks`.
|
||||
- `tests/legacy/scenario_4.py` is the strongest end-to-end signal because it runs DB-backed conversion and reapplies source indices before assertion.
|
||||
- `tests/legacy/track_tag_combinator_2_0.py` and `tests/legacy/track_tag_combinator_3_4.py` sort result tracks by `source_index` before checking tags, which matches the intended identity model.
|
||||
- Legacy permutation combinators define permutations but their assertion functions are stubs.
|
||||
- Some legacy scenarios produce `AP` and `SP` selectors but do not execute them.
|
||||
|
||||
## Risks
|
||||
|
||||
- `src/ffx/media_descriptor.py` contains an explicit `rearrangeTrackDescriptors()` path whose current implementation appears defective and under-tested.
|
||||
- Separate-source-file metadata precedence is only partly expressed in current implementation paths and should be covered directly in the rewritten test suite.
|
||||
- Production code expresses the mapping contract more clearly than the legacy harness, so a rewrite should add direct logic-level tests for mapping and reorder planning.
|
||||
@@ -1,144 +0,0 @@
|
||||
# Test Rewrite
|
||||
|
||||
This file captures the structure executed by `tests/legacy_runner.py` today and
|
||||
defines the target shape for a complete rewrite.
|
||||
|
||||
Detailed product rules for source-to-target subtrack mapping live in
|
||||
`requirements/subtrack_mapping.md`. This file describes only how tests cover
|
||||
that area.
|
||||
|
||||
## Interpreter Requirement
|
||||
|
||||
- Agents shall run Python-side test commands with `~/.local/share/ffx.venv/bin/python`.
|
||||
- This applies to the legacy harness, `unittest`, `pytest`, helper scripts, and `python -m ffx ...` test invocations.
|
||||
- Agents shall not silently substitute `python`, `python3`, or another interpreter for Python-side test work.
|
||||
- If `~/.local/share/ffx.venv/bin/python` is missing or not executable, agents shall stop and report the missing venv instead of continuing with Python-side test execution.
|
||||
|
||||
## Shell Environment Requirement
|
||||
|
||||
- Agents shall source `~/.bashrc` from an interactive Bash shell before running TMDB-dependent test commands or TMDB-dependent `python -m ffx ...` test invocations.
|
||||
- Agents shall not source `~/.bashrc.d/interactive/77_tmdb.sh` directly for normal test work; `~/.bashrc` is the required entry point.
|
||||
- In automation this means agents shall use an interactive Bash invocation such as `bash -ic 'source ~/.bashrc && ...'`, because a non-interactive `bash -lc` returns from `~/.bashrc` before the interactive fragments are loaded.
|
||||
- If sourcing `~/.bashrc` still does not provide required shell environment such as `TMDB_API_KEY`, agents shall stop and report the missing environment instead of continuing with TMDB-dependent test execution.
|
||||
|
||||
## Current Harness
|
||||
|
||||
- Entrypoint: `~/.local/share/ffx.venv/bin/python tests/legacy_runner.py run`
|
||||
- Runner style: custom Click CLI, not `pytest` or `unittest`
|
||||
- Commands:
|
||||
- `run`: discover scenario files, instantiate each scenario, run yielded jobs
|
||||
- `dupe`: helper command that creates duplicate media fixtures; not part of the test run
|
||||
- Filters: `--scenario`, `--variant`, `--limit`
|
||||
- Shared context:
|
||||
- builds one mutable dict for the whole run
|
||||
- installs loggers and writes `ffx_test_report.log`
|
||||
- creates `ConfigurationController` eagerly
|
||||
- tracks only passed and failed counters
|
||||
- Discovery:
|
||||
- scenario files: `tests/legacy/scenario_*.py`
|
||||
- combinators: `glob + importlib + inspect` by filename convention
|
||||
- ordering: implicit glob order, no explicit sorting
|
||||
- Skip behavior:
|
||||
- Scenario 4 is skipped when `TMDB_API_KEY` is missing
|
||||
- only `TMDB_API_KEY_NOT_PRESENT_EXCEPTION` is caught at scenario construction time
|
||||
|
||||
## Current Scenarios
|
||||
|
||||
- `1`: `tests/legacy/scenario_1.py`
|
||||
- focus: basename generation without pattern lookup or TMDB
|
||||
- inputs per job: `1`
|
||||
- jobs: `140`
|
||||
- expected failures: `0`
|
||||
- execution: build one synthetic source file, run `~/.local/share/ffx.venv/bin/python -m ffx convert`, assert filename selectors only
|
||||
- selectors executed: `B`, `L`, `I`
|
||||
- selectors defined but not executed: `S`, `R`
|
||||
- `2`: `tests/legacy/scenario_2.py`
|
||||
- focus: conversion matrix over media layouts, dispositions, tags, and permutations
|
||||
- inputs per job: `1`
|
||||
- jobs: `8193`
|
||||
- expected failures: `3267`
|
||||
- execution: build one synthetic source file, run `~/.local/share/ffx.venv/bin/python -m ffx convert`, probe result with `FileProperties`, assert track layout and selected audio and subtitle metadata
|
||||
- selectors executed: `M`, `AD`, `AT`, `SD`, `ST`
|
||||
- selectors defined but not executed: `MT`, `AP`, `SP`, `J`
|
||||
- `4`: `tests/legacy/scenario_4.py`
|
||||
- focus: pattern-driven batch conversion with SQLite state and live TMDB naming
|
||||
- inputs per job: `6`
|
||||
- jobs: `768`
|
||||
- expected failures: `336`
|
||||
- execution: build six synthetic preset files, recreate temp SQLite DB, insert show and pattern, run one batch convert command via `~/.local/share/ffx.venv/bin/python`, query TMDB during assertions
|
||||
- selectors executed: `M`, `AD`, `AT`, `SD`, `ST`
|
||||
- selectors defined but not executed: `MT`, `AP`, `SP`, `J`
|
||||
- notes:
|
||||
- uses `MediaCombinator6` only
|
||||
- issues live HTTP requests through `TmdbController` with no request cache
|
||||
|
||||
## Current Combinator Families
|
||||
|
||||
- scenario files discovered: `3`
|
||||
- basename combinators discovered: `2`
|
||||
- media combinators discovered: `8`
|
||||
- media tag combinators discovered: `3`
|
||||
- disposition combinator 2 variants: `4`
|
||||
- disposition combinator 3 variants: `5`
|
||||
- track tag combinator 2 variants: `4`
|
||||
- track tag combinator 3 variants: `5`
|
||||
- indicator variants: `7`
|
||||
- label variants: `2`
|
||||
- show variants: `3`
|
||||
- release variants: `3`
|
||||
- permutation 2 variants: `2`
|
||||
- permutation 3 variants: `3`
|
||||
|
||||
## Current Totals
|
||||
|
||||
- full run without TMDB: `8333`
|
||||
- full run with TMDB: `9101`
|
||||
- Scenario 4 generated source files: `4608`
|
||||
- Scenario 4 live TMDB episode queries: `4608`
|
||||
|
||||
## Current Behavior Areas
|
||||
|
||||
- output basename rules for label, season and episode indicator, show name, and release suffix combinations
|
||||
- track layout normalization across the eight media combinator shapes from `VA` through `VAASSS`
|
||||
- two-track and three-track disposition edge cases, including intentional failure cases
|
||||
- two-track and three-track track-tag preservation checks, including checks that sort results by source identity
|
||||
- container-level media tag handling
|
||||
- pattern-backed conversion against a temporary SQLite database
|
||||
- TMDB-assisted episode naming for batch conversion
|
||||
|
||||
## Structural Findings
|
||||
|
||||
- The suite is process-heavy: most jobs run `ffmpeg` to generate a fixture and then spawn the FFX CLI as a subprocess.
|
||||
- The suite is integration-first and has almost no isolated unit-level coverage for pure logic.
|
||||
- The base `Combinator` class is a placeholder and is not the real abstraction boundary used by the suite.
|
||||
- Many combinator methods are placeholders: there are `25` `pass` statements across the current test modules.
|
||||
- Several assertion families are never executed because scenario selector dispatch is incomplete.
|
||||
- Scenario comments mention a Scenario 3, but no `scenario_3.py` exists.
|
||||
- `tests/legacy/_basename_combinator_1.py` is effectively orphaned because discovery only matches `basename_combinator_*.py`.
|
||||
- `tests/legacy/disposition_combinator_2_3 .py` contains an embedded space in the filename and is still part of discovery.
|
||||
- Expected failures are validated only as subprocess return-code matches, not as specific error types or messages.
|
||||
- The current suite depends on `ffmpeg`, `ffprobe`, SQLite, the local Python environment, and for Scenario 4 a live TMDB API key plus network access.
|
||||
|
||||
## Rewrite Target
|
||||
|
||||
- Replace the custom Click harness with a standard test runner, preferably `pytest`.
|
||||
- Split the suite into explicit layers: unit, integration, and optional external-system tests.
|
||||
- Keep unit tests as the default path and make them runnable without `ffmpeg`, `ffprobe`, TMDB, or a user config directory.
|
||||
- Model discovery explicitly in code instead of relying on glob-plus-reflection naming conventions.
|
||||
- Convert the current Cartesian-product combinators into readable parametrized cases grouped by behavior area.
|
||||
- Preserve the current behavior areas, but represent them with targeted cases instead of thousands of opaque variant IDs.
|
||||
- Make every assertion family explicit and executable; there must be no selector that is produced but never consumed.
|
||||
- Replace live TMDB access with fixtures or mocks in normal runs; any live-contract test must be opt-in.
|
||||
- Replace ad hoc subprocess return-code checks with assertions on typed exceptions, stderr content, or structured outputs.
|
||||
- Provide small reusable media fixtures or fixture builders so only a narrow integration slice needs `ffmpeg`-generated media.
|
||||
- Make database tests self-contained and fast through temporary databases and direct controller-level assertions.
|
||||
- Make ordering, naming, and selection deterministic so a contributor can predict exactly what will run.
|
||||
- Expose a small smoke suite for quick local runs and CI, plus a separately marked slower integration suite.
|
||||
- Prefer domain-oriented test modules over combinator-family modules: basename, pattern matching, metadata rewrite, track ordering, TMDB naming, CLI smoke, and failure handling.
|
||||
|
||||
## Rewrite Acceptance
|
||||
|
||||
- A default local test run finishes quickly and without network access.
|
||||
- A contributor can identify which behavior a failing test covers without decoding variant strings like `VAASSS-A:D10-S:T001`.
|
||||
- All current intended failure behaviors remain covered, but each one is asserted directly and readably.
|
||||
- The rewritten suite can be adopted by CI without requiring live TMDB credentials.
|
||||
@@ -461,50 +461,13 @@ def upgrade(ctx, branch):
|
||||
|
||||
@ffx.command()
|
||||
@click.pass_context
|
||||
@click.option('--shift', is_flag=True, default=False, help='Print resolved season-shift mapping for each file instead of opening the TUI')
|
||||
@click.argument('filenames', nargs=-1)
|
||||
def inspect(ctx, shift, filenames):
|
||||
if not filenames:
|
||||
raise click.ClickException("At least one filename is required.")
|
||||
|
||||
if shift:
|
||||
from ffx.file_properties import FileProperties
|
||||
from ffx.shifted_season_controller import ShiftedSeasonController
|
||||
|
||||
shiftedSeasonController = ShiftedSeasonController(ctx.obj)
|
||||
|
||||
for filename in filenames:
|
||||
fileProperties = FileProperties(ctx.obj, filename)
|
||||
season = fileProperties.getSeason()
|
||||
episode = fileProperties.getEpisode()
|
||||
|
||||
if season == -1 or episode == -1:
|
||||
click.echo(f"{filename}: no season/episode recognized")
|
||||
continue
|
||||
|
||||
currentPattern = fileProperties.getPattern()
|
||||
shiftedSeason, shiftedEpisode, sourceLabel = shiftedSeasonController.resolveShiftSeason(
|
||||
fileProperties.getShowId(),
|
||||
season=season,
|
||||
episode=episode,
|
||||
patternId=currentPattern.getId() if currentPattern is not None else None,
|
||||
)
|
||||
if shiftedSeason == season and shiftedEpisode == episode:
|
||||
click.echo(f"{filename}: none")
|
||||
else:
|
||||
click.echo(
|
||||
f"{filename}: {season}/{episode} -> {shiftedSeason}/{shiftedEpisode} from {sourceLabel}"
|
||||
)
|
||||
return
|
||||
|
||||
if len(filenames) != 1:
|
||||
raise click.ClickException("Inspect without --shift requires exactly one filename.")
|
||||
|
||||
@click.argument('filename', nargs=1)
|
||||
def inspect(ctx, filename):
|
||||
from ffx.ffx_app import FfxApp
|
||||
|
||||
ctx.obj['command'] = 'inspect'
|
||||
ctx.obj['arguments'] = {}
|
||||
ctx.obj['arguments']['filename'] = filenames[0]
|
||||
ctx.obj['arguments']['filename'] = filename
|
||||
|
||||
app = FfxApp(ctx.obj)
|
||||
app.run()
|
||||
|
||||
@@ -8,9 +8,10 @@ from ffx.audio_layout import AudioLayout
|
||||
|
||||
from .show_details_screen import ShowDetailsScreen
|
||||
from .pattern_details_screen import PatternDetailsScreen
|
||||
from .screen_support import build_screen_bootstrap, build_screen_controllers, populate_tag_table
|
||||
from .screen_support import build_screen_bootstrap, build_screen_controllers
|
||||
|
||||
from ffx.track_type import TrackType
|
||||
from ffx.track_codec import TrackCodec
|
||||
from ffx.model.track import Track
|
||||
|
||||
from ffx.track_disposition import TrackDisposition
|
||||
@@ -24,7 +25,7 @@ from ffx.file_properties import FileProperties
|
||||
|
||||
from ffx.media_descriptor_change_set import MediaDescriptorChangeSet
|
||||
|
||||
from ffx.helper import DIFF_ADDED_KEY, DIFF_CHANGED_KEY, DIFF_REMOVED_KEY, DIFF_UNCHANGED_KEY
|
||||
from ffx.helper import formatRichColor, DIFF_ADDED_KEY, DIFF_CHANGED_KEY, DIFF_REMOVED_KEY, DIFF_UNCHANGED_KEY
|
||||
|
||||
|
||||
# Screen[dict[int, str, int]]
|
||||
@@ -155,9 +156,6 @@ class MediaDetailsScreen(Screen):
|
||||
raise click.ClickException(f"MediaDetailsScreen.__init__(): Argument 'filename' is required to be provided for command 'inspect'")
|
||||
|
||||
self.__mediaFilename = self.context['arguments']['filename']
|
||||
self.__showRowData: dict[object, ShowDescriptor | None] = {}
|
||||
self.__trackRowData: dict[object, TrackDescriptor] = {}
|
||||
self.__sourceMediaTagRowData: dict[object, tuple[str, str]] = {}
|
||||
|
||||
if not os.path.isfile(self.__mediaFilename):
|
||||
raise click.ClickException(f"MediaDetailsScreen.__init__(): Media file {self.__mediaFilename} does not exist")
|
||||
@@ -169,49 +167,37 @@ class MediaDetailsScreen(Screen):
|
||||
"""Remove show entry from DataTable.
|
||||
Removes the <New show> entry if showId is not set"""
|
||||
|
||||
for row_key, show_descriptor in list(self.__showRowData.items()):
|
||||
if (
|
||||
(showId == -1 and show_descriptor is None)
|
||||
or (
|
||||
show_descriptor is not None
|
||||
and show_descriptor.getId() == showId
|
||||
)
|
||||
):
|
||||
self.showsTable.remove_row(row_key)
|
||||
self.__showRowData.pop(row_key, None)
|
||||
return
|
||||
for rowKey, row in self.showsTable.rows.items(): # dict[RowKey, Row]
|
||||
|
||||
rowData = self.showsTable.get_row(rowKey)
|
||||
|
||||
try:
|
||||
if (showId == -1 and rowData[0] == ' '
|
||||
or showId == int(rowData[0])):
|
||||
self.showsTable.remove_row(rowKey)
|
||||
return
|
||||
except:
|
||||
continue
|
||||
|
||||
|
||||
|
||||
def getRowIndexFromShowId(self, showId : int = -1) -> int:
|
||||
"""Find the index of the row where the value in the specified column matches the target_value."""
|
||||
|
||||
for row_key, show_descriptor in self.__showRowData.items():
|
||||
if (
|
||||
(showId == -1 and show_descriptor is None)
|
||||
or (
|
||||
show_descriptor is not None
|
||||
and show_descriptor.getId() == showId
|
||||
)
|
||||
):
|
||||
return int(self.showsTable.get_row_index(row_key))
|
||||
for rowKey, row in self.showsTable.rows.items(): # dict[RowKey, Row]
|
||||
|
||||
rowData = self.showsTable.get_row(rowKey)
|
||||
|
||||
try:
|
||||
if ((showId == -1 and rowData[0] == ' ')
|
||||
or showId == int(rowData[0])):
|
||||
return int(self.showsTable.get_row_index(rowKey))
|
||||
except:
|
||||
continue
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def _add_show_row(self, show_descriptor: ShowDescriptor | None):
|
||||
if show_descriptor is None:
|
||||
row_key = self.showsTable.add_row(' ', '<New show>', ' ')
|
||||
else:
|
||||
row_key = self.showsTable.add_row(
|
||||
str(show_descriptor.getId()),
|
||||
str(show_descriptor.getName()),
|
||||
str(show_descriptor.getYear()),
|
||||
)
|
||||
self.__showRowData[row_key] = show_descriptor
|
||||
return row_key
|
||||
|
||||
|
||||
def loadProperties(self):
|
||||
|
||||
self.__mediaFileProperties = FileProperties(self.context, self.__mediaFilename)
|
||||
@@ -328,17 +314,23 @@ class MediaDetailsScreen(Screen):
|
||||
def on_mount(self):
|
||||
|
||||
if self.__currentPattern is None:
|
||||
self._add_show_row(None)
|
||||
row = (' ', '<New show>', ' ') # Convert each element to a string before adding
|
||||
self.showsTable.add_row(*map(str, row))
|
||||
|
||||
for show in self.__sc.getAllShows():
|
||||
self._add_show_row(show.getDescriptor(self.context))
|
||||
row = (int(show.id), show.name, show.year) # Convert each element to a string before adding
|
||||
self.showsTable.add_row(*map(str, row))
|
||||
|
||||
self.__sourceMediaTagRowData = populate_tag_table(
|
||||
self.mediaTagsTable,
|
||||
self.__sourceMediaDescriptor.getTags(),
|
||||
ignore_keys=self.__ignoreGlobalKeys,
|
||||
remove_keys=self.__removeGlobalKeys,
|
||||
)
|
||||
for mediaTagKey, mediaTagValue in self.__sourceMediaDescriptor.getTags().items():
|
||||
|
||||
textColor = None
|
||||
if mediaTagKey in self.__ignoreGlobalKeys:
|
||||
textColor = 'blue'
|
||||
if mediaTagKey in self.__removeGlobalKeys:
|
||||
textColor = 'red'
|
||||
|
||||
row = (formatRichColor(mediaTagKey, textColor), formatRichColor(mediaTagValue, textColor)) # Convert each element to a string before adding
|
||||
self.mediaTagsTable.add_row(*map(str, row))
|
||||
|
||||
self.updateTracks()
|
||||
|
||||
@@ -370,7 +362,6 @@ class MediaDetailsScreen(Screen):
|
||||
def updateTracks(self):
|
||||
|
||||
self.tracksTable.clear()
|
||||
self.__trackRowData = {}
|
||||
|
||||
# trackDescriptorList = self.__sourceMediaDescriptor.getAllTrackDescriptors()
|
||||
trackDescriptorList = self.__sourceMediaDescriptor.getTrackDescriptors()
|
||||
@@ -396,8 +387,7 @@ class MediaDetailsScreen(Screen):
|
||||
'Yes' if TrackDisposition.DEFAULT in dispoSet else 'No',
|
||||
'Yes' if TrackDisposition.FORCED in dispoSet else 'No')
|
||||
|
||||
row_key = self.tracksTable.add_row(*map(str, row))
|
||||
self.__trackRowData[row_key] = td
|
||||
self.tracksTable.add_row(*map(str, row))
|
||||
|
||||
typeCounter[trackType] += 1
|
||||
|
||||
@@ -539,7 +529,17 @@ class MediaDetailsScreen(Screen):
|
||||
row_key, col_key = self.tracksTable.coordinate_to_cell_key(self.tracksTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
return self.__trackRowData.get(row_key)
|
||||
selected_track_data = self.tracksTable.get_row(row_key)
|
||||
|
||||
kwargs = {}
|
||||
kwargs[TrackDescriptor.CONTEXT_KEY] = self.context
|
||||
kwargs[TrackDescriptor.INDEX_KEY] = int(selected_track_data[0])
|
||||
kwargs[TrackDescriptor.TRACK_TYPE_KEY] = TrackType.fromLabel(selected_track_data[1])
|
||||
kwargs[TrackDescriptor.SUB_INDEX_KEY] = int(selected_track_data[2])
|
||||
kwargs[TrackDescriptor.CODEC_KEY] = TrackCodec.fromLabel(selected_track_data[3])
|
||||
kwargs[TrackDescriptor.AUDIO_LAYOUT_KEY] = AudioLayout.fromLabel(selected_track_data[4])
|
||||
|
||||
return TrackDescriptor(**kwargs)
|
||||
else:
|
||||
return None
|
||||
|
||||
@@ -554,7 +554,20 @@ class MediaDetailsScreen(Screen):
|
||||
row_key, col_key = self.showsTable.coordinate_to_cell_key(self.showsTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
return self.__showRowData.get(row_key)
|
||||
selected_row_data = self.showsTable.get_row(row_key)
|
||||
|
||||
try:
|
||||
kwargs = {}
|
||||
|
||||
kwargs[ShowDescriptor.CONTEXT_KEY] = self.context
|
||||
kwargs[ShowDescriptor.ID_KEY] = int(selected_row_data[0])
|
||||
kwargs[ShowDescriptor.NAME_KEY] = str(selected_row_data[1])
|
||||
kwargs[ShowDescriptor.YEAR_KEY] = int(selected_row_data[2])
|
||||
|
||||
return ShowDescriptor(**kwargs)
|
||||
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
except CellDoesNotExist:
|
||||
return None
|
||||
@@ -570,7 +583,8 @@ class MediaDetailsScreen(Screen):
|
||||
|
||||
showRowIndex = self.getRowIndexFromShowId(showDescriptor.getId())
|
||||
if showRowIndex is None:
|
||||
self._add_show_row(showDescriptor)
|
||||
show = (showDescriptor.getId(), showDescriptor.getName(), showDescriptor.getYear())
|
||||
self.showsTable.add_row(*map(str, show))
|
||||
|
||||
showRowIndex = self.getRowIndexFromShowId(showDescriptor.getId())
|
||||
if showRowIndex is not None:
|
||||
|
||||
@@ -14,11 +14,7 @@ from .shifted_season_details_screen import ShiftedSeasonDetailsScreen
|
||||
|
||||
from .tag_details_screen import TagDetailsScreen
|
||||
from .tag_delete_screen import TagDeleteScreen
|
||||
from .screen_support import (
|
||||
build_screen_bootstrap,
|
||||
build_screen_controllers,
|
||||
populate_tag_table,
|
||||
)
|
||||
from .screen_support import build_screen_bootstrap, build_screen_controllers
|
||||
|
||||
from ffx.track_type import TrackType
|
||||
|
||||
@@ -32,6 +28,8 @@ from ffx.iso_language import IsoLanguage
|
||||
from ffx.audio_layout import AudioLayout
|
||||
from ffx.model.shifted_season import ShiftedSeason
|
||||
|
||||
from ffx.helper import formatRichColor, removeRichColor
|
||||
|
||||
|
||||
# Screen[dict[int, str, int]]
|
||||
class PatternDetailsScreen(Screen):
|
||||
@@ -132,15 +130,11 @@ class PatternDetailsScreen(Screen):
|
||||
self.__showDescriptor = self.__sc.getShowDescriptor(showId) if showId is not None else None
|
||||
self.__draftTracks : List[TrackDescriptor] = []
|
||||
self.__draftTags : dict[str, str] = {}
|
||||
self.__trackRowData: dict[object, TrackDescriptor] = {}
|
||||
self.__tagRowData: dict[object, tuple[str, str]] = {}
|
||||
self.__shiftedSeasonRowData: dict[object, dict[str, int | None]] = {}
|
||||
|
||||
|
||||
def updateTracks(self):
|
||||
|
||||
self.tracksTable.clear()
|
||||
self.__trackRowData = {}
|
||||
|
||||
tracks = self.getCurrentTrackDescriptors()
|
||||
|
||||
@@ -171,8 +165,7 @@ class PatternDetailsScreen(Screen):
|
||||
'Yes' if TrackDisposition.FORCED in dispoSet else 'No',
|
||||
td.getSourceIndex())
|
||||
|
||||
row_key = self.tracksTable.add_row(*map(str, row))
|
||||
self.__trackRowData[row_key] = td
|
||||
self.tracksTable.add_row(*map(str, row))
|
||||
|
||||
typeCounter[trackType] += 1
|
||||
|
||||
@@ -250,23 +243,29 @@ class PatternDetailsScreen(Screen):
|
||||
|
||||
|
||||
def updateTags(self):
|
||||
|
||||
self.tagsTable.clear()
|
||||
|
||||
tags = (
|
||||
self.__tac.findAllMediaTags(self.__pattern.getId())
|
||||
if self.__pattern is not None
|
||||
else self.__draftTags
|
||||
)
|
||||
|
||||
self.__tagRowData = populate_tag_table(
|
||||
self.tagsTable,
|
||||
tags,
|
||||
ignore_keys=self.__ignoreGlobalKeys,
|
||||
remove_keys=self.__removeGlobalKeys,
|
||||
)
|
||||
for tagKey, tagValue in tags.items():
|
||||
|
||||
textColor = None
|
||||
if tagKey in self.__ignoreGlobalKeys:
|
||||
textColor = 'blue'
|
||||
if tagKey in self.__removeGlobalKeys:
|
||||
textColor = 'red'
|
||||
|
||||
row = (formatRichColor(tagKey, textColor), formatRichColor(tagValue, textColor))
|
||||
self.tagsTable.add_row(*map(str, row))
|
||||
|
||||
def updateShiftedSeasons(self):
|
||||
|
||||
self.shiftedSeasonsTable.clear()
|
||||
self.__shiftedSeasonRowData = {}
|
||||
|
||||
if self.__pattern is None:
|
||||
return
|
||||
@@ -274,7 +273,6 @@ class PatternDetailsScreen(Screen):
|
||||
shiftedSeason: ShiftedSeason
|
||||
for shiftedSeason in self.__ssc.getShiftedSeasonSiblings(patternId=self.__pattern.getId()):
|
||||
shiftedSeasonObj = shiftedSeason.getObj()
|
||||
shiftedSeasonObj['id'] = shiftedSeason.getId()
|
||||
|
||||
firstEpisode = shiftedSeasonObj['first_episode']
|
||||
firstEpisodeStr = str(firstEpisode) if firstEpisode != -1 else ''
|
||||
@@ -290,8 +288,7 @@ class PatternDetailsScreen(Screen):
|
||||
shiftedSeasonObj['episode_offset'],
|
||||
)
|
||||
|
||||
row_key = self.shiftedSeasonsTable.add_row(*map(str, row))
|
||||
self.__shiftedSeasonRowData[row_key] = shiftedSeasonObj
|
||||
self.shiftedSeasonsTable.add_row(*map(str, row))
|
||||
|
||||
def getSelectedShiftedSeasonObjFromInput(self):
|
||||
|
||||
@@ -303,7 +300,29 @@ class PatternDetailsScreen(Screen):
|
||||
)
|
||||
|
||||
if row_key is not None:
|
||||
shiftedSeasonObj = dict(self.__shiftedSeasonRowData.get(row_key, {}))
|
||||
selected_row_data = self.shiftedSeasonsTable.get_row(row_key)
|
||||
|
||||
def parse_int_or_default(value: str, default: int) -> int:
|
||||
try:
|
||||
return int(value)
|
||||
except (TypeError, ValueError):
|
||||
return default
|
||||
|
||||
shiftedSeasonObj['original_season'] = int(selected_row_data[0])
|
||||
shiftedSeasonObj['first_episode'] = parse_int_or_default(selected_row_data[1], -1)
|
||||
shiftedSeasonObj['last_episode'] = parse_int_or_default(selected_row_data[2], -1)
|
||||
shiftedSeasonObj['season_offset'] = parse_int_or_default(selected_row_data[3], 0)
|
||||
shiftedSeasonObj['episode_offset'] = parse_int_or_default(selected_row_data[4], 0)
|
||||
|
||||
if self.__pattern is not None:
|
||||
shiftedSeasonId = self.__ssc.findShiftedSeason(
|
||||
patternId=self.__pattern.getId(),
|
||||
originalSeason=shiftedSeasonObj['original_season'],
|
||||
firstEpisode=shiftedSeasonObj['first_episode'],
|
||||
lastEpisode=shiftedSeasonObj['last_episode'],
|
||||
)
|
||||
if shiftedSeasonId is not None:
|
||||
shiftedSeasonObj['id'] = shiftedSeasonId
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -494,7 +513,15 @@ class PatternDetailsScreen(Screen):
|
||||
row_key, col_key = self.tracksTable.coordinate_to_cell_key(self.tracksTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
return self.__trackRowData.get(row_key)
|
||||
selected_track_data = self.tracksTable.get_row(row_key)
|
||||
|
||||
trackIndex = int(selected_track_data[0])
|
||||
trackSubIndex = int(selected_track_data[2])
|
||||
|
||||
for trackDescriptor in self.getCurrentTrackDescriptors():
|
||||
if (trackDescriptor.getIndex() == trackIndex
|
||||
and trackDescriptor.getSubIndex() == trackSubIndex):
|
||||
return trackDescriptor
|
||||
|
||||
return None
|
||||
|
||||
@@ -512,7 +539,12 @@ class PatternDetailsScreen(Screen):
|
||||
row_key, col_key = self.tagsTable.coordinate_to_cell_key(self.tagsTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
return self.__tagRowData.get(row_key)
|
||||
selected_tag_data = self.tagsTable.get_row(row_key)
|
||||
|
||||
tagKey = removeRichColor(selected_tag_data[0])
|
||||
tagValue = removeRichColor(selected_tag_data[1])
|
||||
|
||||
return tagKey, tagValue
|
||||
|
||||
else:
|
||||
return None
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Mapping
|
||||
from dataclasses import dataclass
|
||||
|
||||
from .helper import formatRichColor
|
||||
from .pattern_controller import PatternController
|
||||
from .show_controller import ShowController
|
||||
from .shifted_season_controller import ShiftedSeasonController
|
||||
@@ -65,34 +63,3 @@ def build_screen_controllers(
|
||||
controllers['shifted_season'] = ShiftedSeasonController(context=context)
|
||||
|
||||
return controllers
|
||||
|
||||
|
||||
def populate_tag_table(
|
||||
table,
|
||||
tags: Mapping[str, object],
|
||||
*,
|
||||
ignore_keys: list[str],
|
||||
remove_keys: list[str],
|
||||
) -> dict[object, tuple[str, str]]:
|
||||
"""Render display rows while keeping raw tag data addressable by row key."""
|
||||
|
||||
table.clear()
|
||||
|
||||
row_data: dict[object, tuple[str, str]] = {}
|
||||
for tag_key, tag_value in tags.items():
|
||||
raw_key = str(tag_key)
|
||||
raw_value = str(tag_value)
|
||||
|
||||
text_color = None
|
||||
if raw_key in ignore_keys:
|
||||
text_color = "blue"
|
||||
if raw_key in remove_keys:
|
||||
text_color = "red"
|
||||
|
||||
row_key = table.add_row(
|
||||
str(formatRichColor(raw_key, text_color)),
|
||||
str(formatRichColor(raw_value, text_color)),
|
||||
)
|
||||
row_data[row_key] = (raw_key, raw_value)
|
||||
|
||||
return row_data
|
||||
|
||||
@@ -383,27 +383,10 @@ class ShiftedSeasonController:
|
||||
session.close()
|
||||
|
||||
def shiftSeason(self, showId, season, episode, patternId=None):
|
||||
|
||||
if season == -1 or episode == -1:
|
||||
return season, episode
|
||||
|
||||
shiftedSeason, shiftedEpisode, sourceLabel = self.resolveShiftSeason(
|
||||
showId,
|
||||
season,
|
||||
episode,
|
||||
patternId=patternId,
|
||||
)
|
||||
|
||||
if shiftedSeason != season or shiftedEpisode != episode:
|
||||
self.context['logger'].info(
|
||||
f"Setting season shift {season}/{episode} -> {shiftedSeason}/{shiftedEpisode} from {sourceLabel}"
|
||||
)
|
||||
|
||||
return shiftedSeason, shiftedEpisode
|
||||
|
||||
def resolveShiftSeason(self, showId, season, episode, patternId=None):
|
||||
if season == -1 or episode == -1:
|
||||
return season, episode, "unrecognized"
|
||||
|
||||
session = None
|
||||
try:
|
||||
session = self.Session()
|
||||
@@ -437,7 +420,12 @@ class ShiftedSeasonController:
|
||||
if activeShift.getPatternId() is not None
|
||||
else "show"
|
||||
)
|
||||
return shiftedSeason, shiftedEpisode, sourceLabel
|
||||
|
||||
self.context['logger'].info(
|
||||
f"Setting season shift {season}/{episode} -> {shiftedSeason}/{shiftedEpisode} from {sourceLabel}"
|
||||
)
|
||||
|
||||
return shiftedSeason, shiftedEpisode
|
||||
|
||||
except ShiftedSeasonOwnerException as ex:
|
||||
raise click.ClickException(str(ex))
|
||||
|
||||
@@ -108,45 +108,12 @@ class ShowDetailsScreen(Screen):
|
||||
self.__ssc = controllers['shifted_season']
|
||||
|
||||
self.__showDescriptor = self.__sc.getShowDescriptor(showId) if showId is not None else None
|
||||
self.__patternRowData: dict[object, dict[str, object]] = {}
|
||||
self.__shiftedSeasonRowData: dict[object, dict[str, int | None]] = {}
|
||||
|
||||
|
||||
def _add_pattern_row(self, *, pattern_id: int | None, pattern_text: str):
|
||||
row_key = self.patternTable.add_row(str(pattern_text))
|
||||
self.__patternRowData[row_key] = {
|
||||
'id': pattern_id,
|
||||
'show_id': self.__showDescriptor.getId() if self.__showDescriptor is not None else None,
|
||||
'pattern': str(pattern_text),
|
||||
}
|
||||
return row_key
|
||||
|
||||
|
||||
def _add_shifted_season_row(self, shifted_season_obj: dict[str, int | None]):
|
||||
firstEpisode = shifted_season_obj['first_episode']
|
||||
firstEpisodeStr = str(firstEpisode) if firstEpisode != -1 else ''
|
||||
|
||||
lastEpisode = shifted_season_obj['last_episode']
|
||||
lastEpisodeStr = str(lastEpisode) if lastEpisode != -1 else ''
|
||||
|
||||
row = (
|
||||
shifted_season_obj['original_season'],
|
||||
firstEpisodeStr,
|
||||
lastEpisodeStr,
|
||||
shifted_season_obj['season_offset'],
|
||||
shifted_season_obj['episode_offset'],
|
||||
)
|
||||
|
||||
row_key = self.shiftedSeasonsTable.add_row(*map(str, row))
|
||||
self.__shiftedSeasonRowData[row_key] = dict(shifted_season_obj)
|
||||
return row_key
|
||||
|
||||
|
||||
|
||||
def updateShiftedSeasons(self):
|
||||
|
||||
self.shiftedSeasonsTable.clear()
|
||||
self.__shiftedSeasonRowData = {}
|
||||
|
||||
if not self.__showDescriptor is None:
|
||||
|
||||
@@ -156,8 +123,20 @@ class ShowDetailsScreen(Screen):
|
||||
for shiftedSeason in self.__ssc.getShiftedSeasonSiblings(showId=showId):
|
||||
|
||||
shiftedSeasonObj = shiftedSeason.getObj()
|
||||
shiftedSeasonObj['id'] = shiftedSeason.getId()
|
||||
self._add_shifted_season_row(shiftedSeasonObj)
|
||||
|
||||
firstEpisode = shiftedSeasonObj['first_episode']
|
||||
firstEpisodeStr = str(firstEpisode) if firstEpisode != -1 else ''
|
||||
|
||||
lastEpisode = shiftedSeasonObj['last_episode']
|
||||
lastEpisodeStr = str(lastEpisode) if lastEpisode != -1 else ''
|
||||
|
||||
row = (shiftedSeasonObj['original_season'],
|
||||
firstEpisodeStr,
|
||||
lastEpisodeStr,
|
||||
shiftedSeasonObj['season_offset'],
|
||||
shiftedSeasonObj['episode_offset'])
|
||||
|
||||
self.shiftedSeasonsTable.add_row(*map(str, row))
|
||||
|
||||
|
||||
|
||||
@@ -183,10 +162,8 @@ class ShowDetailsScreen(Screen):
|
||||
|
||||
#raise click.ClickException(f"show_id {showId}")
|
||||
for pattern in self.__pc.getPatternsForShow(showId):
|
||||
self._add_pattern_row(
|
||||
pattern_id=pattern.getId(),
|
||||
pattern_text=pattern.getPattern(),
|
||||
)
|
||||
row = (pattern.getPattern(),)
|
||||
self.patternTable.add_row(*map(str, row))
|
||||
|
||||
self.updateShiftedSeasons()
|
||||
|
||||
@@ -218,7 +195,10 @@ class ShowDetailsScreen(Screen):
|
||||
row_key, col_key = self.patternTable.coordinate_to_cell_key(self.patternTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
selectedPattern = dict(self.__patternRowData.get(row_key, {}))
|
||||
selected_row_data = self.patternTable.get_row(row_key)
|
||||
|
||||
selectedPattern['show_id'] = self.__showDescriptor.getId()
|
||||
selectedPattern['pattern'] = str(selected_row_data[0])
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -237,7 +217,31 @@ class ShowDetailsScreen(Screen):
|
||||
row_key, col_key = self.shiftedSeasonsTable.coordinate_to_cell_key(self.shiftedSeasonsTable.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
shiftedSeasonObj = dict(self.__shiftedSeasonRowData.get(row_key, {}))
|
||||
selected_row_data = self.shiftedSeasonsTable.get_row(row_key)
|
||||
|
||||
def parse_int_or_default(value: str, default: int) -> int:
|
||||
try:
|
||||
return int(value)
|
||||
except (TypeError, ValueError):
|
||||
return default
|
||||
|
||||
shiftedSeasonObj['original_season'] = int(selected_row_data[0])
|
||||
shiftedSeasonObj['first_episode'] = parse_int_or_default(selected_row_data[1], -1)
|
||||
shiftedSeasonObj['last_episode'] = parse_int_or_default(selected_row_data[2], -1)
|
||||
shiftedSeasonObj['season_offset'] = parse_int_or_default(selected_row_data[3], 0)
|
||||
shiftedSeasonObj['episode_offset'] = parse_int_or_default(selected_row_data[4], 0)
|
||||
|
||||
|
||||
if self.__showDescriptor is not None:
|
||||
|
||||
showId = int(self.__showDescriptor.getId())
|
||||
|
||||
shiftedSeasonId = self.__ssc.findShiftedSeason(showId,
|
||||
originalSeason=shiftedSeasonObj['original_season'],
|
||||
firstEpisode=shiftedSeasonObj['first_episode'],
|
||||
lastEpisode=shiftedSeasonObj['last_episode'])
|
||||
if shiftedSeasonId is not None:
|
||||
shiftedSeasonObj['id'] = shiftedSeasonId
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -251,14 +255,9 @@ class ShowDetailsScreen(Screen):
|
||||
|
||||
|
||||
def handle_add_pattern(self, screenResult):
|
||||
if screenResult is None:
|
||||
return
|
||||
|
||||
pattern_id = self.__pc.findPattern(screenResult)
|
||||
self._add_pattern_row(
|
||||
pattern_id=pattern_id,
|
||||
pattern_text=screenResult['pattern'],
|
||||
)
|
||||
pattern = (screenResult['pattern'],)
|
||||
self.patternTable.add_row(*map(str, pattern))
|
||||
|
||||
|
||||
def action_edit_pattern(self):
|
||||
@@ -266,7 +265,8 @@ class ShowDetailsScreen(Screen):
|
||||
selectedPatternDescriptor = self.getSelectedPatternDescriptor()
|
||||
|
||||
if selectedPatternDescriptor:
|
||||
selectedPatternId = selectedPatternDescriptor.get('id')
|
||||
|
||||
selectedPatternId = self.__pc.findPattern(selectedPatternDescriptor)
|
||||
|
||||
if selectedPatternId is None:
|
||||
raise click.ClickException(f"ShowDetailsScreen.action_edit_pattern(): Pattern to edit has no id")
|
||||
@@ -280,8 +280,6 @@ class ShowDetailsScreen(Screen):
|
||||
|
||||
row_key, col_key = self.patternTable.coordinate_to_cell_key(self.patternTable.cursor_coordinate)
|
||||
self.patternTable.update_cell(row_key, self.column_key_pattern, screenResult['pattern'])
|
||||
if row_key in self.__patternRowData:
|
||||
self.__patternRowData[row_key]['pattern'] = str(screenResult['pattern'])
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -293,7 +291,7 @@ class ShowDetailsScreen(Screen):
|
||||
|
||||
if selectedPatternDescriptor:
|
||||
|
||||
selectedPatternId = selectedPatternDescriptor.get('id')
|
||||
selectedPatternId = self.__pc.findPattern(selectedPatternDescriptor)
|
||||
|
||||
if selectedPatternId is None:
|
||||
raise click.ClickException(f"ShowDetailsScreen.action_remove_pattern(): Pattern to remove has no id")
|
||||
@@ -306,7 +304,6 @@ class ShowDetailsScreen(Screen):
|
||||
try:
|
||||
row_key, col_key = self.patternTable.coordinate_to_cell_key(self.patternTable.cursor_coordinate)
|
||||
self.patternTable.remove_row(row_key)
|
||||
self.__patternRowData.pop(row_key, None)
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
|
||||
@@ -66,17 +66,6 @@ class ShowsScreen(Screen):
|
||||
self.Session = self.context['database']['session'] # convenience
|
||||
|
||||
self.__sc = ShowController(context = self.context)
|
||||
self.__showRowData: dict[object, ShowDescriptor] = {}
|
||||
|
||||
|
||||
def _add_show_row(self, show_descriptor: ShowDescriptor):
|
||||
row_key = self.table.add_row(
|
||||
str(show_descriptor.getId()),
|
||||
str(show_descriptor.getName()),
|
||||
str(show_descriptor.getYear()),
|
||||
)
|
||||
self.__showRowData[row_key] = show_descriptor
|
||||
return row_key
|
||||
|
||||
|
||||
def getSelectedShowId(self):
|
||||
@@ -87,8 +76,9 @@ class ShowsScreen(Screen):
|
||||
row_key, col_key = self.table.coordinate_to_cell_key(self.table.cursor_coordinate)
|
||||
|
||||
if row_key is not None:
|
||||
selected_show = self.__showRowData.get(row_key)
|
||||
return selected_show.getId() if selected_show is not None else None
|
||||
selected_row_data = self.table.get_row(row_key)
|
||||
|
||||
return selected_row_data[0]
|
||||
|
||||
except CellDoesNotExist:
|
||||
return None
|
||||
@@ -100,8 +90,9 @@ class ShowsScreen(Screen):
|
||||
self.app.push_screen(ShowDetailsScreen(), self.handle_new_screen)
|
||||
|
||||
def handle_new_screen(self, screenResult):
|
||||
if isinstance(screenResult, ShowDescriptor):
|
||||
self._add_show_row(screenResult)
|
||||
|
||||
show = (screenResult['id'], screenResult['name'], screenResult['year'])
|
||||
self.table.add_row(*map(str, show))
|
||||
|
||||
|
||||
def action_edit_show(self):
|
||||
@@ -119,8 +110,7 @@ class ShowsScreen(Screen):
|
||||
row_key, col_key = self.table.coordinate_to_cell_key(self.table.cursor_coordinate)
|
||||
|
||||
self.table.update_cell(row_key, self.column_key_name, showDescriptor.getName())
|
||||
self.table.update_cell(row_key, self.column_key_year, showDescriptor.getYear())
|
||||
self.__showRowData[row_key] = showDescriptor
|
||||
self.table.update_cell(row_key, self.column_key_year, showDescriptor.getYear())
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -141,7 +131,6 @@ class ShowsScreen(Screen):
|
||||
try:
|
||||
row_key, col_key = self.table.coordinate_to_cell_key(self.table.cursor_coordinate)
|
||||
self.table.remove_row(row_key)
|
||||
self.__showRowData.pop(row_key, None)
|
||||
|
||||
except CellDoesNotExist:
|
||||
pass
|
||||
@@ -149,7 +138,8 @@ class ShowsScreen(Screen):
|
||||
|
||||
def on_mount(self) -> None:
|
||||
for show in self.__sc.getAllShows():
|
||||
self._add_show_row(show.getDescriptor(self.context))
|
||||
row = (int(show.id), show.name, show.year) # Convert each element to a string before adding
|
||||
self.table.add_row(*map(str, row))
|
||||
|
||||
|
||||
def compose(self):
|
||||
|
||||
@@ -13,7 +13,8 @@ from .track_codec import TrackCodec
|
||||
from .track_descriptor import TrackDescriptor
|
||||
from .track_disposition import TrackDisposition
|
||||
from .track_type import TrackType
|
||||
from .screen_support import build_screen_bootstrap, populate_tag_table
|
||||
|
||||
from ffx.helper import formatRichColor, removeRichColor
|
||||
|
||||
|
||||
class TrackDetailsScreen(Screen):
|
||||
@@ -97,12 +98,28 @@ class TrackDetailsScreen(Screen):
|
||||
):
|
||||
super().__init__()
|
||||
|
||||
bootstrap = build_screen_bootstrap(self.app.getContext())
|
||||
self.context = bootstrap.context
|
||||
self.context = self.app.getContext()
|
||||
|
||||
self.__removeTrackKeys = bootstrap.remove_track_keys
|
||||
self.__ignoreTrackKeys = bootstrap.ignore_track_keys
|
||||
self.__tagRowData: dict[object, tuple[str, str]] = {}
|
||||
self.__configurationData = self.context["config"].getData()
|
||||
|
||||
metadataConfiguration = (
|
||||
self.__configurationData["metadata"]
|
||||
if "metadata" in self.__configurationData.keys()
|
||||
else {}
|
||||
)
|
||||
|
||||
self.__removeTrackKeys = (
|
||||
metadataConfiguration["streams"]["remove"]
|
||||
if "streams" in metadataConfiguration.keys()
|
||||
and "remove" in metadataConfiguration["streams"].keys()
|
||||
else []
|
||||
)
|
||||
self.__ignoreTrackKeys = (
|
||||
metadataConfiguration["streams"]["ignore"]
|
||||
if "streams" in metadataConfiguration.keys()
|
||||
and "ignore" in metadataConfiguration["streams"].keys()
|
||||
else []
|
||||
)
|
||||
|
||||
self.__isNew = trackDescriptor is None
|
||||
self.__trackDescriptor = trackDescriptor
|
||||
@@ -149,12 +166,18 @@ class TrackDetailsScreen(Screen):
|
||||
)
|
||||
|
||||
def updateTags(self):
|
||||
self.__tagRowData = populate_tag_table(
|
||||
self.trackTagsTable,
|
||||
self.__draftTrackTags,
|
||||
ignore_keys=self.__ignoreTrackKeys,
|
||||
remove_keys=self.__removeTrackKeys,
|
||||
)
|
||||
|
||||
self.trackTagsTable.clear()
|
||||
|
||||
for key, value in self.__draftTrackTags.items():
|
||||
textColor = None
|
||||
if key in self.__ignoreTrackKeys:
|
||||
textColor = "blue"
|
||||
if key in self.__removeTrackKeys:
|
||||
textColor = "red"
|
||||
|
||||
row = (formatRichColor(key, textColor), formatRichColor(value, textColor))
|
||||
self.trackTagsTable.add_row(*map(str, row))
|
||||
|
||||
def on_mount(self):
|
||||
|
||||
@@ -167,9 +190,9 @@ class TrackDetailsScreen(Screen):
|
||||
self.query_one("#pattern_label", Static).update(self.__patternLabel)
|
||||
|
||||
if self.__trackType is not None:
|
||||
self.query_one("#type_select", Select).value = self.__trackType
|
||||
self.query_one("#type_select", Select).value = self.__trackType.label()
|
||||
|
||||
self.query_one("#audio_layout_select", Select).value = self.__audioLayout
|
||||
self.query_one("#audio_layout_select", Select).value = self.__audioLayout.label()
|
||||
|
||||
for disposition in TrackDisposition:
|
||||
|
||||
@@ -188,7 +211,9 @@ class TrackDetailsScreen(Screen):
|
||||
)
|
||||
|
||||
if self.__trackDescriptor is not None:
|
||||
self.query_one("#language_select", Select).value = self.__trackDescriptor.getLanguage()
|
||||
self.query_one("#language_select", Select).value = (
|
||||
self.__trackDescriptor.getLanguage().label()
|
||||
)
|
||||
self.query_one("#title_input", Input).value = self.__trackDescriptor.getTitle()
|
||||
self.updateTags()
|
||||
|
||||
@@ -201,6 +226,8 @@ class TrackDetailsScreen(Screen):
|
||||
|
||||
self.trackTagsTable.cursor_type = "row"
|
||||
|
||||
languages = [language.label() for language in IsoLanguage]
|
||||
|
||||
yield Header()
|
||||
|
||||
with Grid():
|
||||
@@ -223,15 +250,15 @@ class TrackDetailsScreen(Screen):
|
||||
yield Static(" ", classes="five")
|
||||
|
||||
yield Static("Type")
|
||||
yield Select(
|
||||
[(trackType.label(), trackType) for trackType in TrackType],
|
||||
yield Select.from_values(
|
||||
[trackType.label() for trackType in TrackType],
|
||||
classes="four",
|
||||
id="type_select",
|
||||
)
|
||||
|
||||
yield Static("Audio Layout")
|
||||
yield Select(
|
||||
[(layout.label(), layout) for layout in AudioLayout],
|
||||
yield Select.from_values(
|
||||
[layout.label() for layout in AudioLayout],
|
||||
classes="four",
|
||||
id="audio_layout_select",
|
||||
)
|
||||
@@ -241,11 +268,7 @@ class TrackDetailsScreen(Screen):
|
||||
yield Static(" ", classes="five")
|
||||
|
||||
yield Static("Language")
|
||||
yield Select(
|
||||
[(language.label(), language) for language in IsoLanguage],
|
||||
classes="four",
|
||||
id="language_select",
|
||||
)
|
||||
yield Select.from_values(languages, classes="four", id="language_select")
|
||||
|
||||
yield Static(" ", classes="five")
|
||||
|
||||
@@ -305,18 +328,15 @@ class TrackDetailsScreen(Screen):
|
||||
if self.__subIndex is not None and int(self.__subIndex) >= 0:
|
||||
kwargs[TrackDescriptor.SUB_INDEX_KEY] = int(self.__subIndex)
|
||||
|
||||
selectedTrackType = self.query_one("#type_select", Select).value
|
||||
if not isinstance(selectedTrackType, TrackType):
|
||||
selectedTrackType = TrackType.UNKNOWN
|
||||
selectedTrackType = TrackType.fromLabel(
|
||||
self.query_one("#type_select", Select).value
|
||||
)
|
||||
kwargs[TrackDescriptor.TRACK_TYPE_KEY] = selectedTrackType
|
||||
kwargs[TrackDescriptor.CODEC_KEY] = self.__trackCodec
|
||||
|
||||
if selectedTrackType == TrackType.AUDIO:
|
||||
selectedAudioLayout = self.query_one("#audio_layout_select", Select).value
|
||||
kwargs[TrackDescriptor.AUDIO_LAYOUT_KEY] = (
|
||||
selectedAudioLayout
|
||||
if isinstance(selectedAudioLayout, AudioLayout)
|
||||
else AudioLayout.LAYOUT_UNDEFINED
|
||||
kwargs[TrackDescriptor.AUDIO_LAYOUT_KEY] = AudioLayout.fromLabel(
|
||||
self.query_one("#audio_layout_select", Select).value
|
||||
)
|
||||
else:
|
||||
kwargs[TrackDescriptor.AUDIO_LAYOUT_KEY] = AudioLayout.LAYOUT_UNDEFINED
|
||||
@@ -324,8 +344,8 @@ class TrackDetailsScreen(Screen):
|
||||
trackTags = dict(self.__draftTrackTags)
|
||||
|
||||
language = self.query_one("#language_select", Select).value
|
||||
if isinstance(language, IsoLanguage):
|
||||
trackTags["language"] = language.threeLetter()
|
||||
if language:
|
||||
trackTags["language"] = IsoLanguage.find(language).threeLetter()
|
||||
|
||||
title = self.query_one("#title_input", Input).value
|
||||
if title:
|
||||
@@ -350,7 +370,12 @@ class TrackDetailsScreen(Screen):
|
||||
)
|
||||
|
||||
if row_key is not None:
|
||||
return self.__tagRowData.get(row_key)
|
||||
selected_tag_data = self.trackTagsTable.get_row(row_key)
|
||||
|
||||
tagKey = removeRichColor(selected_tag_data[0])
|
||||
tagValue = removeRichColor(selected_tag_data[1])
|
||||
|
||||
return tagKey, tagValue
|
||||
|
||||
return None
|
||||
|
||||
|
||||
@@ -1,142 +0,0 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
from click.testing import CliRunner
|
||||
|
||||
|
||||
SRC_ROOT = Path(__file__).resolve().parents[2] / "src"
|
||||
|
||||
if str(SRC_ROOT) not in sys.path:
|
||||
sys.path.insert(0, str(SRC_ROOT))
|
||||
|
||||
|
||||
from ffx import cli # noqa: E402
|
||||
|
||||
|
||||
class _FakePattern:
|
||||
def __init__(self, pattern_id: int):
|
||||
self._pattern_id = pattern_id
|
||||
|
||||
def getId(self):
|
||||
return self._pattern_id
|
||||
|
||||
|
||||
class _FakeFileProperties:
|
||||
def __init__(self, context, source_path):
|
||||
self.source_path = source_path
|
||||
|
||||
def getShowId(self):
|
||||
return 42 if self.source_path.endswith("mapped.mkv") else -1
|
||||
|
||||
def getSeason(self):
|
||||
if self.source_path.endswith("unknown.mkv"):
|
||||
return -1
|
||||
return 1
|
||||
|
||||
def getEpisode(self):
|
||||
if self.source_path.endswith("unknown.mkv"):
|
||||
return -1
|
||||
return 3
|
||||
|
||||
def getPattern(self):
|
||||
if self.source_path.endswith("mapped.mkv"):
|
||||
return _FakePattern(7)
|
||||
return None
|
||||
|
||||
|
||||
class _FakeShiftedSeasonController:
|
||||
def __init__(self, context):
|
||||
self.context = context
|
||||
|
||||
def resolveShiftSeason(self, show_id, season, episode, patternId=None):
|
||||
if patternId is not None:
|
||||
return 2, 1, "pattern"
|
||||
return season, episode, "default"
|
||||
|
||||
|
||||
class InspectShiftCliTests(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.tempdir = tempfile.TemporaryDirectory()
|
||||
self.home_dir = Path(self.tempdir.name) / "home"
|
||||
self.home_dir.mkdir()
|
||||
self.database_path = Path(self.tempdir.name) / "test.db"
|
||||
self.source_dir = Path(self.tempdir.name) / "source"
|
||||
self.source_dir.mkdir()
|
||||
self.mapped_path = self.source_dir / "mapped.mkv"
|
||||
self.mapped_path.write_bytes(b"mapped")
|
||||
self.identity_path = self.source_dir / "identity.mkv"
|
||||
self.identity_path.write_bytes(b"identity")
|
||||
self.unknown_path = self.source_dir / "unknown.mkv"
|
||||
self.unknown_path.write_bytes(b"unknown")
|
||||
|
||||
def tearDown(self):
|
||||
self.tempdir.cleanup()
|
||||
|
||||
def test_inspect_shift_prints_resolved_mapping_for_each_file(self):
|
||||
runner = CliRunner()
|
||||
|
||||
with (
|
||||
patch("ffx.file_properties.FileProperties", _FakeFileProperties),
|
||||
patch(
|
||||
"ffx.shifted_season_controller.ShiftedSeasonController",
|
||||
_FakeShiftedSeasonController,
|
||||
),
|
||||
):
|
||||
result = runner.invoke(
|
||||
cli.ffx,
|
||||
[
|
||||
"--database-file",
|
||||
str(self.database_path),
|
||||
"inspect",
|
||||
"--shift",
|
||||
str(self.mapped_path),
|
||||
str(self.identity_path),
|
||||
str(self.unknown_path),
|
||||
],
|
||||
env={**os.environ, "HOME": str(self.home_dir)},
|
||||
)
|
||||
|
||||
self.assertEqual(0, result.exit_code, result.output)
|
||||
self.assertIn(
|
||||
f"{self.mapped_path}: 1/3 -> 2/1 from pattern",
|
||||
result.output,
|
||||
)
|
||||
self.assertIn(
|
||||
f"{self.identity_path}: none",
|
||||
result.output,
|
||||
)
|
||||
self.assertIn(
|
||||
f"{self.unknown_path}: no season/episode recognized",
|
||||
result.output,
|
||||
)
|
||||
|
||||
def test_inspect_without_shift_requires_exactly_one_filename(self):
|
||||
runner = CliRunner()
|
||||
|
||||
result = runner.invoke(
|
||||
cli.ffx,
|
||||
[
|
||||
"--database-file",
|
||||
str(self.database_path),
|
||||
"inspect",
|
||||
str(self.mapped_path),
|
||||
str(self.unknown_path),
|
||||
],
|
||||
env={**os.environ, "HOME": str(self.home_dir)},
|
||||
)
|
||||
|
||||
self.assertNotEqual(0, result.exit_code)
|
||||
self.assertIn(
|
||||
"Inspect without --shift requires exactly one filename.",
|
||||
result.output,
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -23,21 +23,6 @@ class StaticConfig:
|
||||
return self._data
|
||||
|
||||
|
||||
class FakeTagTable:
|
||||
def __init__(self):
|
||||
self.rows = {}
|
||||
self._next_index = 0
|
||||
|
||||
def clear(self):
|
||||
self.rows.clear()
|
||||
|
||||
def add_row(self, *values):
|
||||
row_key = f"row-{self._next_index}"
|
||||
self._next_index += 1
|
||||
self.rows[row_key] = tuple(values)
|
||||
return row_key
|
||||
|
||||
|
||||
class ScreenSupportTests(unittest.TestCase):
|
||||
def make_context(self):
|
||||
return {
|
||||
@@ -96,32 +81,6 @@ class ScreenSupportTests(unittest.TestCase):
|
||||
controllers,
|
||||
)
|
||||
|
||||
def test_populate_tag_table_keeps_raw_values_outside_display_labels(self):
|
||||
table = FakeTagTable()
|
||||
|
||||
row_data = screen_support.populate_tag_table(
|
||||
table,
|
||||
{"BPS": 4835, "KEEP": "plain"},
|
||||
ignore_keys=["KEEP"],
|
||||
remove_keys=["BPS"],
|
||||
)
|
||||
|
||||
self.assertEqual(
|
||||
{
|
||||
"row-0": ("BPS", "4835"),
|
||||
"row-1": ("KEEP", "plain"),
|
||||
},
|
||||
row_data,
|
||||
)
|
||||
self.assertEqual(
|
||||
("[red]BPS[/red]", "[red]4835[/red]"),
|
||||
table.rows["row-0"],
|
||||
)
|
||||
self.assertEqual(
|
||||
("[blue]KEEP[/blue]", "[blue]plain[/blue]"),
|
||||
table.rows["row-1"],
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
||||
@@ -183,7 +183,9 @@ class ShiftedSeasonControllerTests(unittest.TestCase):
|
||||
)
|
||||
|
||||
self.assertEqual((1, 3), (shifted_season, shifted_episode))
|
||||
mocked_info.assert_not_called()
|
||||
mocked_info.assert_called_once_with(
|
||||
"Setting season shift 1/3 -> 1/3 from pattern"
|
||||
)
|
||||
|
||||
def test_shift_season_falls_back_to_identity_when_no_rule_matches(self):
|
||||
pattern_id = self.add_pattern(1, r"^demo_(s[0-9]+e[0-9]+)\.mkv$")
|
||||
@@ -197,7 +199,9 @@ class ShiftedSeasonControllerTests(unittest.TestCase):
|
||||
)
|
||||
|
||||
self.assertEqual((4, 20), (shifted_season, shifted_episode))
|
||||
mocked_info.assert_not_called()
|
||||
mocked_info.assert_called_once_with(
|
||||
"Setting season shift 4/20 -> 4/20 from default"
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@@ -1,325 +0,0 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import unittest
|
||||
|
||||
|
||||
SRC_ROOT = Path(__file__).resolve().parents[2] / "src"
|
||||
|
||||
if str(SRC_ROOT) not in sys.path:
|
||||
sys.path.insert(0, str(SRC_ROOT))
|
||||
|
||||
|
||||
from ffx.audio_layout import AudioLayout # noqa: E402
|
||||
from ffx.iso_language import IsoLanguage # noqa: E402
|
||||
from ffx.logging_utils import get_ffx_logger # noqa: E402
|
||||
from ffx.media_details_screen import MediaDetailsScreen # noqa: E402
|
||||
from ffx.pattern_details_screen import PatternDetailsScreen # noqa: E402
|
||||
from ffx.show_descriptor import ShowDescriptor # noqa: E402
|
||||
from ffx.show_details_screen import ShowDetailsScreen # noqa: E402
|
||||
from ffx.shows_screen import ShowsScreen # noqa: E402
|
||||
from ffx.track_codec import TrackCodec # noqa: E402
|
||||
from ffx.track_descriptor import TrackDescriptor # noqa: E402
|
||||
from ffx.track_details_screen import TrackDetailsScreen # noqa: E402
|
||||
from ffx.track_type import TrackType # noqa: E402
|
||||
|
||||
|
||||
class FakeTagTable:
|
||||
def __init__(self):
|
||||
self.rows = {}
|
||||
self.cursor_coordinate = (0, 0)
|
||||
self._selected_row_key = None
|
||||
self._next_index = 0
|
||||
self._row_order = []
|
||||
|
||||
def clear(self):
|
||||
self.rows.clear()
|
||||
self._selected_row_key = None
|
||||
self._row_order.clear()
|
||||
|
||||
def add_row(self, *values):
|
||||
row_key = f"row-{self._next_index}"
|
||||
self._next_index += 1
|
||||
self.rows[row_key] = tuple(values)
|
||||
self._row_order.append(row_key)
|
||||
if self._selected_row_key is None:
|
||||
self._selected_row_key = row_key
|
||||
return row_key
|
||||
|
||||
def coordinate_to_cell_key(self, _coordinate):
|
||||
return self._selected_row_key, None
|
||||
|
||||
def select_row(self, row_key):
|
||||
self._selected_row_key = row_key
|
||||
|
||||
def get_row_index(self, row_key):
|
||||
return self._row_order.index(row_key)
|
||||
|
||||
def remove_row(self, row_key):
|
||||
self.rows.pop(row_key, None)
|
||||
if row_key in self._row_order:
|
||||
self._row_order.remove(row_key)
|
||||
if self._selected_row_key == row_key:
|
||||
self._selected_row_key = self._row_order[0] if self._row_order else None
|
||||
|
||||
def update_cell(self, row_key, column_key, value):
|
||||
row = list(self.rows[row_key])
|
||||
row[int(column_key)] = value
|
||||
self.rows[row_key] = tuple(row)
|
||||
|
||||
|
||||
class FakeMediaDescriptor:
|
||||
def __init__(self, track_descriptors):
|
||||
self._track_descriptors = list(track_descriptors)
|
||||
|
||||
def getTrackDescriptors(self):
|
||||
return list(self._track_descriptors)
|
||||
|
||||
|
||||
class FakeValueWidget:
|
||||
def __init__(self, value):
|
||||
self.value = value
|
||||
|
||||
|
||||
class FakeInputWidget:
|
||||
def __init__(self, value):
|
||||
self.value = value
|
||||
|
||||
|
||||
class FakeSelectionListWidget:
|
||||
def __init__(self, selected):
|
||||
self.selected = selected
|
||||
|
||||
|
||||
def make_track_descriptor(index, sub_index, track_type):
|
||||
return TrackDescriptor(
|
||||
index=index,
|
||||
sub_index=sub_index,
|
||||
track_type=track_type,
|
||||
codec_name=TrackCodec.UNKNOWN,
|
||||
audio_layout=AudioLayout.LAYOUT_UNDEFINED,
|
||||
)
|
||||
|
||||
|
||||
def make_show_descriptor(show_id, name="Show", year=2000):
|
||||
return ShowDescriptor(
|
||||
id=show_id,
|
||||
name=name,
|
||||
year=year,
|
||||
)
|
||||
|
||||
|
||||
class TagTableScreenStateTests(unittest.TestCase):
|
||||
def test_track_details_screen_reads_selected_tag_from_raw_row_mapping(self):
|
||||
screen = object.__new__(TrackDetailsScreen)
|
||||
screen.trackTagsTable = FakeTagTable()
|
||||
screen._TrackDetailsScreen__draftTrackTags = {
|
||||
"BPS": "4835",
|
||||
"KEEP_ME": "plain",
|
||||
}
|
||||
screen._TrackDetailsScreen__ignoreTrackKeys = ["KEEP_ME"]
|
||||
screen._TrackDetailsScreen__removeTrackKeys = ["BPS"]
|
||||
screen._TrackDetailsScreen__tagRowData = {}
|
||||
|
||||
screen.updateTags()
|
||||
|
||||
self.assertEqual(
|
||||
("[red]BPS[/red]", "[red]4835[/red]"),
|
||||
screen.trackTagsTable.rows["row-0"],
|
||||
)
|
||||
self.assertEqual(
|
||||
("BPS", "4835"),
|
||||
screen.getSelectedTag(),
|
||||
)
|
||||
|
||||
def test_track_details_screen_reads_select_values_from_widget_state(self):
|
||||
screen = object.__new__(TrackDetailsScreen)
|
||||
screen.context = {"logger": get_ffx_logger()}
|
||||
screen._TrackDetailsScreen__trackDescriptor = None
|
||||
screen._TrackDetailsScreen__patternId = 5
|
||||
screen._TrackDetailsScreen__index = 2
|
||||
screen._TrackDetailsScreen__subIndex = 0
|
||||
screen._TrackDetailsScreen__trackCodec = TrackCodec.UNKNOWN
|
||||
screen._TrackDetailsScreen__draftTrackTags = {"KEEP": "value"}
|
||||
|
||||
widgets = {
|
||||
"#type_select": FakeValueWidget(TrackType.AUDIO),
|
||||
"#audio_layout_select": FakeValueWidget(AudioLayout.LAYOUT_STEREO),
|
||||
"#language_select": FakeValueWidget(IsoLanguage.GERMAN),
|
||||
"#title_input": FakeInputWidget("German Audio"),
|
||||
"#dispositions_selection_list": FakeSelectionListWidget({0, 6}),
|
||||
}
|
||||
screen.query_one = lambda selector, _widget_type=None: widgets[selector]
|
||||
|
||||
descriptor = screen.getTrackDescriptorFromInput()
|
||||
|
||||
self.assertEqual(TrackType.AUDIO, descriptor.getType())
|
||||
self.assertEqual(AudioLayout.LAYOUT_STEREO, descriptor.getAudioLayout())
|
||||
self.assertEqual("deu", descriptor.getTags()["language"])
|
||||
self.assertEqual("German Audio", descriptor.getTitle())
|
||||
self.assertEqual("value", descriptor.getTags()["KEEP"])
|
||||
|
||||
def test_pattern_details_screen_reads_selected_track_from_row_mapping(self):
|
||||
first_track = make_track_descriptor(0, 0, TrackType.VIDEO)
|
||||
second_track = make_track_descriptor(1, 0, TrackType.SUBTITLE)
|
||||
|
||||
screen = object.__new__(PatternDetailsScreen)
|
||||
screen.tracksTable = FakeTagTable()
|
||||
screen._PatternDetailsScreen__draftTracks = [first_track, second_track]
|
||||
screen._PatternDetailsScreen__pattern = None
|
||||
screen._PatternDetailsScreen__trackRowData = {}
|
||||
|
||||
screen.updateTracks()
|
||||
screen.tracksTable.select_row("row-1")
|
||||
|
||||
self.assertIs(second_track, screen.getSelectedTrackDescriptor())
|
||||
|
||||
def test_pattern_details_screen_reads_selected_tag_from_raw_row_mapping(self):
|
||||
screen = object.__new__(PatternDetailsScreen)
|
||||
screen.tagsTable = FakeTagTable()
|
||||
screen._PatternDetailsScreen__pattern = None
|
||||
screen._PatternDetailsScreen__draftTags = {
|
||||
"BPS": "4835",
|
||||
"TITLE": "Deutsch [FN]",
|
||||
}
|
||||
screen._PatternDetailsScreen__ignoreGlobalKeys = ["TITLE"]
|
||||
screen._PatternDetailsScreen__removeGlobalKeys = ["BPS"]
|
||||
screen._PatternDetailsScreen__tagRowData = {}
|
||||
|
||||
screen.updateTags()
|
||||
|
||||
self.assertEqual(
|
||||
("[red]BPS[/red]", "[red]4835[/red]"),
|
||||
screen.tagsTable.rows["row-0"],
|
||||
)
|
||||
self.assertEqual(
|
||||
("BPS", "4835"),
|
||||
screen.getSelectedTag(),
|
||||
)
|
||||
|
||||
def test_media_details_screen_reads_selected_track_from_row_mapping(self):
|
||||
first_track = make_track_descriptor(0, 0, TrackType.VIDEO)
|
||||
second_track = make_track_descriptor(1, 0, TrackType.SUBTITLE)
|
||||
|
||||
screen = object.__new__(MediaDetailsScreen)
|
||||
screen.tracksTable = FakeTagTable()
|
||||
screen._MediaDetailsScreen__sourceMediaDescriptor = FakeMediaDescriptor(
|
||||
[first_track, second_track]
|
||||
)
|
||||
screen._MediaDetailsScreen__trackRowData = {}
|
||||
|
||||
screen.updateTracks()
|
||||
screen.tracksTable.select_row("row-1")
|
||||
|
||||
self.assertIs(second_track, screen.getSelectedTrackDescriptor())
|
||||
|
||||
def test_pattern_details_screen_reads_selected_shifted_season_from_row_mapping(self):
|
||||
screen = object.__new__(PatternDetailsScreen)
|
||||
screen.shiftedSeasonsTable = FakeTagTable()
|
||||
screen._PatternDetailsScreen__pattern = object()
|
||||
screen._PatternDetailsScreen__shiftedSeasonRowData = {}
|
||||
|
||||
row_key = screen.shiftedSeasonsTable.add_row("9", "1", "3", "1", "0")
|
||||
screen._PatternDetailsScreen__shiftedSeasonRowData[row_key] = {
|
||||
"id": 44,
|
||||
"original_season": 9,
|
||||
"first_episode": 1,
|
||||
"last_episode": 3,
|
||||
"season_offset": 1,
|
||||
"episode_offset": 0,
|
||||
}
|
||||
screen.shiftedSeasonsTable.rows[row_key] = ("broken", "ui", "values", "!", "?")
|
||||
|
||||
self.assertEqual(
|
||||
{
|
||||
"id": 44,
|
||||
"original_season": 9,
|
||||
"first_episode": 1,
|
||||
"last_episode": 3,
|
||||
"season_offset": 1,
|
||||
"episode_offset": 0,
|
||||
},
|
||||
screen.getSelectedShiftedSeasonObjFromInput(),
|
||||
)
|
||||
|
||||
def test_show_details_screen_reads_selected_pattern_from_row_mapping(self):
|
||||
screen = object.__new__(ShowDetailsScreen)
|
||||
screen.patternTable = FakeTagTable()
|
||||
screen._ShowDetailsScreen__showDescriptor = make_show_descriptor(7, "Demo", 1999)
|
||||
screen._ShowDetailsScreen__patternRowData = {}
|
||||
|
||||
row_key = screen._add_pattern_row(pattern_id=11, pattern_text=r"^demo_(s[0-9]+e[0-9]+)\.mkv$")
|
||||
screen.patternTable.rows[row_key] = ("display text changed",)
|
||||
|
||||
self.assertEqual(
|
||||
{
|
||||
"id": 11,
|
||||
"show_id": 7,
|
||||
"pattern": r"^demo_(s[0-9]+e[0-9]+)\.mkv$",
|
||||
},
|
||||
screen.getSelectedPatternDescriptor(),
|
||||
)
|
||||
|
||||
def test_show_details_screen_reads_selected_shifted_season_from_row_mapping(self):
|
||||
screen = object.__new__(ShowDetailsScreen)
|
||||
screen.shiftedSeasonsTable = FakeTagTable()
|
||||
screen._ShowDetailsScreen__shiftedSeasonRowData = {}
|
||||
|
||||
row_key = screen.shiftedSeasonsTable.add_row("1", "", "", "0", "0")
|
||||
screen._ShowDetailsScreen__shiftedSeasonRowData[row_key] = {
|
||||
"id": 3,
|
||||
"original_season": 1,
|
||||
"first_episode": -1,
|
||||
"last_episode": -1,
|
||||
"season_offset": 0,
|
||||
"episode_offset": 0,
|
||||
}
|
||||
screen.shiftedSeasonsTable.rows[row_key] = ("bad", "visible", "data", "x", "y")
|
||||
|
||||
self.assertEqual(
|
||||
{
|
||||
"id": 3,
|
||||
"original_season": 1,
|
||||
"first_episode": -1,
|
||||
"last_episode": -1,
|
||||
"season_offset": 0,
|
||||
"episode_offset": 0,
|
||||
},
|
||||
screen.getSelectedShiftedSeasonObjFromInput(),
|
||||
)
|
||||
|
||||
def test_shows_screen_reads_selected_show_id_from_row_mapping(self):
|
||||
screen = object.__new__(ShowsScreen)
|
||||
screen.table = FakeTagTable()
|
||||
screen._ShowsScreen__showRowData = {}
|
||||
|
||||
row_key = screen._add_show_row(make_show_descriptor(4, "Mapped", 2011))
|
||||
screen.table.rows[row_key] = ("999", "Visible", "2099")
|
||||
|
||||
self.assertEqual(4, screen.getSelectedShowId())
|
||||
|
||||
def test_media_details_screen_reads_selected_show_from_row_mapping(self):
|
||||
screen = object.__new__(MediaDetailsScreen)
|
||||
screen.showsTable = FakeTagTable()
|
||||
screen._MediaDetailsScreen__showRowData = {}
|
||||
|
||||
placeholder_key = screen._add_show_row(None)
|
||||
show_key = screen._add_show_row(make_show_descriptor(8, "Real Show", 2020))
|
||||
screen.showsTable.select_row(show_key)
|
||||
screen.showsTable.rows[show_key] = ("oops", "display", "changed")
|
||||
|
||||
selected_show = screen.getSelectedShowDescriptor()
|
||||
|
||||
self.assertIsInstance(selected_show, ShowDescriptor)
|
||||
self.assertEqual(8, selected_show.getId())
|
||||
self.assertEqual(0, screen.getRowIndexFromShowId(-1))
|
||||
self.assertEqual(1, screen.getRowIndexFromShowId(8))
|
||||
|
||||
screen.removeShow(-1)
|
||||
self.assertNotIn(placeholder_key, screen._MediaDetailsScreen__showRowData)
|
||||
self.assertEqual(0, screen.getRowIndexFromShowId(8))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -1,386 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
DEV_BRANCH="dev"
|
||||
MAIN_BRANCH="main"
|
||||
ORIGIN_REMOTE="origin"
|
||||
DEFAULT_AGENT_DEVELOPMENT_PATHS=(
|
||||
"AGENTS.md"
|
||||
"SCRATCHPAD.md"
|
||||
"guidance"
|
||||
"requirements"
|
||||
"prompts"
|
||||
"process"
|
||||
"tools/merge_dev_into_main.sh"
|
||||
)
|
||||
AGENT_DEVELOPMENT_PATHS=("${DEFAULT_AGENT_DEVELOPMENT_PATHS[@]}")
|
||||
|
||||
CURRENT_BRANCH="${DEV_BRANCH}"
|
||||
ASSUME_YES=0
|
||||
DRY_RUN=0
|
||||
SKIP_TESTS=0
|
||||
|
||||
usage() {
|
||||
cat <<EOF
|
||||
Usage: $(basename "$0") [--yes] [--dry-run] [--skip-tests] [--help]
|
||||
|
||||
Merge the local ${DEV_BRANCH} branch into ${MAIN_BRANCH}, remove agent-development files
|
||||
from ${MAIN_BRANCH}, auto-resolve merge conflicts limited to those cleanup paths,
|
||||
create a release merge commit and tag, push to ${ORIGIN_REMOTE}/${MAIN_BRANCH}, and
|
||||
switch back to ${DEV_BRANCH}.
|
||||
|
||||
Options:
|
||||
--yes Skip the interactive confirmation prompt.
|
||||
--dry-run Print the validated release plan without changing git state.
|
||||
--skip-tests Skip the default pre-release test gate (./tools/test.sh).
|
||||
--help Show this help text.
|
||||
|
||||
Environment overrides:
|
||||
FFX_RELEASE_CLEAN_PATHS Colon-separated path list to remove from ${MAIN_BRANCH}
|
||||
after merging ${DEV_BRANCH}. Defaults to:
|
||||
${DEFAULT_AGENT_DEVELOPMENT_PATHS[*]}
|
||||
EOF
|
||||
}
|
||||
|
||||
fail() {
|
||||
printf '%s\n' "$*" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
cleanup() {
|
||||
local exit_code="$1"
|
||||
|
||||
trap - EXIT
|
||||
|
||||
if git rev-parse -q --verify MERGE_HEAD >/dev/null 2>&1; then
|
||||
printf 'Merge is incomplete; aborting merge on %s...\n' "${CURRENT_BRANCH}" >&2
|
||||
git merge --abort >/dev/null 2>&1 || true
|
||||
fi
|
||||
|
||||
if [ "${CURRENT_BRANCH}" != "${DEV_BRANCH}" ]; then
|
||||
printf 'Switching back to %s...\n' "${DEV_BRANCH}" >&2
|
||||
git switch "${DEV_BRANCH}" >/dev/null 2>&1 || true
|
||||
CURRENT_BRANCH="${DEV_BRANCH}"
|
||||
fi
|
||||
|
||||
exit "${exit_code}"
|
||||
}
|
||||
|
||||
load_cleanup_paths() {
|
||||
if [ -n "${FFX_RELEASE_CLEAN_PATHS:-}" ]; then
|
||||
IFS=':' read -r -a AGENT_DEVELOPMENT_PATHS <<< "${FFX_RELEASE_CLEAN_PATHS}"
|
||||
fi
|
||||
|
||||
if [ "${#AGENT_DEVELOPMENT_PATHS[@]}" -eq 0 ]; then
|
||||
fail "Release cleanup path list is empty."
|
||||
fi
|
||||
}
|
||||
|
||||
path_is_cleanup_target() {
|
||||
local candidate_path="$1"
|
||||
local cleanup_path=""
|
||||
|
||||
for cleanup_path in "${AGENT_DEVELOPMENT_PATHS[@]}"; do
|
||||
case "${candidate_path}" in
|
||||
"${cleanup_path}"|"${cleanup_path}"/*)
|
||||
return 0
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
auto_resolve_cleanup_conflicts() {
|
||||
local unmerged_paths=()
|
||||
local non_cleanup_conflicts=()
|
||||
local remaining_conflicts=()
|
||||
local conflicted_path=""
|
||||
|
||||
mapfile -t unmerged_paths < <(git diff --name-only --diff-filter=U)
|
||||
if [ "${#unmerged_paths[@]}" -eq 0 ]; then
|
||||
return 1
|
||||
fi
|
||||
|
||||
for conflicted_path in "${unmerged_paths[@]}"; do
|
||||
if ! path_is_cleanup_target "${conflicted_path}"; then
|
||||
non_cleanup_conflicts+=("${conflicted_path}")
|
||||
fi
|
||||
done
|
||||
|
||||
if [ "${#non_cleanup_conflicts[@]}" -ne 0 ]; then
|
||||
printf 'Merge produced non-cleanup conflicts:\n' >&2
|
||||
for conflicted_path in "${non_cleanup_conflicts[@]}"; do
|
||||
printf ' - %s\n' "${conflicted_path}" >&2
|
||||
done
|
||||
return 1
|
||||
fi
|
||||
|
||||
printf 'Auto-resolving merge conflicts for release-cleanup paths:\n'
|
||||
for conflicted_path in "${unmerged_paths[@]}"; do
|
||||
printf ' - %s\n' "${conflicted_path}"
|
||||
done
|
||||
|
||||
git rm -r -f --ignore-unmatch "${AGENT_DEVELOPMENT_PATHS[@]}" >/dev/null
|
||||
|
||||
mapfile -t remaining_conflicts < <(git diff --name-only --diff-filter=U)
|
||||
if [ "${#remaining_conflicts[@]}" -ne 0 ]; then
|
||||
printf 'Cleanup conflict auto-resolution left unresolved paths:\n' >&2
|
||||
for conflicted_path in "${remaining_conflicts[@]}"; do
|
||||
printf ' - %s\n' "${conflicted_path}" >&2
|
||||
done
|
||||
return 1
|
||||
fi
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
require_repo_state() {
|
||||
if ! git rev-parse --show-toplevel >/dev/null 2>&1; then
|
||||
fail "This helper must be run inside a git repository."
|
||||
fi
|
||||
|
||||
if ! git show-ref --verify --quiet "refs/heads/${DEV_BRANCH}"; then
|
||||
fail "Local branch '${DEV_BRANCH}' does not exist."
|
||||
fi
|
||||
|
||||
if ! git show-ref --verify --quiet "refs/heads/${MAIN_BRANCH}"; then
|
||||
fail "Local branch '${MAIN_BRANCH}' does not exist."
|
||||
fi
|
||||
|
||||
if ! git remote get-url "${ORIGIN_REMOTE}" >/dev/null 2>&1; then
|
||||
fail "Remote '${ORIGIN_REMOTE}' is not configured."
|
||||
fi
|
||||
}
|
||||
|
||||
require_dev_checkout() {
|
||||
CURRENT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
|
||||
if [ "${CURRENT_BRANCH}" != "${DEV_BRANCH}" ]; then
|
||||
fail "Current branch is '${CURRENT_BRANCH}', but '${DEV_BRANCH}' is required."
|
||||
fi
|
||||
}
|
||||
|
||||
require_clean_worktree() {
|
||||
if [ -n "$(git status --porcelain)" ]; then
|
||||
fail "Local '${DEV_BRANCH}' branch is dirty. Commit, stash, or clean changes first."
|
||||
fi
|
||||
}
|
||||
|
||||
fetch_remote_state() {
|
||||
printf 'Fetching %s branch and tag state...\n' "${ORIGIN_REMOTE}"
|
||||
git fetch "${ORIGIN_REMOTE}" "${DEV_BRANCH}" "${MAIN_BRANCH}" --tags >/dev/null
|
||||
}
|
||||
|
||||
require_branch_matches_remote() {
|
||||
local branch="$1"
|
||||
local local_sha=""
|
||||
local remote_sha=""
|
||||
|
||||
if ! git show-ref --verify --quiet "refs/remotes/${ORIGIN_REMOTE}/${branch}"; then
|
||||
fail "Remote branch '${ORIGIN_REMOTE}/${branch}' does not exist."
|
||||
fi
|
||||
|
||||
local_sha="$(git rev-parse "refs/heads/${branch}")"
|
||||
remote_sha="$(git rev-parse "refs/remotes/${ORIGIN_REMOTE}/${branch}")"
|
||||
|
||||
if [ "${local_sha}" != "${remote_sha}" ]; then
|
||||
fail "Local branch '${branch}' is not up to date with '${ORIGIN_REMOTE}/${branch}'. Pull, rebase, or push first."
|
||||
fi
|
||||
}
|
||||
|
||||
resolve_release_version() {
|
||||
local version_from_pyproject=""
|
||||
local version_from_constants=""
|
||||
|
||||
version_from_pyproject="$(
|
||||
sed -n 's/^version = "\(.*\)"$/\1/p' pyproject.toml | head -n 1
|
||||
)"
|
||||
version_from_constants="$(
|
||||
sed -n "s/^VERSION='\(.*\)'$/\1/p" src/ffx/constants.py | head -n 1
|
||||
)"
|
||||
|
||||
if [ -z "${version_from_pyproject}" ]; then
|
||||
fail "Could not resolve release version from pyproject.toml."
|
||||
fi
|
||||
|
||||
if [ -z "${version_from_constants}" ]; then
|
||||
fail "Could not resolve release version from src/ffx/constants.py."
|
||||
fi
|
||||
|
||||
if [ "${version_from_pyproject}" != "${version_from_constants}" ]; then
|
||||
fail "Version mismatch: pyproject.toml=${version_from_pyproject}, src/ffx/constants.py=${version_from_constants}."
|
||||
fi
|
||||
|
||||
printf '%s\n' "${version_from_pyproject}"
|
||||
}
|
||||
|
||||
require_release_tag_available() {
|
||||
local release_version="$1"
|
||||
local release_tag="v${release_version}"
|
||||
|
||||
if git rev-parse -q --verify "refs/tags/${release_tag}" >/dev/null 2>&1; then
|
||||
fail "Tag '${release_tag}' already exists."
|
||||
fi
|
||||
|
||||
if git rev-parse -q --verify "refs/tags/${release_version}" >/dev/null 2>&1; then
|
||||
fail "Bare tag '${release_version}' already exists; refusing to create ambiguous release tags."
|
||||
fi
|
||||
}
|
||||
|
||||
run_pre_release_tests() {
|
||||
if [ "${SKIP_TESTS}" -eq 1 ]; then
|
||||
printf 'Skipping pre-release tests.\n'
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [ ! -x "./tools/test.sh" ]; then
|
||||
fail "Missing executable test runner at ./tools/test.sh."
|
||||
fi
|
||||
|
||||
printf 'Running pre-release tests via ./tools/test.sh...\n'
|
||||
./tools/test.sh
|
||||
}
|
||||
|
||||
print_release_plan() {
|
||||
local release_version="$1"
|
||||
local release_tag="v${release_version}"
|
||||
local release_commit_message="Release ${release_tag}"
|
||||
|
||||
printf 'Dry run only. Planned steps:\n'
|
||||
printf '1. Ensure current branch is %s and the worktree is clean.\n' "${DEV_BRANCH}"
|
||||
printf '2. Fetch %s and verify local %s and %s exactly match %s/%s and %s/%s.\n' \
|
||||
"${ORIGIN_REMOTE}" \
|
||||
"${DEV_BRANCH}" \
|
||||
"${MAIN_BRANCH}" \
|
||||
"${ORIGIN_REMOTE}" \
|
||||
"${DEV_BRANCH}" \
|
||||
"${ORIGIN_REMOTE}" \
|
||||
"${MAIN_BRANCH}"
|
||||
if [ "${SKIP_TESTS}" -eq 1 ]; then
|
||||
printf '3. Skip the pre-release test gate.\n'
|
||||
else
|
||||
printf '3. Run ./tools/test.sh as the pre-release test gate.\n'
|
||||
fi
|
||||
printf '4. Switch to %s and merge %s with --no-ff --no-commit.\n' "${MAIN_BRANCH}" "${DEV_BRANCH}"
|
||||
printf '5. Auto-resolve merge conflicts limited to release-cleanup paths and remove them from %s:\n' "${MAIN_BRANCH}"
|
||||
local cleanup_path=""
|
||||
for cleanup_path in "${AGENT_DEVELOPMENT_PATHS[@]}"; do
|
||||
printf ' - %s\n' "${cleanup_path}"
|
||||
done
|
||||
printf '6. Create merge commit: %s\n' "${release_commit_message}"
|
||||
printf '7. Create annotated tag: %s\n' "${release_tag}"
|
||||
printf '8. Push %s to %s/%s with --follow-tags.\n' "${MAIN_BRANCH}" "${ORIGIN_REMOTE}" "${MAIN_BRANCH}"
|
||||
printf '9. Switch back to %s.\n' "${DEV_BRANCH}"
|
||||
}
|
||||
|
||||
trap 'cleanup $?' EXIT
|
||||
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
--yes)
|
||||
ASSUME_YES=1
|
||||
;;
|
||||
--dry-run)
|
||||
DRY_RUN=1
|
||||
;;
|
||||
--skip-tests)
|
||||
SKIP_TESTS=1
|
||||
;;
|
||||
--help|-h)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
usage >&2
|
||||
fail "Unknown option: $1"
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
load_cleanup_paths
|
||||
require_repo_state
|
||||
require_dev_checkout
|
||||
require_clean_worktree
|
||||
fetch_remote_state
|
||||
require_branch_matches_remote "${DEV_BRANCH}"
|
||||
require_branch_matches_remote "${MAIN_BRANCH}"
|
||||
|
||||
RELEASE_VERSION="$(resolve_release_version)"
|
||||
RELEASE_TAG="v${RELEASE_VERSION}"
|
||||
RELEASE_COMMIT_MESSAGE="Release ${RELEASE_TAG}"
|
||||
require_release_tag_available "${RELEASE_VERSION}"
|
||||
|
||||
printf 'This will merge %s into %s, remove agent-development files on %s,\n' "${DEV_BRANCH}" "${MAIN_BRANCH}" "${MAIN_BRANCH}"
|
||||
printf 'auto-resolve cleanup-path conflicts, run the pre-release gate%s, create %s,\n' \
|
||||
"$([ "${SKIP_TESTS}" -eq 1 ] && printf ' (skipped)' || printf '')" \
|
||||
"${RELEASE_TAG}"
|
||||
printf 'push to %s/%s, and switch back to %s.\n' \
|
||||
"${ORIGIN_REMOTE}" \
|
||||
"${MAIN_BRANCH}" \
|
||||
"${DEV_BRANCH}"
|
||||
|
||||
if [ "${ASSUME_YES}" -ne 1 ]; then
|
||||
printf 'Are you sure? [y/N] '
|
||||
read -r confirmation
|
||||
case "${confirmation}" in
|
||||
y|Y|yes|YES)
|
||||
;;
|
||||
*)
|
||||
fail "Aborted by user."
|
||||
;;
|
||||
esac
|
||||
fi
|
||||
|
||||
if [ "${DRY_RUN}" -eq 1 ]; then
|
||||
print_release_plan "${RELEASE_VERSION}"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
run_pre_release_tests
|
||||
require_clean_worktree
|
||||
fetch_remote_state
|
||||
require_branch_matches_remote "${DEV_BRANCH}"
|
||||
require_branch_matches_remote "${MAIN_BRANCH}"
|
||||
require_release_tag_available "${RELEASE_VERSION}"
|
||||
|
||||
git switch "${MAIN_BRANCH}" >/dev/null
|
||||
CURRENT_BRANCH="${MAIN_BRANCH}"
|
||||
|
||||
printf 'Merging %s into %s...\n' "${DEV_BRANCH}" "${MAIN_BRANCH}"
|
||||
if ! git merge --no-ff --no-commit "${DEV_BRANCH}"; then
|
||||
if ! auto_resolve_cleanup_conflicts; then
|
||||
fail "Merge from '${DEV_BRANCH}' into '${MAIN_BRANCH}' failed."
|
||||
fi
|
||||
fi
|
||||
|
||||
if ! git rev-parse -q --verify MERGE_HEAD >/dev/null 2>&1; then
|
||||
fail "'${MAIN_BRANCH}' is already up to date with '${DEV_BRANCH}'. Nothing to merge."
|
||||
fi
|
||||
|
||||
printf 'Removing agent-development files from %s...\n' "${MAIN_BRANCH}"
|
||||
git rm -r -f --ignore-unmatch "${AGENT_DEVELOPMENT_PATHS[@]}" >/dev/null
|
||||
|
||||
if git diff --cached --quiet; then
|
||||
fail "No staged changes are present after merging '${DEV_BRANCH}' into '${MAIN_BRANCH}'."
|
||||
fi
|
||||
|
||||
printf 'Creating release merge commit: %s\n' "${RELEASE_COMMIT_MESSAGE}"
|
||||
git commit -m "${RELEASE_COMMIT_MESSAGE}"
|
||||
|
||||
printf 'Creating annotated tag: %s\n' "${RELEASE_TAG}"
|
||||
git tag -a "${RELEASE_TAG}" -m "FFX ${RELEASE_VERSION}"
|
||||
|
||||
printf 'Pushing %s and annotated tags to %s...\n' "${MAIN_BRANCH}" "${ORIGIN_REMOTE}"
|
||||
git push "${ORIGIN_REMOTE}" "${MAIN_BRANCH}" --follow-tags
|
||||
|
||||
printf 'Switching back to %s...\n' "${DEV_BRANCH}"
|
||||
git switch "${DEV_BRANCH}" >/dev/null
|
||||
CURRENT_BRANCH="${DEV_BRANCH}"
|
||||
|
||||
printf 'Release merge complete: %s pushed to %s/%s and tagged as %s.\n' \
|
||||
"${RELEASE_COMMIT_MESSAGE}" \
|
||||
"${ORIGIN_REMOTE}" \
|
||||
"${MAIN_BRANCH}" \
|
||||
"${RELEASE_TAG}"
|
||||
Reference in New Issue
Block a user