You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
169 lines
6.2 KiB
169 lines
6.2 KiB
;;; alchemist-test-mode.el --- Minor mode for Elixir test files.
|
|
|
|
;; Copyright © 2015 Samuel Tonini
|
|
|
|
;; Author: Samuel Tonini <tonini.samuel@gmail.com
|
|
|
|
;; This file is not part of GNU Emacs.
|
|
|
|
;; This program is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Minor mode for Elixir test files.
|
|
|
|
;;; Code:
|
|
|
|
(defgroup alchemist-test-mode nil
|
|
"Minor mode for Elixir ExUnit files."
|
|
:prefix "alchemist-test-mode-"
|
|
:group 'alchemist)
|
|
|
|
;; Variables
|
|
|
|
(defvar alchemist-test-mode-buffer-name "*alchemist-test-report*"
|
|
"Name of the test report buffer.")
|
|
|
|
(defcustom alchemist-test-mode-highlight-tests t
|
|
"Non-nil means that specific functions for testing will
|
|
be highlighted with more significant font faces."
|
|
:type 'boolean
|
|
:group 'alchemist-test-mode)
|
|
|
|
(defvar alchemist-test-at-point #'alchemist-mix-test-at-point)
|
|
(defvar alchemist-test-this-buffer #'alchemist-mix-test-this-buffer)
|
|
(defvar alchemist-test #'alchemist-mix-test)
|
|
(defvar alchemist-test-file #'alchemist-mix-test-file)
|
|
(defvar alchemist-test-jump-to-previous-test #'alchemist-test-mode-jump-to-previous-test)
|
|
(defvar alchemist-test-jump-to-next-test #'alchemist-test-mode-jump-to-next-test)
|
|
(defvar alchemist-test-list-tests #'alchemist-test-mode-list-tests)
|
|
|
|
(defvar alchemist-test-mode-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(define-key map (kbd "C-c , s") alchemist-test-at-point)
|
|
(define-key map (kbd "C-c , v") alchemist-test-this-buffer)
|
|
(define-key map (kbd "C-c , a") alchemist-test)
|
|
(define-key map (kbd "C-c , f") alchemist-test-file)
|
|
(define-key map (kbd "C-c , p") alchemist-test-jump-to-previous-test)
|
|
(define-key map (kbd "C-c , n") alchemist-test-jump-to-next-test)
|
|
(define-key map (kbd "C-c , l") alchemist-test-list-tests)
|
|
map)
|
|
"Keymap for `alchemist-test-mode'.")
|
|
|
|
(let ((whitespace-opt "[[:space:]]*")
|
|
(whitespace "[[:space:]]+"))
|
|
(setq alchemist-test-mode--test-regex
|
|
(concat
|
|
"\\(^" whitespace-opt "test" whitespace "\\(?10:.+\\)" whitespace "do" whitespace-opt "$"
|
|
"\\|"
|
|
whitespace " [0-9]+) test .+\\)")))
|
|
|
|
;; Private functions
|
|
|
|
(defun alchemist-test-mode--buffer-contains-tests-p ()
|
|
"Return nil if the current buffer contains no tests, non-nil if it does."
|
|
(save-excursion
|
|
(save-match-data
|
|
(beginning-of-buffer)
|
|
(re-search-forward alchemist-test-mode--test-regex nil t))))
|
|
|
|
(defun alchemist-test-mode--jump-to-test (search-fn reset-fn)
|
|
"Move the point to the next/previous test, based on `search-fn' (which is the
|
|
function that searches for the next test, can be re-search-forward or
|
|
re-search-backward) and `reset-fn' (which is used when wrapping at the
|
|
beginning/end of the buffer if no results were found)."
|
|
(when (alchemist-test-mode--buffer-contains-tests-p)
|
|
(save-match-data
|
|
(unless (funcall search-fn alchemist-test-mode--test-regex nil t)
|
|
(funcall reset-fn)
|
|
(funcall search-fn alchemist-test-mode--test-regex nil t))
|
|
(back-to-indentation))))
|
|
|
|
(defun alchemist-test-mode--tests-in-buffer ()
|
|
"Return an alist of tests in this buffer.
|
|
|
|
The keys in the list are the test names (e.g., the string passed to the test/2
|
|
macro) while the values are the position at which the test matched."
|
|
(save-match-data
|
|
(save-excursion
|
|
(beginning-of-buffer)
|
|
(let ((tests '()))
|
|
(while (re-search-forward alchemist-test-mode--test-regex nil t)
|
|
(let* ((position (car (match-data)))
|
|
(matched-string (match-string 10)))
|
|
(set-text-properties 0 (length matched-string) nil matched-string)
|
|
(add-to-list 'tests (cons matched-string position) t)))
|
|
tests))))
|
|
|
|
;; Public functions
|
|
|
|
(defun alchemist-test-mode-jump-to-next-test ()
|
|
"Jump to the next ExUnit test. If there are no tests after the current
|
|
position, jump to the first test in the buffer. Do nothing if there are no tests
|
|
in this buffer."
|
|
(interactive)
|
|
(alchemist-test-mode--jump-to-test 're-search-forward 'beginning-of-buffer))
|
|
|
|
(defun alchemist-test-mode-jump-to-previous-test ()
|
|
"Jump to the previous ExUnit test. If there are no tests before the current
|
|
position, jump to the last test in the buffer. Do nothing if there are no tests
|
|
in this buffer."
|
|
(interactive)
|
|
(alchemist-test-mode--jump-to-test 're-search-backward 'end-of-buffer))
|
|
|
|
(defun alchemist-test-mode-list-tests ()
|
|
"List ExUnit tests (calls to the test/2 macro) in the current buffer and jump
|
|
to the selected one."
|
|
(interactive)
|
|
(let* ((tests (alchemist-test-mode--tests-in-buffer))
|
|
(selected (completing-read "Test: " tests))
|
|
(position (cdr (assoc selected tests))))
|
|
(goto-char position)
|
|
(back-to-indentation)))
|
|
|
|
(defun alchemist-test-mode--highlight-syntax ()
|
|
(if alchemist-test-mode-highlight-tests
|
|
(font-lock-add-keywords nil
|
|
'(("^\s+\\(test\\)\s+" 1
|
|
font-lock-variable-name-face t)
|
|
("^\s+\\(assert[_a-z]*\\|refute[_a-z]*\\)\s+" 1
|
|
font-lock-type-face t)
|
|
("^\s+\\(assert[_a-z]*\\|refute[_a-z]*\\)\(" 1
|
|
font-lock-type-face t)))))
|
|
|
|
|
|
;;;###autoload
|
|
(define-minor-mode alchemist-test-mode
|
|
"Minor mode for Elixir ExUnit files.
|
|
|
|
The following commands are available:
|
|
|
|
\\{alchemist-test-mode-map}"
|
|
:lighter "" :keymap alchemist-test-mode-map
|
|
:group 'alchemist
|
|
(when alchemist-test-mode
|
|
(alchemist-test-mode--highlight-syntax)))
|
|
|
|
;;;###autoload
|
|
(defun alchemist-test-enable-mode ()
|
|
(if (alchemist-utils--is-test-file-p)
|
|
(alchemist-test-mode)))
|
|
|
|
;;;###autoload
|
|
(dolist (hook '(alchemist-mode-hook))
|
|
(add-hook hook 'alchemist-test-enable-mode))
|
|
|
|
(provide 'alchemist-test-mode)
|
|
|
|
;;; alchemist-test-mode.el ends here
|