aboutsummaryrefslogtreecommitdiff
path: root/org-drill.el
Commit message (Collapse)AuthorAgeFilesLines
...
* test: add entry-status, days-since-creation, and overdue ordering coverageCraig Jennings2026-05-051-2/+7
| | | | | | | | | | | | | | | | | | | | | | Plus a docs fix to org-drill-order-overdue-entries' header comment. 16 ERT tests covering: - org-drill-entry-status: non-drill nil, empty entry nil, virgin :new, future :future, low-quality :failed, due+short-interval :young, due+long-interval :old, very-overdue :overdue, skipped-leech :unscheduled, three-element return shape - org-drill-entry-days-since-creation: with DATE_ADDED, missing without flag (nil), missing with use-last-interval-p flag (overdue+interval) - org-drill-order-overdue-entries: empty stays empty, non-lapsed sorted by DUE desc, lapsed split (by DUE crossing threshold, not AGE) appearing after sorted by AGE desc Fixed misleading header comment at line 2888 — it claimed the lapse split was by AGE, but the code uses DUE (cl-second). This matches the semantic gate in org-drill--entry-lapsed-p, so the code was right and the comment was stale. Updated the comment to state the actual three-step sort.
* fix: don't create zero-width overlay for hint-less clozesCraig Jennings2026-05-051-2/+8
| | | | | | | | | | | | | | | | org-drill-hide-cloze-hints checked (null (match-beginning 2)) to detect "no hint present," but the cloze regex's hint group is an empty-allowed alternation — the group always participates in the match, so match-beginning is always a position, never nil. For a card like "[Paris]" (no hint), the function fell through to org-drill-hide-region with start = end and made a zero-width overlay. Cosmetically harmless but accumulates one stray overlay per hint-less cloze. On a buffer with many such cards the tracking cost is real. Switched the guard to (= (match-beginning 2) (match-end 2)) — empty match. Found while writing tests; locked in by tests/test-org-drill-hide-show.el's test-org-drill-hide-cloze-hints-no-hint-no-overlay.
* fix: include child subtree in entry-empty-p search bound (upstream #13)Craig Jennings2026-05-051-2/+8
| | | | | | | | | | | | kqr (2019-07-22) reported that drill entries whose answer lives inside a child sub-heading were silently skipped. Their example: a question in the heading text and the answer under `** The Answer`. The function returned t (empty) for such entries, so they never got presented during drill sessions. The cause is `(outline-next-heading)` in `org-drill-entry-empty-p`. That primitive lands on the first heading at any level, including children. So the search range was metadata-end up to the child's heading line, which excluded the child's body. Bodies that lived in child sub-headings never got searched. I switched the bound to `(org-end-of-subtree t t)`, which covers the whole subtree of the current heading and degrades gracefully at the last heading in the buffer. The reporter suggested `outline-forward-same-level`, but that primitive errors at the last sibling, which would be its own regression. `org-end-of-subtree` is the canonical Emacs idiom for this kind of bound and handles end-of-buffer correctly. I added `tests/test-org-drill-entry-empty-p.el` with 6 ERT tests across Normal, Boundary (kqr's exact fixture), and edge categories. The two regression tests fail at HEAD before the fix and pass after. One semantic note worth flagging: any subtree content now counts as non-empty, including bare child headings with no body of their own. The bug report is silent on that case and I expect it to be rare in practice. If anyone reports the new behavior as a regression, the fix would be to filter heading lines out of the graphical-character search.
* fix: preserve default-input-method during key reads (upstream #52, #58)Craig Jennings2026-05-051-5/+17
| | | | | | | | | | Two reports from breadncup (issue #52 in 2023, issue #58 in 2024) said that running an org-drill session silently nulled out their `default-input-method`. The reproduction is exact: every rating prompt clears the user's persistent setting. The cause is `(set-input-method nil)` in `org-drill--read-key-sequence`. When `current-input-method` is nil, calling `set-input-method` with nil clears `default-input-method` as a documented side effect. The unwind-protect on the way back has the symmetric problem, since it passes the captured nil. The fix is to use the primitives that are scoped to current state. `deactivate-input-method` and `activate-input-method` don't touch `default-input-method`, and I wrap each call in a guard so the function is a no-op when no input method is active. The same pattern lives in `org-drill-response-get-buffer-create`, which propagates the caller's input method into the response buffer. When the caller has no input method active, the captured value is nil and `(set-input-method nil)` runs in the new buffer, clearing `default-input-method` again. I applied the same guard there. I added `tests/test-org-drill-read-key-sequence.el` with 6 ERT tests across Normal, Boundary (the bug case), and Error categories. The four regression tests fail at HEAD before the fix and pass after.
* fix: increment totaln on Simple8 failure pathCraig Jennings2026-04-291-0/+1
| | | | | | | | 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.
* fix: use correct calling convention for `display-buffer`p-snow2026-04-291-1/+1
| | | | (cherry picked from commit eacb6d0c018839d8207ee80e02b46b314278ac3f)
* Update org-drill-time-to-inactive-org-timestamp to Org 9.6 formatJoseph Turner2026-04-291-1/+4
| | | | (cherry picked from commit 76d45fb0ea6e216b2cb173bdcf73ef284d350ff8)
* fix: add error handling for malformed timestamps in ↵Craig Jennings2025-11-131-1/+3
| | | | | | | | | | | | | | | | 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.
* fix: correct property names in org-drill-merge-buffersCraig Jennings2025-11-131-4/+4
| | | | | | | | | | 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.
* refactor: extract hardcoded lapse threshold into customizable variableCraig Jennings2025-11-131-6/+18
| | | | | | | | | | | | | 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
* fix: prevent window corruption in org-drill-merge-buffersCraig Jennings2025-11-131-16/+16
| | | | | | | | | | | | | | | | 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 ...))
* refactor: remove obsolete commented code for failure countCraig Jennings2025-11-131-3/+0
| | | | | | | | 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.
* fix: improve error handling for empty property blocks in cloze processingCraig Jennings2025-11-131-4/+18
| | | | | | | | | | | 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)
* Fix race condition with timer cleanup and marker leakCraig Jennings2025-11-131-13/+16
| | | | | | | | | | | | | | 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
* Fix docstring typo and style in org-drill-entry-overdue-pCraig Jennings2025-11-131-1/+1
| | | | | | | 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
* Fix potential infinite loop in marker selectionCraig Jennings2025-11-131-5/+12
| | | | | | | | | | | | | | | | 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
* Fix potential division by zero in org-drill-entry-overdue-pCraig Jennings2025-11-131-0/+1
| | | | | | | | | 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
* Fix missing return value in org-drill-get-tags-adviceCraig Jennings2025-11-131-2/+5
| | | | | | | | | | | | | | | 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
* Security: Replace unsafe read() calls with safer alternativesCraig Jennings2025-11-131-12/+37
| | | | | | | | | | | | | | | | | | | 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
* Fix typo in cram-mode slot documentationCraig Jennings2025-11-131-1/+1
| | | | | | | | 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
* refactor: Improve test infrastructure and fix all compiler warningsCraig Jennings2025-11-131-73/+72
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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)
* feat: Add display management with customizable settingsCraig Jennings2025-11-121-0/+90
| | | | | | | | | | | | | | | | | | 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.
* org-drill: Implement custom drawer hiding functionCraig Jennings2025-11-121-12/+27
| | | | | | | | | 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.
* Fix autoloadsPhillip Lord2021-04-271-0/+3
|
* Merge branch 'branweb/org-mode-version' into 'master'Phillip Lord2020-04-121-1/+1
|\ | | | | | | | | | | Bump org-mode version to 9.3 See merge request phillord/org-drill!10
| * Bump org-mode version to 9.3Brandon Webster2020-04-051-1/+1
| | | | | | | | | | | | 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.
* | Merge branch 'branweb/fix-cram-mode' into 'master'Phillip Lord2020-04-121-5/+8
|\ \ | | | | | | | | | | | | | | | Allow Creating New Session in Cram Mode See merge request phillord/org-drill!9
| * | Allow Creating New Session in Cram ModeBrandon Webster2020-04-051-5/+8
| |/ | | | | | | | | | | | | | | | | | | | | 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.
* / Fix use of cl.elPhillip Lord2020-04-081-1/+1
|/ | | | | | * org-drill.el (org-drill-order-overdue-entries): Use cl-first Closes #23
* Release v2.7.02.7.0Phillip Lord2020-02-161-1/+1
|
* Remove interactive from org-drill-entry-fPhillip Lord2020-02-161-1/+0
|
* Fix typo "Eaqch" to "Each"James Miller2020-01-181-1/+1
|
* Merge branch 'master' into 'fix/latex-overlays'Phillip Lord2019-12-191-1/+1
|\ | | | | | | | | # Conflicts: # org-drill.el
| * fix argument passed to now obsoleted org-toggle-latex-fragmentDarrell Overbay2019-08-071-1/+1
| | | | | | | | | | | | The interpretation of the argument to org-toggle-latex-fragment changed when it was aliased to org-latex-preview. Regardless, '(16) should work for either version
* | Show latex overlays in simple card's answerMark Skilbeck2019-10-181-0/+7
| |
* | Do not remove overlays after finishing cardMark Skilbeck2019-10-181-2/+1
| |
* | Show LaTex overlays after clearing themMark Skilbeck2019-10-161-1/+1
|/
* Fix org-get-tags compatabilityPhillip Lord2019-07-271-1/+3
| | | | | | The <9.2 compatability advice was working incorrectly by calling `org-get-tags` which prior to 9.2 returned only local tags. This now calls `org-get-tags-at` which seems to work.
* Remove obsolete org-drill-optimal-factor-matrixPhillip Lord2019-07-271-17/+0
|
* Update documentationPhillip Lord2019-07-271-6/+7
|
* Update documentationPhillip Lord2019-07-271-44/+45
|
* Update documentation.Phillip Lord2019-07-271-1/+15
|
* Update documentationPhillip Lord2019-07-261-0/+2
|
* Update documentationPhillip Lord2019-07-221-0/+13
|
* Update documentationPhillip Lord2019-07-211-0/+2
|
* Merge branch 'fix/drill-matching' into 'master'Phillip Lord2019-07-211-1/+1
|\ | | | | | | | | | | fix reversed member arguments See merge request phillord/org-drill!2
| * fix reversed member argumentsDarrell Overbay2019-07-181-1/+1
| |
* | Update documentationPhillip Lord2019-07-201-5/+12
|/
* Update documentationPhillip Lord2019-07-131-2/+11
|
* Update documentationPhillip Lord2019-07-111-0/+5
|