From 74ca4e066bc41ce0a6e94e2d4bc0c838df45a838 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Wed, 22 Apr 2026 09:43:02 -0500 Subject: refactor: move 12 internal helpers from chime- to chime-- prefix Before MELPA submission, tighten the public API surface. Single-dash chime-foo is the convention for user-facing commands and predicates that external code can bind. Anything that is not meant to be bound externally should use the double-dash chime--foo prefix so byte-compile warnings, docstrings, and MELPA package inspection all point in the same direction. Twelve helpers in chime.el had single-dash names but no user-facing role. They are not mentioned in README, they carry no interactive declaration, and their docstrings do not promise a behavior contract. Rename them: chime-get-minutes-into-day, chime-get-hours-minutes-from-time, chime-set-hours-minutes-for-time, chime-current-time-matches-time-of-day-string, chime-current-time-is-day-wide-time, chime-day-wide-notifications, chime-display-as-day-wide-event, chime-event-has-any-day-wide-timestamp, chime-event-within-advance-notice-window, chime-event-has-any-passed-time, chime-event-is-today, chime-environment-regex. The public API surface is now intentional. It covers chime-mode, chime-validate-configuration, chime-refresh-modeline, chime-done-keywords-predicate, and the chime-debug-* interactive commands in chime-debug.el. Breaking change. No alias shims because there are no downstream users yet. --- tests/test-chime-overdue-todos.el | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'tests/test-chime-overdue-todos.el') diff --git a/tests/test-chime-overdue-todos.el b/tests/test-chime-overdue-todos.el index 919ceeb..84bc091 100644 --- a/tests/test-chime-overdue-todos.el +++ b/tests/test-chime-overdue-todos.el @@ -57,7 +57,7 @@ HAS-TIME determines if timestamp has time component." "Teardown function run after each test." (chime-delete-test-base-dir)) -;;; Tests for chime-event-has-any-passed-time +;;; Tests for chime--event-has-any-passed-time (ert-deftest test-overdue-has-passed-time-yesterday-all-day () "Test that all-day event from yesterday is recognized as passed. @@ -80,7 +80,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" yesterday-timestamp nil))) ; all-day event (with-test-time now - (should (chime-event-has-any-passed-time event)))) + (should (chime--event-has-any-passed-time event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-has-passed-time-today-all-day () @@ -100,7 +100,7 @@ SPECIAL PROPERTIES: - Range: No EXPECTED BEHAVIOR: - chime-event-has-any-passed-time should return t because the event + chime--event-has-any-passed-time should return t because the event date (today) is not in the future. CURRENT IMPLEMENTATION (as of 2025-10-28): @@ -120,7 +120,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" today-timestamp nil))) ; all-day event (with-test-time now - (should (chime-event-has-any-passed-time event)))) + (should (chime--event-has-any-passed-time event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-has-passed-time-tomorrow-all-day () @@ -144,7 +144,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" tomorrow-timestamp nil))) ; all-day event (with-test-time now - (should-not (chime-event-has-any-passed-time event)))) + (should-not (chime--event-has-any-passed-time event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-has-passed-time-timed-event-past () @@ -168,7 +168,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" past-timestamp t))) ; timed event (with-test-time now - (should (chime-event-has-any-passed-time event)))) + (should (chime--event-has-any-passed-time event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-has-passed-time-timed-event-future () @@ -192,10 +192,10 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" future-timestamp t))) ; timed event (with-test-time now - (should-not (chime-event-has-any-passed-time event)))) + (should-not (chime--event-has-any-passed-time event)))) (test-chime-overdue-teardown))) -;;; Tests for chime-display-as-day-wide-event with overdue setting +;;; Tests for chime--display-as-day-wide-event with overdue setting (ert-deftest test-overdue-display-yesterday-all-day-with-overdue-enabled () "Test that yesterday's all-day event is displayed when overdue is enabled. @@ -221,7 +221,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" yesterday-timestamp nil))) (with-test-time now - (should (chime-display-as-day-wide-event event)))) + (should (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-yesterday-all-day-with-overdue-disabled () @@ -241,7 +241,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" yesterday-timestamp nil))) (with-test-time now - (should-not (chime-display-as-day-wide-event event)))) + (should-not (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-yesterday-timed-with-overdue-enabled () @@ -263,7 +263,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" yesterday-timestamp t))) (with-test-time now - (should (chime-display-as-day-wide-event event)))) + (should (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-yesterday-timed-with-overdue-disabled () @@ -285,7 +285,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" yesterday-timestamp t))) (with-test-time now - (should-not (chime-display-as-day-wide-event event)))) + (should-not (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-today-all-day-always-shown () @@ -307,10 +307,10 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" (with-test-time now ;; Should show with overdue enabled (let ((chime-show-any-overdue-with-day-wide-alerts t)) - (should (chime-display-as-day-wide-event event))) + (should (chime--display-as-day-wide-event event))) ;; Should also show with overdue disabled (it's today, not overdue) (let ((chime-show-any-overdue-with-day-wide-alerts nil)) - (should (chime-display-as-day-wide-event event))))) + (should (chime--display-as-day-wide-event event))))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-week-old-all-day-with-overdue-enabled () @@ -332,7 +332,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" week-ago-timestamp nil))) (with-test-time now - (should (chime-display-as-day-wide-event event)))) + (should (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) (ert-deftest test-overdue-display-week-old-all-day-with-overdue-disabled () @@ -355,7 +355,7 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" week-ago-timestamp nil))) (with-test-time now - (should-not (chime-display-as-day-wide-event event)))) + (should-not (chime--display-as-day-wide-event event)))) (test-chime-overdue-teardown))) ;;; Tests verifying overdue doesn't affect future events @@ -380,10 +380,10 @@ REFACTORED: Uses dynamic timestamps via testutil-time.el" (with-test-time now ;; Should NOT show with overdue enabled (it's future, not today) (let ((chime-show-any-overdue-with-day-wide-alerts t)) - (should-not (chime-display-as-day-wide-event event))) + (should-not (chime--display-as-day-wide-event event))) ;; Should NOT show with overdue disabled (it's future, not today) (let ((chime-show-any-overdue-with-day-wide-alerts nil)) - (should-not (chime-display-as-day-wide-event event))))) + (should-not (chime--display-as-day-wide-event event))))) (test-chime-overdue-teardown))) (provide 'test-chime-overdue-todos) -- cgit v1.2.3