diff options
| -rw-r--r-- | modules/dashboard-config.el | 2 | ||||
| -rw-r--r-- | modules/linear-config.el | 132 | ||||
| -rw-r--r-- | tests/test-dashboard-config-launchers.el | 2 | ||||
| -rw-r--r-- | tests/test-linear-config.el | 52 |
4 files changed, 94 insertions, 94 deletions
diff --git a/modules/dashboard-config.el b/modules/dashboard-config.el index cb853d1d..0ee9200b 100644 --- a/modules/dashboard-config.el +++ b/modules/dashboard-config.el @@ -77,7 +77,7 @@ Adjust this if the title doesn't appear centered under the banner image.") (list "i" #'nerd-icons-faicon "nf-fa-comments" "IRC" "Emacs Relay Chat" (lambda () (cj/erc-switch-to-buffer-with-completion))) (list "g" #'nerd-icons-faicon "nf-fa-telegram" "Telegram" "Telega Telegram Client" (lambda () (cj/telega))) (list "s" #'nerd-icons-faicon "nf-fa-slack" "Slack" "Slack Client" (lambda () (cj/slack-start))) - (list "l" #'nerd-icons-octicon "nf-oct-issue_tracks" "Linear" "Linear Issue Tracker" (lambda () (linear-emacs-list-issues)))) + (list "l" #'nerd-icons-octicon "nf-oct-issue_tracks" "Linear" "Linear Issue Tracker" (lambda () (pearl-list-issues)))) "Dashboard launcher table: (KEY ICON-FN ICON-NAME LABEL TOOLTIP ACTION). Drives both `dashboard-navigator-buttons' and the dashboard-mode-map keys.") diff --git a/modules/linear-config.el b/modules/linear-config.el index 459fcf79..0a62c870 100644 --- a/modules/linear-config.el +++ b/modules/linear-config.el @@ -3,7 +3,7 @@ ;;; Commentary: -;; Wires the local linear-emacs checkout (~/code/linear-emacs) into the config, +;; Wires the local pearl checkout (~/code/pearl) into the config, ;; pointed at DeepSat's Linear workspace. ;; ;; Authentication: @@ -31,21 +31,21 @@ (require 'system-lib) ;; provides cj/auth-source-secret-value -;; Owned by linear-emacs, which loads lazily via :load-path below. -(defvar linear-emacs-api-key) -(defvar linear-emacs-default-team-id) -(defvar linear-emacs-org-file-path) -(declare-function linear-emacs--graphql-request-async "linear-emacs") +;; Owned by pearl, which loads lazily via :load-path below. +(defvar pearl-api-key) +(defvar pearl-default-team-id) +(defvar pearl-org-file-path) +(declare-function pearl--graphql-request-async "pearl") (defconst cj/linear-team-id "9fca2cf6-390c-4102-a9ff-f94a4ed823c5" "Linear team id for DeepSat's Software Engineering team (the SE-* issues).") (defun cj/linear--ensure-api-key () - "Load the Linear API key from authinfo.gpg into `linear-emacs-api-key' if unset. + "Load the Linear API key from authinfo.gpg into `pearl-api-key' if unset. Looks up host \"api.linear.app\". This is a no-op once the key is set, so the GPG prompt fires at most once per session and only when Linear is actually used." - (unless linear-emacs-api-key - (setq linear-emacs-api-key (cj/auth-source-secret-value "api.linear.app")))) + (unless pearl-api-key + (setq pearl-api-key (cj/auth-source-secret-value "api.linear.app")))) (defun cj/linear--ensure-key-before (&rest _) "Advice: load the Linear API key before a GraphQL request runs. @@ -54,50 +54,50 @@ Named (not a lambda) so the advice is idempotent across reloads and removable." (defun cj/linear--install-key-advice () "Install the lazy API-key loader on every entry point that needs the key. -The GraphQL request funnels all real operations. `linear-emacs-check-setup' -reads `linear-emacs-api-key' directly without making a request, so it needs the +The GraphQL request funnels all real operations. `pearl-check-setup' +reads `pearl-api-key' directly without making a request, so it needs the loader too — otherwise it reports \"not set\" on a fresh session before the key has ever been fetched." - (advice-add 'linear-emacs--graphql-request-async :before + (advice-add 'pearl--graphql-request-async :before #'cj/linear--ensure-key-before) - (advice-add 'linear-emacs-check-setup :before + (advice-add 'pearl-check-setup :before #'cj/linear--ensure-key-before)) -(use-package linear-emacs +(use-package pearl :ensure nil ;; local checkout, not from an archive - :load-path "~/code/linear-emacs" + :load-path "~/code/pearl" :defer t - :commands (linear-emacs-list-issues - linear-emacs-list-issues-by-project - linear-emacs-list-issues-filtered - linear-emacs-run-saved-query - linear-emacs-run-view - linear-emacs-refresh-current-view - linear-emacs-refresh-current-issue - linear-emacs-open-current-issue - linear-emacs-open-current-view-in-linear - linear-emacs-new-issue - linear-emacs-delete-current-issue - linear-emacs-add-comment - linear-emacs-set-assignee - linear-emacs-set-state - linear-emacs-set-priority - linear-emacs-set-labels - linear-emacs-sync-current-issue - linear-emacs-sync-current-issue-title - linear-emacs-enable-org-sync - linear-emacs-disable-org-sync - linear-emacs-clear-cache - linear-emacs-toggle-debug - linear-emacs-load-api-key-from-env - linear-emacs-test-connection - linear-emacs-check-setup) + :commands (pearl-list-issues + pearl-list-issues-by-project + pearl-list-issues-filtered + pearl-run-saved-query + pearl-run-view + pearl-refresh-current-view + pearl-refresh-current-issue + pearl-open-current-issue + pearl-open-current-view-in-linear + pearl-new-issue + pearl-delete-current-issue + pearl-add-comment + pearl-set-assignee + pearl-set-state + pearl-set-priority + pearl-set-labels + pearl-sync-current-issue + pearl-sync-current-issue-title + pearl-enable-org-sync + pearl-disable-org-sync + pearl-clear-cache + pearl-toggle-debug + pearl-load-api-key-from-env + pearl-test-connection + pearl-check-setup) :config - (setq linear-emacs-default-team-id cj/linear-team-id) + (setq pearl-default-team-id cj/linear-team-id) ;; Keep the synced org file inside emacs home, next to the calendar-sync ;; output (gcal.org / pcal.org / dcal.org). Without this it falls back to ;; `org-directory'/gtd/linear.org and silently creates a stray ~/org tree. - (setq linear-emacs-org-file-path + (setq pearl-org-file-path (expand-file-name "data/linear.org" user-emacs-directory)) ;; Load the key lazily before any operation that reads it — both the GraphQL ;; request and the check-setup diagnostic. Retries if the key was added to @@ -115,36 +115,36 @@ has ever been fetched." (global-set-key (kbd "C-; L") cj/linear-keymap) ;; Lists and views. -(define-key cj/linear-keymap (kbd "l") #'linear-emacs-list-issues) -(define-key cj/linear-keymap (kbd "p") #'linear-emacs-list-issues-by-project) -(define-key cj/linear-keymap (kbd "f") #'linear-emacs-list-issues-filtered) -(define-key cj/linear-keymap (kbd "q") #'linear-emacs-run-saved-query) -(define-key cj/linear-keymap (kbd "v") #'linear-emacs-run-view) +(define-key cj/linear-keymap (kbd "l") #'pearl-list-issues) +(define-key cj/linear-keymap (kbd "p") #'pearl-list-issues-by-project) +(define-key cj/linear-keymap (kbd "f") #'pearl-list-issues-filtered) +(define-key cj/linear-keymap (kbd "q") #'pearl-run-saved-query) +(define-key cj/linear-keymap (kbd "v") #'pearl-run-view) ;; Refresh. -(define-key cj/linear-keymap (kbd "g") #'linear-emacs-refresh-current-view) -(define-key cj/linear-keymap (kbd "r") #'linear-emacs-refresh-current-issue) +(define-key cj/linear-keymap (kbd "g") #'pearl-refresh-current-view) +(define-key cj/linear-keymap (kbd "r") #'pearl-refresh-current-issue) ;; Issue actions. -(define-key cj/linear-keymap (kbd "o") #'linear-emacs-open-current-issue) -(define-key cj/linear-keymap (kbd "V") #'linear-emacs-open-current-view-in-linear) -(define-key cj/linear-keymap (kbd "n") #'linear-emacs-new-issue) -(define-key cj/linear-keymap (kbd "D") #'linear-emacs-delete-current-issue) +(define-key cj/linear-keymap (kbd "o") #'pearl-open-current-issue) +(define-key cj/linear-keymap (kbd "V") #'pearl-open-current-view-in-linear) +(define-key cj/linear-keymap (kbd "n") #'pearl-new-issue) +(define-key cj/linear-keymap (kbd "D") #'pearl-delete-current-issue) ;; Sync. -(define-key cj/linear-keymap (kbd "s") #'linear-emacs-enable-org-sync) -(define-key cj/linear-keymap (kbd "S") #'linear-emacs-disable-org-sync) -(define-key cj/linear-keymap (kbd "u") #'linear-emacs-sync-current-issue) -(define-key cj/linear-keymap (kbd "U") #'linear-emacs-sync-current-issue-title) +(define-key cj/linear-keymap (kbd "s") #'pearl-enable-org-sync) +(define-key cj/linear-keymap (kbd "S") #'pearl-disable-org-sync) +(define-key cj/linear-keymap (kbd "u") #'pearl-sync-current-issue) +(define-key cj/linear-keymap (kbd "U") #'pearl-sync-current-issue-title) ;; Maintenance. -(define-key cj/linear-keymap (kbd "t") #'linear-emacs-test-connection) -(define-key cj/linear-keymap (kbd "?") #'linear-emacs-check-setup) -(define-key cj/linear-keymap (kbd "k") #'linear-emacs-clear-cache) -(define-key cj/linear-keymap (kbd "d") #'linear-emacs-toggle-debug) +(define-key cj/linear-keymap (kbd "t") #'pearl-test-connection) +(define-key cj/linear-keymap (kbd "?") #'pearl-check-setup) +(define-key cj/linear-keymap (kbd "k") #'pearl-clear-cache) +(define-key cj/linear-keymap (kbd "d") #'pearl-toggle-debug) ;; Edit-issue sub-prefix. (define-key cj/linear-keymap (kbd "e") cj/linear-edit-keymap) -(define-key cj/linear-edit-keymap (kbd "a") #'linear-emacs-set-assignee) -(define-key cj/linear-edit-keymap (kbd "s") #'linear-emacs-set-state) -(define-key cj/linear-edit-keymap (kbd "p") #'linear-emacs-set-priority) -(define-key cj/linear-edit-keymap (kbd "b") #'linear-emacs-set-labels) -(define-key cj/linear-edit-keymap (kbd "c") #'linear-emacs-add-comment) +(define-key cj/linear-edit-keymap (kbd "a") #'pearl-set-assignee) +(define-key cj/linear-edit-keymap (kbd "s") #'pearl-set-state) +(define-key cj/linear-edit-keymap (kbd "p") #'pearl-set-priority) +(define-key cj/linear-edit-keymap (kbd "b") #'pearl-set-labels) +(define-key cj/linear-edit-keymap (kbd "c") #'pearl-add-comment) ;; Register which-key labels lazily so this module's require doesn't depend on ;; which-key being loaded. Same pattern as the other client modules. diff --git a/tests/test-dashboard-config-launchers.el b/tests/test-dashboard-config-launchers.el index f6dfb042..cb925075 100644 --- a/tests/test-dashboard-config-launchers.el +++ b/tests/test-dashboard-config-launchers.el @@ -94,7 +94,7 @@ Slack and Linear sharing the last row." ((symbol-function 'cj/erc-switch-to-buffer-with-completion) (lambda (&rest _) (push 'irc calls))) ((symbol-function 'cj/slack-start) (lambda (&rest _) (push 'slack calls))) ((symbol-function 'cj/telega) (lambda (&rest _) (push 'tg calls))) - ((symbol-function 'linear-emacs-list-issues) (lambda (&rest _) (push 'linear calls)))) + ((symbol-function 'pearl-list-issues) (lambda (&rest _) (push 'linear calls)))) (cj/dashboard--bind-launchers map) (dolist (key test-dash--keys) (call-interactively (keymap-lookup map key))) diff --git a/tests/test-linear-config.el b/tests/test-linear-config.el index ece4cefe..97d94bc4 100644 --- a/tests/test-linear-config.el +++ b/tests/test-linear-config.el @@ -1,9 +1,9 @@ ;;; test-linear-config.el --- Tests for linear-config.el -*- lexical-binding: t; -*- ;;; Commentary: -;; Covers the lazy API-key loader and the keybinding wiring. linear-emacs +;; Covers the lazy API-key loader and the keybinding wiring. pearl ;; itself is never loaded here (it's a deferred :load-path package), so -;; `linear-emacs-api-key' is declared special below to make the dynamic +;; `pearl-api-key' is declared special below to make the dynamic ;; let-bindings reach `cj/linear--ensure-api-key'. `cj/auth-source-secret-value' ;; is stubbed — no authinfo.gpg / GPG access in the tests. @@ -13,74 +13,74 @@ (require 'cl-lib) (require 'linear-config) -;; linear-config declares this with a bare (defvar linear-emacs-api-key), which +;; linear-config declares this with a bare (defvar pearl-api-key), which ;; is only file-local; declare it special here so the let-bindings are dynamic. -(defvar linear-emacs-api-key nil) +(defvar pearl-api-key nil) (ert-deftest test-linear-ensure-api-key-loads-when-unset () "Normal: an unset key is loaded from auth-source." - (let ((linear-emacs-api-key nil)) + (let ((pearl-api-key nil)) (cl-letf (((symbol-function 'cj/auth-source-secret-value) (lambda (&rest _) "lin_api_test"))) (cj/linear--ensure-api-key) - (should (equal linear-emacs-api-key "lin_api_test"))))) + (should (equal pearl-api-key "lin_api_test"))))) (ert-deftest test-linear-ensure-api-key-keeps-existing () "Boundary: an already-set key is neither overwritten nor re-fetched." - (let ((linear-emacs-api-key "already-set") (fetched nil)) + (let ((pearl-api-key "already-set") (fetched nil)) (cl-letf (((symbol-function 'cj/auth-source-secret-value) (lambda (&rest _) (setq fetched t) "other"))) (cj/linear--ensure-api-key) - (should (equal linear-emacs-api-key "already-set")) + (should (equal pearl-api-key "already-set")) (should-not fetched)))) (ert-deftest test-linear-ensure-api-key-nil-when-absent () "Boundary: a missing authinfo entry leaves the key nil without error." - (let ((linear-emacs-api-key nil)) + (let ((pearl-api-key nil)) (cl-letf (((symbol-function 'cj/auth-source-secret-value) (lambda (&rest _) nil))) (cj/linear--ensure-api-key) - (should-not linear-emacs-api-key)))) + (should-not pearl-api-key)))) (ert-deftest test-linear-install-key-advice-loads-before-check-setup () - "Error-regression: `linear-emacs-check-setup' loads the key before reading it. + "Error-regression: `pearl-check-setup' loads the key before reading it. The lazy loader originally only advised the GraphQL request entry point, so -`check-setup' — which reads `linear-emacs-api-key' directly without making a +`check-setup' — which reads `pearl-api-key' directly without making a request — falsely reported \"not set\" on a fresh session." - (let ((linear-emacs-api-key nil) + (let ((pearl-api-key nil) (key-at-read :unread)) (cl-letf (((symbol-function 'cj/auth-source-secret-value) (lambda (&rest _) "lin_api_test")) - ((symbol-function 'linear-emacs--graphql-request-async) + ((symbol-function 'pearl--graphql-request-async) (lambda (&rest _) nil)) - ((symbol-function 'linear-emacs-check-setup) - (lambda () (setq key-at-read linear-emacs-api-key)))) + ((symbol-function 'pearl-check-setup) + (lambda () (setq key-at-read pearl-api-key)))) (cj/linear--install-key-advice) (unwind-protect (progn - (linear-emacs-check-setup) + (pearl-check-setup) (should (equal key-at-read "lin_api_test"))) - (advice-remove 'linear-emacs--graphql-request-async + (advice-remove 'pearl--graphql-request-async #'cj/linear--ensure-key-before) - (advice-remove 'linear-emacs-check-setup + (advice-remove 'pearl-check-setup #'cj/linear--ensure-key-before))))) (ert-deftest test-linear-keymap-bound-under-prefix () "Smoke: C-; L holds the linear keymap and the entry commands are bound." (should (keymapp cj/linear-keymap)) (should (eq (keymap-lookup (current-global-map) "C-; L") cj/linear-keymap)) - (should (eq (keymap-lookup cj/linear-keymap "l") #'linear-emacs-list-issues)) - (should (eq (keymap-lookup cj/linear-keymap "n") #'linear-emacs-new-issue)) + (should (eq (keymap-lookup cj/linear-keymap "l") #'pearl-list-issues)) + (should (eq (keymap-lookup cj/linear-keymap "n") #'pearl-new-issue)) ;; commands added in the package rework - (should (eq (keymap-lookup cj/linear-keymap "f") #'linear-emacs-list-issues-filtered)) - (should (eq (keymap-lookup cj/linear-keymap "v") #'linear-emacs-run-view)) - (should (eq (keymap-lookup cj/linear-keymap "o") #'linear-emacs-open-current-issue))) + (should (eq (keymap-lookup cj/linear-keymap "f") #'pearl-list-issues-filtered)) + (should (eq (keymap-lookup cj/linear-keymap "v") #'pearl-run-view)) + (should (eq (keymap-lookup cj/linear-keymap "o") #'pearl-open-current-issue))) (ert-deftest test-linear-edit-submap-bound () "Smoke: C-; L e holds the edit-issue sub-keymap with field commands." (should (keymapp cj/linear-edit-keymap)) (should (eq (keymap-lookup cj/linear-keymap "e") cj/linear-edit-keymap)) - (should (eq (keymap-lookup cj/linear-edit-keymap "a") #'linear-emacs-set-assignee)) - (should (eq (keymap-lookup cj/linear-edit-keymap "s") #'linear-emacs-set-state))) + (should (eq (keymap-lookup cj/linear-edit-keymap "a") #'pearl-set-assignee)) + (should (eq (keymap-lookup cj/linear-edit-keymap "s") #'pearl-set-state))) (provide 'test-linear-config) ;;; test-linear-config.el ends here |