| Commit message (Collapse) | Author | Age | Files | Lines |
| |
|
|
|
|
|
|
|
|
| |
I want a stronger maintainer-discipline baseline as I take over more of this project, so I added four targets that are common in Emacs-Lisp packages.
`make lint` runs `checkdoc`, `package-lint`, and `elisp-lint` over `org-drill.el`. It's informational for now and doesn't fail on findings, because the existing source has known docstring and style debt to clear. I'll re-tighten to a hard gate after the docstring pass is done. `make compile` byte-compiles the source with `byte-compile-error-on-warn nil`, matching the existing `build` target's leniency. `make validate-parens` is a fast structural check that surfaces the line of the offending paren without needing a full byte-compile pass.
I also added a `:slow` tag filter to the default ERT runners. `test-unit`, `test-integration`, `test-file`, and `coverage` now run with `'(not (tag :slow))`. Tests tagged `:slow` get skipped on the fast feedback path. `test-name` is left alone, since a pattern argument means the user wants those tests run whether or not they're tagged slow.
Cask gets `package-lint` and `elisp-lint` as development deps. `.gitignore` gets `*-autoloads.el` so the Cask build artifact stays out.
|
| |
|
|
|
|
|
|
| |
I added a regression test for `org-drill-time-to-inactive-org-timestamp` to lock in the cherry-pick from commit 4c6e62a, which fixed upstream issue #59 on the GitLab tracker.
Chipschap reported timestamps like `[Y-08-27 Wed 16:%]` getting written into DRILL_LAST_REVIEWED. The root cause is that Org 9.6+ dropped the angle brackets around `(cdr org-time-stamp-formats)`, so the original `(substring ... 1 -1)` started slicing off the leading `%` of `%Y` and the trailing `M` of `%M`. The fix took the Org 9.6+ branch via `(org-time-stamp-format t 'no-bracket)` instead.
The new test file has 7 ERT tests across Normal, Boundary, and Error categories. The Error cases assert the output has no stray `%` characters and no literal `Y` in place of the year. I confirmed the same tests fail when I drop in the original buggy implementation, so they catch the bug shape from the report.
|
| |
|
|
|
|
|
|
|
|
| |
I want to track test coverage as I work through the upstream issue backlog, so I added an undercover-based flow that mirrors how `make test-unit` already runs each file in its own Cask Emacs process.
The Makefile gets `make coverage` and `make coverage-clean`. A new helper at `tests/run-coverage-file.el` instruments `org-drill.el` before the source is loaded. Undercover merges per-file results into a single simplecov JSON at `.coverage/simplecov.json`. I added `undercover` as a Cask development dep and `.coverage/` to `.gitignore` so the report stays local.
I also renamed `make install` to `make setup`. The old name read like "deploy the package onto my system," but the target only installs Cask deps into the local `.cask/` directory. `setup` is closer to what it actually does, and all the internal `: install` prerequisites move with it.
Baseline at this commit is 10.8% (208/1928 lines on org-drill.el).
|
| |
|
|
|
|
|
|
| |
The Simple8 failure branch was missing (cl-incf totaln) while SM2 and SM5 both increment total-repeats on failure. After this change, DRILL_TOTAL_REPEATS counts every review attempt regardless of which scheduling algorithm produced it, including failures.
Going-forward only. Historical totaln values for Simple8 failures stay under-counted by one. Correct counting starts with the next failed review.
Paired with the test commit 5c68f1e, which captured the new expected behavior first. Full suite at 214 of 214.
|
| |
|
|
| |
The failure-path assertion in the totaln test now expects the count to increment on both success and failure, matching SM2 and SM5. The updated test goes red against the current source. The source fix follows in the next commit.
|
| |
|
|
|
|
|
|
|
|
| |
The Simple8 algorithm at org-drill-determine-next-interval-simple8 had no direct test coverage, completing the trio after SM2 (37 tests) and SM5 (32 tests, just landed). Adds a per-function test file with 34 tests across Normal, Boundary, Error, algorithm-verification, and helper-specific categories.
Simple8-specific surface gets dedicated coverage. The function returns a 6-element list (not 7 like SM2/SM5) and recomputes ease from meanq each call rather than carrying an EF parameter through. Failure does not increment totaln (different from SM2/SM5, which always increment). The four delta-days configurations (nil, positive × flag, negative × flag) each take a distinct code path, including a late-review use-n adjustment that SM5 doesn't have.
The three pure-math helpers (simple8-first-interval, simple8-interval-factor, simple8-quality->ease) get five direct tests so polynomial-coefficient typos can't drift silently.
All 34 pass on first run as characterization. Full suite at 214 of 214 (was 180, +34).
|
| |
|
|
|
|
|
|
| |
Three test files (SM2, SM5, and the upcoming Simple8) all extract the same fields from a scheduler result list. Pull the shared extractors into tests/testutil-scheduler.el so each algorithm's test file can use them.
Position 2 holds an EF in SM2 and SM5 and an EASE in Simple8. Both names are exposed as aliases pointing at the same nth position so each call site reads accurately.
SM2 and SM5 test files now require testutil-scheduler and call the shared helpers. 69 of 69 scheduler tests still green. Full unit suite at 180 of 180.
|
| |
|
|
|
|
|
|
| |
The SM5 algorithm at org-drill-determine-next-interval-sm5 had no direct test coverage. SM2 has 37 tests. SM5 has zero. Adds a per-function test file that mirrors the SM2 file's structure. 32 tests cover Normal, Boundary, Error, and algorithm-verification categories.
The SM5-specific surface gets dedicated coverage. Failure preserves the input EF, not the modified one. The of-matrix is copied, not mutated. The four delta-days configurations (nil, positive, negative-with-flag, negative-without-flag) each take a different code path. The Error category includes should-error cases for the cl-assert preconditions on n and quality, which is a gap SM2's tests still have.
All 32 pass on first run as characterization. Full suite at 180 of 180.
|
| |
|
|
| |
Add a top note that flags this as a maintained fork with applied upstream patches, and a bottom note clarifying that the existing Author and History sections describe the original project. Helps anyone who lands on the GitHub mirror without context.
|
| |
|
|
| |
The maintenance notes weren't meant to live in public history. Removed from past commits via filter-repo.
|
| |
|
|
| |
The persist package moved to the nongnu ELPA archive years ago. The existing gnu/melpa/org sources couldn't resolve it, so cask install failed and make test-unit was unrunnable. Unblocks the test suite.
|
| |
|
|
| |
(cherry picked from commit eacb6d0c018839d8207ee80e02b46b314278ac3f)
|
| |
|
|
| |
(cherry picked from commit 76d45fb0ea6e216b2cb173bdcf73ef284d350ff8)
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
org-drill-entry-days-since-creation
Wrapped org-time-stamp-to-now call in condition-case to gracefully handle
malformed DATE_ADDED property values. Now returns nil instead of crashing
when encountering invalid timestamp formats.
Changes:
- Added condition-case around org-time-stamp-to-now (lines 2896-2898)
- Returns nil on error, allowing the function to fall through to other
branches or return nil gracefully
This prevents unhandled errors in long-running sessions when drill entries
have corrupted or manually-edited timestamp values.
|
| |
|
|
|
|
|
|
|
|
| |
Changed incorrect property names to match standard naming convention:
- LAST_QUALITY → DRILL_LAST_QUALITY (lines 3394-3395)
- LAST_REVIEWED → DRILL_LAST_REVIEWED (lines 3397-3398)
This ensures consistency with the rest of the codebase where all drill
properties use the DRILL_ prefix. The old names would create properties
that don't match the standard schema and wouldn't be read correctly.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Created org-drill-lapse-threshold-days defcustom (default 90) to replace
hardcoded values scattered throughout the code. This improves maintainability
and allows users to customize when entries are considered lapsed.
Changes:
- Added defcustom org-drill-lapse-threshold-days (line 660-669)
- Updated org-drill-order-overdue-entries to use variable (line 2867)
- Simplified org-drill--entry-lapsed-p to use variable (line 2884-2886)
- Added safe-local-variable declaration (line 687)
- Updated docstring references to use variable name
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Replaced switch-to-buffer with with-current-buffer to avoid changing
visible buffers during merge operation. This prevents window state
corruption and allows the function to work correctly in batch mode.
Changed line 3374-3375 from:
(save-excursion
(switch-to-buffer (marker-buffer marker))
...)
To:
(with-current-buffer (marker-buffer marker)
(save-excursion
...))
|
| |
|
|
|
|
|
|
| |
Removed commented-out code that redundantly set the failures variable.
The failures count is already obtained from org-drill-entry-failure-count
on line 1538, making the commented code (lines 1548-1550) unnecessary.
This cleans up maintainability issues and removes confusing dead code.
|
| |
|
|
|
|
|
|
|
|
|
| |
Previously used (or (cdr (org-get-property-block)) (point)) which could
return invalid position if no property block exists. Now properly positions
after heading and metadata using org-end-of-meta-data when property block
is missing.
Affects:
- org-drill-present-multicloze-hide-n (line 2267)
- org-drill-present-multicloze-hide-nth (line 2345)
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
Timer cleanup fix:
- Wrapped recursive-edit in unwind-protect to ensure
org-drill-presentation-timer-cancel is always called
- Timer is now cancelled even if recursive-edit exits abnormally
Marker leak fix:
- Moved org-drill-free-markers outside the (unless (oref session end-pos)) condition
- Done-entries markers are now always freed in cleanup, even on error or suspension
- Prevents memory leaks in long-running Emacs sessions
Fixes two severity B bugs in todo.org
|
| |
|
|
|
|
|
| |
Changed 'dasy' to 'days' and improved docstring to follow Emacs conventions
(imperative mood: 'Return non-nil' instead of 'Returns true').
Fixes severity B bug in todo.org
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Added safety counter to prevent infinite loop when all pending entries
are invalid (deleted or no longer have drill tag).
Changes:
- Added attempts counter with max-attempts limit of 1000
- Loop now exits if max attempts reached
- Returns nil if no valid entry found after exhausting attempts
Impact: Prevents infinite loop if all pending entries become invalid,
which could happen if entries are deleted or tags are removed during
a session.
Fixes severity B bug in todo.org
|
| |
|
|
|
|
|
|
|
| |
Added check to ensure last-interval is greater than 0 before performing division.
Impact: Prevents division-by-zero error when last-interval is 0 (new items
or after failures), which would crash the drill session.
Fixes severity B bug in todo.org
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Added fallback to original function when org-get-local-tags doesn't exist.
Changes:
- Removed underscore from orig-fun parameter (now used)
- Added else clause to fallback to (apply orig-fun args)
- Added explanatory comment
Impact: In older org-mode versions where org-get-local-tags doesn't exist,
the function now properly falls back to the original org-get-tags behavior
instead of returning nil, fixing tag functionality.
Fixes severity A bug in todo.org
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Replaced unsafe use of read() function on user-controlled property values
to prevent arbitrary code execution vulnerability.
Changes:
- Lines 1353, 1406: Changed read() to string-to-number() for DRILL_CARD_WEIGHT
- Line 2838: Changed read() to string-to-number() for DRILL_LAST_INTERVAL
- Line 1068: Created org-drill--safe-read-learn-data() helper function that:
* Uses read-from-string instead of read
* Validates input is a list with at least 3 numeric elements
* Returns nil on invalid/malicious input with error handling
* Falls back to safe defaults if LEARN_DATA is corrupted
Impact: Prevents arbitrary code execution if attacker controls org-mode
properties through shared files or malicious imports.
Fixes severity A security bug in todo.org
|
| |
|
|
|
|
|
|
| |
Changed :documementation to :documentation in EIEIO class slot definition.
This fixes EIEIO's ability to recognize slot documentation for introspection
and help systems.
Fixes severity A bug in todo.org
|
| |
|
|
|
|
|
|
| |
Added 66 comprehensive tests covering:
- Entry detection with extreme values and Unicode
- SM2 algorithm with boundary conditions
- Workflow error handling with malformed data
- Card types with complex content structures
|
| |
|
|
|
|
|
|
|
| |
- Add unit tests for show1cloze card type (6 tests)
- Add unit tests for multicloze variants (12 tests)
- Add integration test for card type system (5 tests)
Phase 2 complete: All major card types tested
Total: 114 tests (98 unit + 16 integration), all passing
|
| |
|
|
|
|
|
|
| |
- Add unit tests for simple card type (11 tests)
- Add unit tests for twosided card type (11 tests)
- Add unit tests for hide1cloze card type (4 tests)
Total: 91 tests (80 unit + 11 integration), all passing
|
| |
|
|
|
|
|
|
|
|
|
| |
- Add unit tests for org-drill-entry-p (14 tests)
- Add unit tests for org-drill-part-of-drill-entry-p (14 tests)
- Add unit tests for SM2 scheduling algorithm (23 tests)
- Add integration test for basic drill workflow (11 tests)
- Update Makefile to support test-*.el naming pattern
- Rename org-drill-test.el to test-org-drill.el for consistency
Total: 65 tests, all passing
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This commit modernizes the test infrastructure and eliminates all
compilation warnings to prepare for comprehensive test coverage.
Test Infrastructure Improvements:
- Reorganize tests from test/ to tests/ directory (standard convention)
- Modernize Makefile with patterns from chime.el
- Add convenient test targets (test-file, test-name)
- Support unit and integration test separation
- Better help documentation with examples
- Auto-detect Cask installation location
- Add comprehensive test-strategy.org document
- 6-week implementation plan
- Critical function prioritization
- Integration test scenarios
- Coverage goals (80% target)
Compiler Warning Fixes (org-drill.el):
- Replace obsolete org-mode functions:
- org-show-subtree → org-fold-show-subtree
- org-show-entry → org-fold-show-entry
- org-get-tags-at → org-get-tags
- org-remove-latex-fragment-image-overlays → org-clear-latex-preview
- org-toggle-latex-fragment → org-latex-preview
- org-bracket-link-regexp → org-link-bracket-re
- Fix ~31 unescaped single quotes in docstrings (use \=')
- Remove unused lexical variables (cb, drawer-name, session, orig-fun)
- Remove obsolete outline-view-change-hook binding
- Wrap org 8.x compatibility shim in with-no-warnings
- Fix long docstring at line 1085
Test Status:
- All 3 existing tests passing
- Zero compilation warnings (was ~40 warnings)
- Ready for Phase 1 implementation (foundation tests)
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Add built-in display management for drill sessions with user-configurable
settings. No external dependencies required.
New features:
- Customizable font size in points (org-drill-text-size-during-session)
- Optional variable-pitch mode (org-drill-use-variable-pitch)
- Optional modeline hiding (org-drill-hide-modeline-during-session)
- Automatic drawer hiding with new org-drill-hide-drawers function
- Session lifecycle hooks (org-drill-before-session-hook, org-drill-after-session-hook)
Display settings are automatically saved and restored when sessions end,
including on quit, error, or normal completion via unwind-protect.
All settings use proper package naming (org-drill-*) with no external
dependencies. Works out of the box for all users.
|
| |
|
|
|
|
|
|
|
| |
Replace `org-cycle-hide-drawers` with a new `org-drill-hide-drawers`
function for more reliable drawer hiding in org-drill. This change
enhances the drill display by ensuring all drawers, including the
PROPERTIES drawer, are consistently hidden during presentations. The
custom function iterates through entries and hides the designated
regions, improving the user experience during interactive sessions.
|
| | |
|
| | |
|
| | |
|
| |\
| |
| |
| |
| |
| | |
Bump org-mode version to 9.3
See merge request phillord/org-drill!10
|
| | |
| |
| |
| |
| |
| | |
Issue reference: https://gitlab.com/phillord/org-drill/-/issues/19
Caused by https://gitlab.com/phillord/org-drill/-/commit/82b50e378db69e96fb3d916785a2f03fddf85637, which introduced a function created here: https://code.orgmode.org/bzg/org-mode/commit/6d9022df22f86e8b0ea00dfb9179128136edc49a?style=split. Fn is available in org 9.3. Don't know much about packaging for melpa but I figure 82b50e37 should have bumped the org version from 9.2.X at least.
|
| |\ \
| | |
| | |
| | |
| | |
| | | |
Allow Creating New Session in Cram Mode
See merge request phillord/org-drill!9
|
| | | | |
|
| | | | |
|
| | | | |
|
| | |/
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
A current session does not exist when `org-drill-cram` is called, so
it's current behavior of toggling the `crame-mode` property doesn't
seem to do anything. This change allows it to inform `org-drill` to
create a new session in "cram mode."
I'm not sure if this is the proper way to impliment this relative to
the rest of the codebase, which I'm still a little unfamiliar
with. But I thought this pr would still be useful, if only to create discussion.
|
| |/
|
|
|
|
| |
* org-drill.el (org-drill-order-overdue-entries): Use cl-first
Closes #23
|
| | |
|
| | |
|
| |\
| |
| |
| |
| |
| | |
Fix typo "Eaqch" to "Each"
See merge request phillord/org-drill!8
|
| |/ |
|
| |\
| |
| |
| |
| |
| | |
Show LaTex overlays after clearing them
See merge request phillord/org-drill!7
|
| | |\
| |/
|/|
| |
| | |
# Conflicts:
# org-drill.el
|