commit ca080d8145c11ab21be6ff216e37af0eff84373a Author: fy59 Date: Sat Sep 5 19:05:07 2026 +0200 Bootstrap Trainlog project contract diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f15215f --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +# Build directories +build/ +builddir/ +meson-logs/ +meson-private/ + +# Android / Gradle +.gradle/ +local.properties +**/build/ + +# Editors +*.swp +*.swo +*~ +.idea/ +.vscode/ + +# Local databases +*.db +*.db-shm +*.db-wal + +# Local user data +data/ +exports/ + +# Python helpers +__pycache__/ +*.pyc + +# Temporary files +*.tmp +*.bak diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..637f320 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,187 @@ +# Trainlog Development Contract + +## 1. Scope + +Trainlog is composed of two applications sharing a versioned exchange format: + +- a lightweight Android application for fast workout data entry; +- a Unix/Linux TUI for storage, review, analysis, and visualization. + +The TUI SQLite database is the canonical long-term history. + +JSON files are the exchange contract between Android and the TUI. + +## 2. General development rules + +Every change must respect the following rules: + +1. behavior is defined before implementation; +2. code must be readable and deterministic; +3. errors must be handled explicitly; +4. user data must never be silently discarded; +5. persistent formats must be versioned; +6. importing the same data repeatedly must not create duplicates; +7. every new feature must be documented; +8. affected tests must be added or updated; +9. compiler warnings are treated as defects unless explicitly justified; +10. an undocumented or untested feature is not considered complete. + +## 3. TUI + +The TUI is implemented in C17. + +Planned dependencies: + +- ncursesw; +- SQLite3; +- a deliberately selected JSON library; +- Meson; +- Ninja. + +The business logic, persistence layer, and ncurses rendering layer must remain separated. + +SQLite calls must not be scattered through rendering code. + +Important business rules must not depend directly on ncurses. + +## 4. Android + +The Android application is a data-entry client. + +It must remain intentionally simple and must not become the primary analytics or historical store. + +It must support: + +- starting a workout session; +- automatic recording of the start time; +- selecting or creating an exercise; +- entering planned sets and repetitions; +- entering actual sets and repetitions; +- entering load; +- entering planned rest time; +- entering body weight and supported measurements; +- automatic recording of the end time; +- exporting a valid Trainlog JSON file. + +## 5. Documentation + +Documentation is mandatory. + +Primary documents: + +- `README.md`: user-facing project overview; +- `docs/architecture.md`: architecture and component boundaries; +- `docs/coding_style.md`: coding and commenting conventions; +- `docs/exchange_format.md`: JSON exchange contract; +- `docs/database.md`: SQLite schema and migration policy; +- `docs/tui.md`: TUI behavior and visual rules; +- `docs/android.md`: Android behavior and scope; +- `docs/tests.md`: validation strategy and commands; +- `docs/roadmap.md`: implementation order and gates. + +A behavior change must update the relevant documentation in the same change. + +## 6. Code comments + +Comments are mandatory when code expresses: + +- an invariant; +- a format constraint; +- an architectural decision; +- non-obvious logic; +- special error handling; +- a public API; +- an important data structure; +- an assumption required for correctness. + +Comments must not merely restate obvious code. + +Prefer explaining why a decision exists when the reason is not obvious from the code. + +## 7. Exchange format + +The Trainlog format is versioned. + +Each workout export must contain: + +- a format identifier; +- a schema version; +- a unique session identifier; +- ISO 8601 timestamps including an explicit UTC offset. + +Exercise identifiers are stable and permanent. + +An exercise display name may change without changing its identifier. + +Imports must be idempotent. + +A published format version must never receive an incompatible semantic change. + +## 8. TUI visual rules + +The TUI uses color when it improves understanding. + +Color must never be the sole carrier of information. + +Important states must remain understandable in monochrome terminals. + +Colors must be centralized in a dedicated theme module. + +The TUI must use `ncursesw` and handle UTF-8 correctly. + +Raw ANSI escape sequences are forbidden in ncurses rendering code unless explicitly documented and justified. + +## 9. Database + +SQLite is the canonical TUI store. + +The database schema must be versioned. + +Incompatible schema evolution requires an explicit migration. + +Integrity constraints must be used where appropriate, including: + +- foreign keys; +- unique identifiers; +- anti-duplication constraints. + +## 10. Validation + +Before every meaningful push: + +- build; +- run tests; +- verify formatting; +- verify compiler warnings; +- validate JSON examples against the schema; +- verify documentation impacted by the change. + +The repository must not knowingly be pushed in a broken state. + +## 11. Git workflow + +Forgejo is the primary repository. + +Primary remote: + +`ssh://git@git.labfytools.com:2223/fy59/trainlog.git` + +GitHub is a mirror: + +`git@github.com:labfytools/trainlog.git` + +Normal development must push to Forgejo. + +Do not develop directly against the GitHub mirror. + +## 12. Definition of Done + +A task is complete only when: + +- the expected behavior is implemented; +- the code builds without accepted warnings; +- relevant tests pass; +- new error paths are handled; +- documentation is current; +- examples and schemas are updated when required; +- no known regression is intentionally left behind. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1668383 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to Trainlog will be documented in this file. + +The project uses a simple pre-release changelog during early development. + +## Unreleased + +### Added + +- Initial repository structure. +- Development contract. +- Architecture documentation. +- Coding-style rules. +- Exchange-format v1 draft. +- JSON Schema draft for Trainlog v1. +- Initial example workout export. +- Database, TUI, Android, testing, and roadmap documentation. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5498bcf --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +# Trainlog + +Trainlog is a local-first workout log composed of: + +- a lightweight Android data-entry application; +- a colorful Unix/Linux TUI for history, statistics, graphs, and progress tracking. + +## Project goals + +Android is optimized for fast use during a workout: + +- start and end time; +- exercise selection; +- new exercise creation; +- planned sets and repetitions; +- actual sets and repetitions; +- load; +- rest time; +- body weight; +- body measurements; +- JSON export. + +The TUI is the main application: + +- import Android exports; +- create sessions directly from the terminal; +- maintain the canonical exercise catalog; +- maintain SQLite history; +- display workout history; +- track body weight; +- track body measurements; +- track performance; +- display colorful terminal graphs; +- export data for external use. + +## Architecture + +```text +Android + | + | Trainlog JSON + v +Trainlog TUI + | + v +SQLite +``` + +The TUI SQLite database is the canonical long-term store. + +The JSON exchange format is versioned and designed for idempotent imports. + +## Repository layout + +```text +android/ Android application +tui/ C17 ncursesw application +docs/ Canonical project documentation +format/ JSON schema and exchange-format material +examples/ Valid exchange examples +tools/ Development and validation tools +``` + +## Development principles + +- local-first; +- no mandatory cloud account; +- user-owned data; +- versioned persistent formats; +- stable exercise identifiers; +- idempotent imports; +- documentation and tests are part of every feature; +- clear separation between UI, business logic, and persistence. + +See `AGENTS.md` for the development contract. diff --git a/android/.gitkeep b/android/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/android.md b/docs/android.md new file mode 100644 index 0000000..ae878a1 --- /dev/null +++ b/docs/android.md @@ -0,0 +1,113 @@ +# Android Application + +## 1. Purpose + +The Android application is a lightweight training-session recorder. + +Its design priority is low-friction data entry during a workout. + +## 2. Session flow + +Expected flow: + +```text +Start session + | + v +record started_at + | + v +add exercises and targets + | + v +record actual sets + | + v +optional body data + | + v +Finish session + | + v +record ended_at + | + v +export Trainlog JSON +``` + +## 3. Exercise catalog + +The application maintains a local exercise catalog for selection. + +The user must not need to retype the same exercise every session. + +When a new exercise is created: + +- generate a stable `exercise_id`; +- store the display name; +- use that same identifier in future sessions; +- include the exercise catalog entry in exported files as required. + +## 4. Planned work + +The basic exercise form supports: + +- number of sets; +- repetitions or timed duration; +- load when relevant; +- rest duration. + +Example: + +```text +4 sets +5 repetitions +80 kg +60 seconds rest +``` + +## 5. Actual work + +The UI should pre-populate performed sets from the target when convenient. + +The user only needs to edit differences. + +Example target: + +```text +5 / 5 / 5 / 5 +``` + +Actual: + +```text +5 / 5 / 5 / 3 +``` + +The exported file must preserve both target and actual values. + +## 6. Timestamps + +`started_at` is recorded automatically when the session starts. + +`ended_at` is recorded automatically when the session ends. + +The UI may later allow explicit correction for forgotten starts or stops, but such correction must be visible to the user. + +## 7. Export + +The application exports valid Trainlog JSON. + +It must not silently export malformed or incomplete data. + +The application must validate required fields before final export. + +## 8. Non-goals + +Initial Android versions do not need: + +- advanced analytics; +- complex charts; +- a cloud account; +- a remote database; +- social features. diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..7d685b2 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,140 @@ +# Architecture + +## 1. Purpose + +Trainlog separates capture from analysis. + +The Android application is optimized for fast data entry during training. + +The TUI is optimized for durable storage, inspection, statistics, and visualization. + +## 2. Components + +### Android client + +Responsibilities: + +- start a session; +- record the session start timestamp; +- select an existing exercise; +- create a new exercise; +- record workout targets; +- record actual performed sets; +- record rest duration; +- record body data; +- record the session end timestamp; +- export one valid Trainlog JSON document. + +Non-responsibilities: + +- long-term analytics; +- canonical history; +- complex graphing; +- cloud synchronization. + +### Exchange format + +The exchange format is the compatibility boundary between Android and the TUI. + +It is: + +- JSON; +- UTF-8; +- versioned; +- self-contained enough to import newly created exercises; +- designed for idempotent import. + +### TUI + +Responsibilities: + +- import Trainlog JSON; +- reject malformed or incompatible input cleanly; +- deduplicate sessions; +- maintain the canonical exercise catalog; +- create workouts directly from the terminal; +- maintain SQLite history; +- calculate progress metrics; +- render graphs and summaries; +- export data when needed. + +### SQLite store + +SQLite is the canonical local history. + +The database must use: + +- foreign keys; +- uniqueness constraints; +- schema versioning; +- explicit migration rules. + +## 3. Data flow + +```text +Android + | + | export + v +Trainlog JSON + | + | import + validation + v +TUI application + | + | persistence + v +SQLite +``` + +## 4. Identity rules + +Exercises have: + +- a stable machine identifier: `exercise_id`; +- a mutable display name: `name`. + +The display name is not the identity. + +Sessions have: + +- a globally unique `session_id`. + +A second import of the same `session_id` must not duplicate the session. + +## 5. Separation rules for the TUI + +The C17 TUI will be split into layers: + +```text +ncursesw rendering + | + v +TUI state / navigation + | + v +application services + | + +---- exchange-format parser + | + +---- analytics + | + v +SQLite persistence +``` + +The rendering layer must not own business rules. + +The persistence layer must not depend on ncurses. + +## 6. Error philosophy + +Trainlog must prefer explicit failure over silent corruption. + +Examples: + +- malformed JSON: reject import with a precise error; +- unsupported format version: reject import; +- duplicate session: report already imported, do not duplicate; +- unknown exercise: import it when valid catalog data is present; +- incomplete active session: preserve it explicitly rather than silently inventing an end time. diff --git a/docs/coding_style.md b/docs/coding_style.md new file mode 100644 index 0000000..f91af4c --- /dev/null +++ b/docs/coding_style.md @@ -0,0 +1,122 @@ +# Coding Style + +## 1. General rules + +Code must optimize for readability, correctness, and maintainability. + +Avoid clever code when a straightforward implementation is easier to verify. + +## 2. C standard + +The TUI uses C17. + +The project will initially target a strict warning profile similar to: + +```text +-Wall +-Wextra +-Wpedantic +-Wconversion +-Wshadow +-Wformat=2 +``` + +Warnings must be reviewed individually. + +Do not disable a warning globally merely to hide one inconvenient case. + +## 3. Naming + +Public symbols use a `trainlog_` prefix. + +Examples: + +```c +trainlog_database_open(...) +trainlog_session_import(...) +``` + +Internal static functions use descriptive snake_case names. + +Types use descriptive names and avoid unnecessary abbreviations. + +## 4. Functions + +Functions should: + +- have one clear purpose; +- validate arguments when required by their contract; +- return explicit status values; +- avoid hidden global state. + +Prefer small composable functions over long functions mixing unrelated responsibilities. + +## 5. Comments + +Comments are required for: + +- public interfaces; +- invariants; +- non-obvious behavior; +- important ownership rules; +- format assumptions; +- error-handling decisions; +- algorithms whose intent is not immediately obvious. + +Bad: + +```c +i++; /* Increment i. */ +``` + +Good: + +```c +/* + * Keep the external exercise identifier unchanged after creation. + * Historical session rows refer to this stable identifier even when + * the user later renames the exercise. + */ +``` + +## 6. Formatting + +The project will use `clang-format`. + +A canonical `.clang-format` file will be added before substantial C implementation. + +Formatting changes should not be mixed with unrelated semantic changes when avoidable. + +## 7. Error handling + +Do not silently ignore errors. + +Do not use process termination for normal recoverable library errors. + +Return explicit status codes from internal APIs where practical. + +User-facing errors must be understandable and actionable. + +## 8. Ownership + +Every API that allocates, borrows, or transfers ownership must document that behavior. + +Do not rely on ambiguous lifetime assumptions. + +## 9. Integer and conversion safety + +Avoid implicit narrowing conversions. + +Validate external numeric input before conversion. + +Use types appropriate to the stored range and document any format bounds. + +## 10. Kotlin + +The Android side should favor: + +- immutable data where practical; +- explicit state transitions; +- small view models; +- no unnecessary framework abstraction; +- clear serialization types matching the Trainlog JSON contract. diff --git a/docs/database.md b/docs/database.md new file mode 100644 index 0000000..90365bc --- /dev/null +++ b/docs/database.md @@ -0,0 +1,106 @@ +# Database + +## 1. Purpose + +SQLite is the canonical long-term data store used by the TUI. + +The database is not the Android exchange format. + +## 2. Initial entities + +The initial data model is expected to contain: + +- schema metadata; +- exercises; +- sessions; +- session exercises; +- performed sets; +- body measurements; +- optional maximum-performance records. + +The exact SQL schema will be frozen before implementation. + +## 3. Exercise identity + +The database must preserve a stable external exercise identifier. + +Conceptually: + +```text +exercises + id internal SQLite primary key + exercise_id stable Trainlog identifier + name mutable display name +``` + +`exercise_id` must be unique. + +## 4. Session identity + +`session_id` must be unique. + +This is the primary anti-duplication barrier for imported sessions. + +## 5. Foreign keys + +SQLite foreign-key enforcement must be enabled explicitly for every connection: + +```sql +PRAGMA foreign_keys = ON; +``` + +Tests must verify that the expected constraints are actually active. + +## 6. Schema versioning + +The database must store an explicit schema version. + +Schema changes must be classified as: + +- additive and compatible; +- migration required; +- destructive and therefore forbidden without explicit migration logic. + +## 7. Transactions + +Multi-table imports must use transactions. + +A failed import must not leave a partially inserted session. + +Expected behavior: + +```text +BEGIN + validate + insert missing exercises + insert session + insert workout rows + insert performed sets +COMMIT +``` + +On failure: + +```text +ROLLBACK +``` + +## 8. Units + +Canonical storage units: + +- body weight: kilograms; +- load: kilograms; +- body measurements: centimeters; +- duration: seconds. + +The UI may format values differently later, but persistent units remain explicit and stable. + +## 9. Migration policy + +A schema migration must: + +- be deterministic; +- preserve user data; +- be testable from the previous supported version; +- update the stored schema version only after success. diff --git a/docs/exchange_format.md b/docs/exchange_format.md new file mode 100644 index 0000000..e15a42e --- /dev/null +++ b/docs/exchange_format.md @@ -0,0 +1,219 @@ +# Trainlog Exchange Format v1 + +## 1. Status + +This document defines the initial Trainlog v1 exchange contract. + +Until explicitly marked `FROZEN`, incompatible changes are allowed during early development. + +Once frozen, incompatible changes require a new format version. + +## 2. Encoding + +A Trainlog exchange document is: + +- JSON; +- UTF-8; +- one top-level JSON object. + +## 3. Required top-level fields + +```json +{ + "format": "trainlog", + "version": 1, + "exercises": [], + "session": {} +} +``` + +### `format` + +Must equal: + +```text +trainlog +``` + +### `version` + +Integer schema version. + +For this document: + +```text +1 +``` + +## 4. Exercise catalog entries + +Each exercise entry contains: + +```json +{ + "exercise_id": "leg_press", + "name": "Presse à cuisses" +} +``` + +### `exercise_id` + +Stable identifier. + +Rules: + +- non-empty; +- unique within the document; +- treated as identity; +- must not change merely because the display name changes. + +### `name` + +Human-readable display name. + +The TUI may update the local display name later without changing `exercise_id`. + +## 5. Session + +Required fields: + +- `session_id`; +- `started_at`; +- `ended_at`; +- `exercises`. + +Optional body fields may include: + +- `body_weight_kg`; +- `measurements`. + +## 6. Session identifier + +Example: + +```text +20260905-183412-a84c +``` + +The exact generation algorithm is implementation-defined in v1. + +The invariant is uniqueness. + +The TUI must enforce uniqueness at import. + +## 7. Timestamps + +Timestamps use ISO 8601 with an explicit UTC offset. + +Example: + +```text +2026-09-05T18:34:12+02:00 +``` + +The timezone offset is part of the serialized value. + +The TUI must not silently reinterpret a timestamp as local time without using the encoded offset. + +## 8. Workout exercise entry + +Example: + +```json +{ + "exercise_id": "leg_press", + "rest_seconds": 60, + "target": { + "sets": 4, + "reps": 5, + "weight_kg": 80 + }, + "sets": [ + { "reps": 5, "weight_kg": 80 }, + { "reps": 5, "weight_kg": 80 }, + { "reps": 5, "weight_kg": 80 }, + { "reps": 3, "weight_kg": 80 } + ] +} +``` + +The `target` object describes the intended work. + +The `sets` array describes what was actually performed. + +These two concepts must remain distinct. + +## 9. Timed exercises + +Timed exercises such as planks use `duration_seconds`. + +Example: + +```json +{ + "exercise_id": "plank", + "rest_seconds": 60, + "target": { + "sets": 3, + "duration_seconds": 45 + }, + "sets": [ + { "duration_seconds": 45 }, + { "duration_seconds": 45 }, + { "duration_seconds": 38 } + ] +} +``` + +A set may represent repetitions or duration. + +The schema forbids an empty set object. + +## 10. Body measurements + +The initial v1 measurement object supports named measurements in centimeters. + +Example: + +```json +{ + "measurements": { + "waist_cm": 91.0, + "chest_cm": 104.0, + "left_arm_cm": 35.0, + "right_arm_cm": 35.0, + "left_thigh_cm": 58.0, + "right_thigh_cm": 57.0 + } +} +``` + +The initial schema intentionally uses explicit field names rather than arbitrary free-form keys. + +Additional measurements may be added before v1 is frozen. + +## 11. Idempotent import + +The TUI must treat `session_id` as a uniqueness key. + +If a session has already been imported: + +- do not create another session; +- do not duplicate its sets; +- report that the session already exists. + +## 12. New exercises + +When Android exports a session containing an exercise unknown to the TUI: + +1. the exercise must exist in the top-level `exercises` array; +2. its `exercise_id` must be valid; +3. its `name` must be non-empty; +4. the TUI imports the catalog entry; +5. the session may then reference that exercise. + +## 13. Unknown fields + +Before v1 is frozen, implementations may reject unknown fields during development to catch mistakes early. + +The final forward-compatibility policy will be frozen explicitly before release. diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 0000000..be95dbb --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,113 @@ +# Roadmap + +## Gate 0 — Project contract + +Status: IN PROGRESS + +Deliverables: + +- repository structure; +- development contract; +- architecture documentation; +- coding-style documentation; +- exchange-format v1 draft; +- JSON Schema draft; +- valid example fixture. + +Exit criteria: + +- documentation reviewed; +- JSON example validates against the schema; +- repository clean after commit. + +## Gate 1 — Exchange format v1 freeze + +Deliverables: + +- complete field list; +- exercise identity rules; +- session identity rules; +- repetitions and timed-set representation; +- rest representation; +- body weight; +- measurement list; +- unknown-field policy; +- invalid fixture suite. + +Exit criteria: + +- `TRAINLOG_FORMAT_V1=FROZEN`; +- schema tests pass; +- Android and TUI can implement against the contract without ambiguity. + +## Gate 2 — TUI persistence core + +Deliverables: + +- Meson C17 project; +- SQLite open/create; +- schema versioning; +- exercise catalog; +- session import transaction; +- idempotent import tests. + +Exit criteria: + +- database tests pass; +- sanitizer validation passes. + +## Gate 3 — Minimal TUI + +Deliverables: + +- ncursesw initialization; +- theme module; +- dashboard shell; +- exercise list; +- session history; +- import screen; +- minimum-terminal fallback. + +Exit criteria: + +- usable color TUI; +- monochrome fallback; +- UTF-8 test pass. + +## Gate 4 — Android recorder + +Deliverables: + +- local exercise catalog; +- start/stop session timestamps; +- target entry; +- actual-set entry; +- rest entry; +- body data; +- JSON export. + +Exit criteria: + +- exported fixture validates against frozen v1; +- exported file imports successfully into the TUI. + +## Gate 5 — Analytics + +Deliverables: + +- body-weight trend; +- measurement trend; +- exercise performance trend; +- training volume summaries; +- terminal graphs. + +## Gate 6 — Hardening + +Deliverables: + +- broader fixture coverage; +- migrations; +- import/export robustness; +- documentation cleanup; +- packaging; +- first tagged release. diff --git a/docs/tests.md b/docs/tests.md new file mode 100644 index 0000000..80d091e --- /dev/null +++ b/docs/tests.md @@ -0,0 +1,77 @@ +# Tests and Validation + +## 1. Principle + +A feature is not complete without its relevant validation. + +## 2. Validation layers + +Trainlog will use: + +- unit tests; +- integration tests; +- JSON Schema validation; +- database constraint tests; +- TUI smoke tests; +- sanitizer builds where practical. + +## 3. Exchange-format tests + +The repository must contain valid and invalid fixtures. + +Valid fixtures must pass the schema. + +Invalid fixtures should cover: + +- missing required fields; +- duplicate exercise identifiers; +- invalid timestamps; +- invalid negative values; +- empty set data; +- malformed targets; +- unsupported format version. + +## 4. Database tests + +Tests must verify: + +- foreign keys are active; +- duplicate `session_id` is rejected or handled idempotently; +- duplicate `exercise_id` is rejected; +- failed imports roll back completely; +- migrations preserve data. + +## 5. C validation + +Initial build validation should include: + +```text +normal build +strict warning build +ASan/UBSan build +``` + +Exact commands will be frozen when `meson.build` exists. + +## 6. TUI tests + +At minimum: + +- application starts in a supported terminal; +- small-terminal fallback works; +- navigation does not corrupt state; +- UTF-8 labels render correctly; +- monochrome fallback remains understandable. + +## 7. Pre-push checklist + +Before a meaningful push: + +1. format code; +2. build; +3. run tests; +4. validate JSON fixtures; +5. run sanitizer suite when relevant; +6. run `git diff --check`; +7. inspect `git status`; +8. update documentation. diff --git a/docs/tui.md b/docs/tui.md new file mode 100644 index 0000000..148969b --- /dev/null +++ b/docs/tui.md @@ -0,0 +1,110 @@ +# TUI + +## 1. Purpose + +The Trainlog TUI is the primary history, analysis, and visualization application. + +It is implemented in C17 with `ncursesw`. + +## 2. Primary screens + +Initial screen plan: + +- Dashboard; +- Sessions; +- New session; +- Exercises; +- Body; +- Import. + +The final key bindings will be frozen before implementation. + +## 3. Color + +The TUI should be visually rich but remain readable. + +Color is used to reinforce meaning, never as the only indicator. + +Conceptual roles: + +- accent: titles, active selection, highlighted metrics; +- success: completed target; +- warning: partial target or attention state; +- error: invalid input or failed operation; +- muted: secondary information; +- graph series: consistent distinguishable colors. + +All color pairs must be centralized in a theme module. + +Do not scatter raw `COLOR_*` decisions throughout screens. + +## 4. Monochrome fallback + +Every meaningful color state must also have a textual or symbolic representation. + +Examples: + +```text +✓ completed +! warning +x failed +> selected +``` + +## 5. UTF-8 + +The TUI uses wide-character ncurses support. + +The implementation must initialize locale correctly before ncurses use. + +Rendering must be tested with accented French text and common symbols. + +## 6. Dashboard + +The dashboard should eventually show: + +- current body weight; +- recent body-weight change; +- number of sessions in a selected period; +- total training duration; +- recent performance highlights; +- compact terminal graphs. + +## 7. New session + +The TUI must be able to record a workout directly, using the same logical exercise catalog as Android. + +A typical exercise form contains: + +- exercise; +- target sets; +- target repetitions or duration; +- target load when relevant; +- rest duration; +- actual performed sets. + +## 8. Graphs + +Graphs must be terminal-native. + +Possible graph types: + +- weight trend; +- measurement trend; +- exercise load trend; +- estimated or measured max trend; +- training volume trend. + +Graphs should adapt to terminal size. + +## 9. Minimum terminal size + +A minimum supported terminal size will be defined during the first TUI milestone. + +Below the minimum size, Trainlog must display a clear message instead of rendering a broken layout. + +## 10. Input safety + +The TUI must validate numeric fields before committing data. + +Invalid input must not partially modify persistent state. diff --git a/examples/session-v1.json b/examples/session-v1.json new file mode 100644 index 0000000..765c913 --- /dev/null +++ b/examples/session-v1.json @@ -0,0 +1,74 @@ +{ + "format": "trainlog", + "version": 1, + "exercises": [ + { + "exercise_id": "leg_press", + "name": "Presse à cuisses" + }, + { + "exercise_id": "plank", + "name": "Gainage ventral" + } + ], + "session": { + "session_id": "20260905-183412-a84c", + "started_at": "2026-09-05T18:34:12+02:00", + "ended_at": "2026-09-05T19:27:48+02:00", + "body_weight_kg": 82.4, + "measurements": { + "waist_cm": 91.0, + "chest_cm": 104.0, + "left_arm_cm": 35.0, + "right_arm_cm": 35.0 + }, + "exercises": [ + { + "exercise_id": "leg_press", + "rest_seconds": 60, + "target": { + "sets": 4, + "reps": 5, + "weight_kg": 80 + }, + "sets": [ + { + "reps": 5, + "weight_kg": 80 + }, + { + "reps": 5, + "weight_kg": 80 + }, + { + "reps": 5, + "weight_kg": 80 + }, + { + "reps": 3, + "weight_kg": 80 + } + ] + }, + { + "exercise_id": "plank", + "rest_seconds": 60, + "target": { + "sets": 3, + "duration_seconds": 45 + }, + "sets": [ + { + "duration_seconds": 45 + }, + { + "duration_seconds": 45 + }, + { + "duration_seconds": 38 + } + ] + } + ] + } +} diff --git a/format/README.md b/format/README.md new file mode 100644 index 0000000..5613dd4 --- /dev/null +++ b/format/README.md @@ -0,0 +1,19 @@ +# Trainlog Format + +This directory contains machine-readable definitions of the Trainlog exchange format. + +Current draft: + +- `trainlog-v1.schema.json` + +Canonical human-readable semantics live in: + +- `docs/exchange_format.md` + +The schema is a structural validator. + +Semantic rules that JSON Schema cannot safely express remain documented and must be tested in application code. + +Before Trainlog v1 is frozen, schema changes are allowed. + +After `TRAINLOG_FORMAT_V1=FROZEN`, incompatible changes require a new version. diff --git a/format/trainlog-v1.schema.json b/format/trainlog-v1.schema.json new file mode 100644 index 0000000..13208c2 --- /dev/null +++ b/format/trainlog-v1.schema.json @@ -0,0 +1,253 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://labfytools.com/trainlog/schema/trainlog-v1.schema.json", + "title": "Trainlog Exchange Format v1", + "type": "object", + "additionalProperties": false, + "required": [ + "format", + "version", + "exercises", + "session" + ], + "properties": { + "format": { + "const": "trainlog" + }, + "version": { + "const": 1 + }, + "exercises": { + "type": "array", + "items": { + "$ref": "#/$defs/exerciseCatalogEntry" + } + }, + "session": { + "$ref": "#/$defs/session" + } + }, + "$defs": { + "exerciseId": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-z0-9][a-z0-9_-]*$" + }, + "exerciseCatalogEntry": { + "type": "object", + "additionalProperties": false, + "required": [ + "exercise_id", + "name" + ], + "properties": { + "exercise_id": { + "$ref": "#/$defs/exerciseId" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 200 + } + } + }, + "set": { + "type": "object", + "additionalProperties": false, + "properties": { + "reps": { + "type": "integer", + "minimum": 1, + "maximum": 10000 + }, + "duration_seconds": { + "type": "integer", + "minimum": 1, + "maximum": 86400 + }, + "weight_kg": { + "type": "number", + "minimum": 0, + "maximum": 5000 + } + }, + "anyOf": [ + { + "required": [ + "reps" + ] + }, + { + "required": [ + "duration_seconds" + ] + } + ] + }, + "target": { + "type": "object", + "additionalProperties": false, + "required": [ + "sets" + ], + "properties": { + "sets": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + "reps": { + "type": "integer", + "minimum": 1, + "maximum": 10000 + }, + "duration_seconds": { + "type": "integer", + "minimum": 1, + "maximum": 86400 + }, + "weight_kg": { + "type": "number", + "minimum": 0, + "maximum": 5000 + } + }, + "anyOf": [ + { + "required": [ + "reps" + ] + }, + { + "required": [ + "duration_seconds" + ] + } + ] + }, + "sessionExercise": { + "type": "object", + "additionalProperties": false, + "required": [ + "exercise_id", + "rest_seconds", + "target", + "sets" + ], + "properties": { + "exercise_id": { + "$ref": "#/$defs/exerciseId" + }, + "rest_seconds": { + "type": "integer", + "minimum": 0, + "maximum": 86400 + }, + "target": { + "$ref": "#/$defs/target" + }, + "sets": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "$ref": "#/$defs/set" + } + } + } + }, + "measurements": { + "type": "object", + "additionalProperties": false, + "properties": { + "waist_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "chest_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "shoulders_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "left_arm_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "right_arm_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "left_thigh_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "right_thigh_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "left_calf_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + }, + "right_calf_cm": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 500 + } + } + }, + "session": { + "type": "object", + "additionalProperties": false, + "required": [ + "session_id", + "started_at", + "ended_at", + "exercises" + ], + "properties": { + "session_id": { + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "started_at": { + "type": "string", + "format": "date-time" + }, + "ended_at": { + "type": "string", + "format": "date-time" + }, + "body_weight_kg": { + "type": "number", + "exclusiveMinimum": 0, + "maximum": 1000 + }, + "measurements": { + "$ref": "#/$defs/measurements" + }, + "exercises": { + "type": "array", + "minItems": 1, + "maxItems": 1000, + "items": { + "$ref": "#/$defs/sessionExercise" + } + } + } + } + } +} diff --git a/tools/validate_json.py b/tools/validate_json.py new file mode 100755 index 0000000..eb5a519 --- /dev/null +++ b/tools/validate_json.py @@ -0,0 +1,69 @@ +#!/usr/bin/env python3 +"""Validate Trainlog JSON fixtures against the canonical JSON Schema.""" + +from __future__ import annotations + +import json +import sys +from pathlib import Path + +try: + import jsonschema +except ImportError: + print( + "error: missing Python dependency 'jsonschema'\n" + "install it with: python -m pip install --user jsonschema", + file=sys.stderr, + ) + raise SystemExit(2) + +ROOT = Path(__file__).resolve().parents[1] +SCHEMA_PATH = ROOT / "format" / "trainlog-v1.schema.json" + + +def load_json(path: Path) -> object: + """Load one UTF-8 JSON file and return its decoded value.""" + with path.open("r", encoding="utf-8") as handle: + return json.load(handle) + + +def main(argv: list[str]) -> int: + """Validate one or more Trainlog JSON files.""" + schema = load_json(SCHEMA_PATH) + + targets = [Path(arg) for arg in argv[1:]] + if not targets: + targets = [ROOT / "examples" / "session-v1.json"] + + validator = jsonschema.Draft202012Validator( + schema, + format_checker=jsonschema.FormatChecker(), + ) + + failed = False + + for path in targets: + try: + document = load_json(path) + except (OSError, json.JSONDecodeError) as exc: + print(f"FAIL {path}: {exc}") + failed = True + continue + + errors = sorted(validator.iter_errors(document), key=lambda e: list(e.path)) + if errors: + print(f"FAIL {path}") + for error in errors: + location = ".".join(str(part) for part in error.absolute_path) + if not location: + location = "" + print(f" {location}: {error.message}") + failed = True + else: + print(f"PASS {path}") + + return 1 if failed else 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv)) diff --git a/tui/.gitkeep b/tui/.gitkeep new file mode 100644 index 0000000..e69de29