diff options
| author | Craig Jennings <c@cjennings.net> | 2026-05-05 05:20:44 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-05-05 05:20:44 -0500 |
| commit | 35131cb72c08c657d2a3389338d0c049d57e69bd (patch) | |
| tree | ad377579abb8bc143dd57c9a4f63fa244d137a94 /tests/test-wttrin-debug-aliases.el | |
| parent | 306c4ea1dd07de0d862c0943aeb8b7e170a1b343 (diff) | |
| download | emacs-wttrin-35131cb72c08c657d2a3389338d0c049d57e69bd.tar.gz emacs-wttrin-35131cb72c08c657d2a3389338d0c049d57e69bd.zip | |
refactor: rename debug-wttrin-* commands to wttrin-debug-* with obsolete aliases
The four interactive commands in `wttrin-debug.el` used `debug-wttrin-` as their prefix instead of the package's `wttrin-debug-` prefix. package-lint flags this as a convention violation, and it makes M-x discovery slightly less consistent for users.
Renamed:
- `debug-wttrin-show-raw` -> `wttrin-debug-show-raw`
- `debug-wttrin-enable` -> `wttrin-debug-enable`
- `debug-wttrin-disable` -> `wttrin-debug-disable`
- `debug-wttrin-mode-line` -> `wttrin-debug-mode-line`
The old names stay available as `define-obsolete-function-alias` entries marked since 0.4.0, so anyone with a keybinding or `(call-interactively 'debug-wttrin-enable)` in their config keeps working. The byte-compiler will emit an obsolescence warning to nudge migration. Aliases will be removed in a future release.
Internal caller `wttrin--debug-mode-line-info` now invokes the new name. Test files renamed to match (`test-debug-wttrin-*.el` -> `test-wttrin-debug-*.el`); inside each, ert-deftest names and function calls were updated.
Added `tests/test-wttrin-debug-aliases.el` to verify each old name resolves via `indirect-function` to the new name and carries `byte-obsolete-info` with the expected target and "0.4.0" version.
Diffstat (limited to 'tests/test-wttrin-debug-aliases.el')
| -rw-r--r-- | tests/test-wttrin-debug-aliases.el | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/tests/test-wttrin-debug-aliases.el b/tests/test-wttrin-debug-aliases.el new file mode 100644 index 0000000..1e2194b --- /dev/null +++ b/tests/test-wttrin-debug-aliases.el @@ -0,0 +1,52 @@ +;;; test-wttrin-debug-aliases.el --- Tests for obsolete debug aliases -*- lexical-binding: t; -*- + +;; Copyright (C) 2026 Craig Jennings + +;;; Commentary: + +;; The four `debug-wttrin-*' names were renamed to `wttrin-debug-*' in +;; 0.4.0 to follow the package-prefix convention. The old names remain +;; as obsolete aliases so existing keybindings keep working. These tests +;; verify each alias resolves to the new function and is marked obsolete +;; with the expected target and version. + +;;; Code: + +(require 'ert) +(require 'wttrin) +(require 'testutil-wttrin) + +(require 'wttrin-debug + (expand-file-name "wttrin-debug.el" + (file-name-directory (locate-library "wttrin")))) + +(defconst test-wttrin-debug-aliases-pairs + '((debug-wttrin-show-raw . wttrin-debug-show-raw) + (debug-wttrin-enable . wttrin-debug-enable) + (debug-wttrin-disable . wttrin-debug-disable) + (debug-wttrin-mode-line . wttrin-debug-mode-line)) + "Old-name to new-name pairs for the renamed debug functions.") + +;;; Normal Cases + +(ert-deftest test-wttrin-debug-aliases-normal-each-old-name-resolves-to-new () + "Every old name is fboundp and indirects to its new name." + (dolist (pair test-wttrin-debug-aliases-pairs) + (let ((old (car pair)) + (new (cdr pair))) + (should (fboundp old)) + (should (eq (indirect-function old) (symbol-function new)))))) + +(ert-deftest test-wttrin-debug-aliases-normal-each-old-name-marked-obsolete () + "Every old name has byte-obsolete-info pointing at the new name and 0.4.0." + (dolist (pair test-wttrin-debug-aliases-pairs) + (let* ((old (car pair)) + (new (cdr pair)) + (info (get old 'byte-obsolete-info))) + (should info) + ;; byte-obsolete-info is (CURRENT-NAME HANDLER WHEN) + (should (eq new (car info))) + (should (string= "0.4.0" (nth 2 info)))))) + +(provide 'test-wttrin-debug-aliases) +;;; test-wttrin-debug-aliases.el ends here |
