Refactor uncoupling tests with lens

ericdallo · ericdallo · commit 1668527ca41e · 2020-09-15T21:56:30.000-03:00
diff --git a/lsp-dart-code-lens.el b/lsp-dart-code-lens.el
@@ -131,24 +131,20 @@ If TEST-FILE? debug tests otherwise debug application."
                                                            test-file?)
                          "\n"))))
 
-(lsp-defun lsp-dart-code-lens--build-test-overlay (buffer names kind test-range (range &as &Range :start
-                                                                                       (&Position :character beg-position)))
+(lsp-defun lsp-dart-code-lens--build-test-overlay (test)
   "Build an overlay in BUFFER for a test NAMES of KIND.
 TEST-RANGE is the test method range.
 RANGE is the overlay range to build."
-  (-let* (((beg . end) (lsp--range-to-region range))
+  (-let* (((beg . end) (plist-get test :element-range))
+          (beg-position (-> (lsp--region-to-range beg end)
+                            (plist-get :start)
+                            (plist-get :character)))
           (beg-line (progn (goto-char beg)
                            (line-beginning-position)))
           (spaces (make-string beg-position ?\s))
-          (overlay (make-overlay beg-line end buffer))
-          (test (make-lsp-dart-test-len :file-name (buffer-file-name buffer)
-                                        :names names
-                                        :position beg
-                                        :kind kind))
+          (overlay (make-overlay beg-line end (current-buffer)))
           (separator (propertize " " 'font-lock-face 'lsp-dart-code-lens-separator)))
     (overlay-put overlay 'lsp-dart-test-code-lens t)
-    (overlay-put overlay 'lsp-dart-test test)
-    (overlay-put overlay 'lsp-dart-code-lens-overlay-test-range (lsp--range-to-region test-range))
     (overlay-put overlay 'before-string
                  (concat spaces
                          (lsp-dart-code-lens--build-action "Run"
@@ -164,21 +160,6 @@ RANGE is the overlay range to build."
                                                            test)
                          "\n"))))
 
-(defun lsp-dart-code-lens--add-test (buffer items &optional names)
-  "Add test code lens to BUFFER for ITEMS.
-NAMES arg is optional and are the group of tests representing a test name."
-  (seq-doseq (item items)
-    (-let* (((&Outline :children :code-range test-range :element
-                       (&Element :kind :name :range)) item)
-            (test-kind? (lsp-dart-test--test-kind-p kind))
-            (concatened-names (if test-kind?
-                                  (append names (list name))
-                                names)))
-      (when test-kind?
-        (lsp-dart-code-lens--build-test-overlay buffer (append names (list name)) kind test-range range))
-      (unless (seq-empty-p children)
-        (lsp-dart-code-lens--add-test buffer children concatened-names)))))
-
 (lsp-defun lsp-dart--main-code-lens-check ((&OutlineNotification :uri :outline (&Outline :children)))
   "Check URI and outline for main method adding lens to it."
   (-let* ((buffer (find-buffer-visiting (lsp--uri-to-path uri)))
@@ -190,14 +171,12 @@ NAMES arg is optional and are the group of tests representing a test name."
           (save-excursion
             (lsp-dart-code-lens--build-main-overlay buffer main-outline)))))))
 
-(lsp-defun lsp-dart--test-code-lens-check ((&OutlineNotification :uri :outline (&Outline :children)))
-  "Check URI and outline for test adding lens to it."
-  (when (lsp-dart-test-file-p uri)
-    (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
-      (with-current-buffer buffer
-        (remove-overlays (point-min) (point-max) 'lsp-dart-test-code-lens t)
-        (save-excursion
-          (lsp-dart-code-lens--add-test buffer children))))))
+(lsp-defun lsp-dart--set-test-lens (tests)
+  "Add lens to the given TESTS."
+  (save-excursion
+    (remove-overlays (point-min) (point-max) 'lsp-dart-test-code-lens t)
+    (seq-doseq (test tests)
+      (lsp-dart-code-lens--build-test-overlay test))))
 
 
 ;; Public
@@ -225,7 +204,7 @@ NAMES arg is optional and are the group of tests representing a test name."
     (lsp-dart-define-key "t L" #'lsp-dart-debug-last-test)
     (lsp-dart-define-key "t a" #'lsp-dart-run-all-tests)
     (lsp-dart-define-key "t v" #'lsp-dart-visit-last-test)
-    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--test-code-lens-check nil t))
+    (add-hook 'lsp-dart-tests-added-hook #'lsp-dart--set-test-lens nil t))
    (t
     (lsp-dart-define-key "t t" 'ignore)
     (lsp-dart-define-key "t T" 'ignore)
@@ -235,7 +214,7 @@ NAMES arg is optional and are the group of tests representing a test name."
     (lsp-dart-define-key "t a" 'ignore)
     (lsp-dart-define-key "t v" 'ignore)
     (remove-overlays (point-min) (point-max) 'lsp-dart-test-code-lens t)
-    (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--test-code-lens-check t))))
+    (remove-hook 'lsp-dart-tests-added-hook #'lsp-dart--set-test-lens t))))
 
 (provide 'lsp-dart-code-lens)
 ;;; lsp-dart-code-lens.el ends here
diff --git a/lsp-dart-test-support.el b/lsp-dart-test-support.el
@@ -35,19 +35,13 @@
 
 (defconst lsp-dart-test--process-buffer-name "*LSP Dart - tests process*")
 
-(defvar lsp-dart-test--tests nil)
+(defvar-local lsp-dart-test--tests nil)
+(defvar lsp-dart-test--running-tests nil)
 
-(cl-defstruct lsp-dart-test
+(cl-defstruct lsp-dart-running-test
   (id nil)
   (name nil)
-  (start-time nil)
-  (group-ids nil))
-
-(cl-defstruct lsp-dart-test-len
-  (file-name nil)
-  (names nil)
-  (position nil)
-  (kind nil))
+  (start-time nil))
 
 (defun lsp-dart-test--test-kind-p (kind)
   "Return non-nil if KIND is a test type."
@@ -100,13 +94,13 @@ IGNORE-CASE is a optional arg to ignore the case sensitive on regex search."
   "Return non-nil if some test is already running."
   (comint-check-proc lsp-dart-test--process-buffer-name))
 
-(defun lsp-dart-test--set-test (id test)
+(defun lsp-dart-test--set-running-test (id test)
   "Add TEST with key ID."
-  (setf (alist-get id lsp-dart-test--tests) test))
+  (setf (alist-get id lsp-dart-test--running-tests) test))
 
-(defun lsp-dart-test--get-test (id)
+(defun lsp-dart-test--get-running-test (id)
   "Return the test from ID if exists."
-  (alist-get id lsp-dart-test--tests))
+  (alist-get id lsp-dart-test--running-tests))
 
 (cl-defgeneric lsp-dart-test--handle-notification (type notification)
   "Extension point for handling custom events.
@@ -119,16 +113,15 @@ NOTIFICATION is the event notification.")
 
 (cl-defmethod lsp-dart-test--handle-notification ((_event (eql start)) notification)
   "Handle start NOTIFICATION."
-  (setq lsp-dart-test--tests nil)
+  (setq lsp-dart-test--running-tests nil)
   (run-hook-with-args 'lsp-dart-test-all-start-notification-hook notification))
 
 (cl-defmethod lsp-dart-test--handle-notification ((_event (eql testStart)) notification)
   "Handle testStart NOTIFICATION."
-  (-let (((&TestStartNotification :time :test (&Test :id :group-i-ds :name?)) notification))
-    (lsp-dart-test--set-test id (make-lsp-dart-test :id id
+  (-let (((&TestStartNotification :time :test (&Test :id :name?)) notification))
+    (lsp-dart-test--set-running-test id (make-lsp-dart-running-test :id id
                                                     :name name?
-                                                    :start-time time
-                                                    :group-ids group-i-ds))
+                                                    :start-time time))
     (run-hook-with-args 'lsp-dart-test-start-notification-hook notification)))
 
 (cl-defmethod lsp-dart-test--handle-notification ((_event (eql allSuites)) _notification)
@@ -145,11 +138,11 @@ NOTIFICATION is the event notification.")
 (cl-defmethod lsp-dart-test--handle-notification ((_event (eql testDone)) notification)
   "Handle test done NOTIFICATION."
   (-let (((&TestDoneNotification :test-id) notification))
-    (when-let (test (lsp-dart-test--get-test test-id))
+    (when-let (test (lsp-dart-test--get-running-test test-id))
       (run-hook-with-args 'lsp-dart-test-done-notification-hook
                           notification
-                          (lsp-dart-test-name test)
-                          (lsp-dart-test-start-time test)))))
+                          (lsp-dart-running-test-name test)
+                          (lsp-dart-running-test-start-time test)))))
 
 (cl-defmethod lsp-dart-test--handle-notification ((_event (eql done)) notification)
   "Handle done NOTIFICATION."
@@ -197,9 +190,9 @@ If TEST is nil, it will run all tests from project.
 If TEST is non nil, it will check if contains any test specific name
 to run otherwise run all tests from file-name in TEST."
   (if test
-      (let* ((names (lsp-dart-test-len-names test))
-             (kind (lsp-dart-test-len-kind test))
-             (test-file (file-relative-name (lsp-dart-test-len-file-name test)
+      (let* ((names (plist-get test :names))
+             (kind (plist-get test :kind))
+             (test-file (file-relative-name (plist-get test :file-name)
                                             (lsp-dart-get-project-root)))
              (test-name (lsp-dart-test--build-test-name names))
              (group-kind? (string= kind "UNIT_TEST_GROUP"))
@@ -219,9 +212,9 @@ to run otherwise run all tests from file-name in TEST."
 
 (defun lsp-dart-test--debug (test)
   "Debug Dart/Flutter TEST."
-  (let* ((file-name (lsp-dart-test-len-file-name test))
-         (names (lsp-dart-test-len-names test))
-         (kind (lsp-dart-test-len-kind test))
+  (let* ((file-name (plist-get test :file-name))
+         (names (plist-get test :names))
+         (kind (plist-get test :kind))
          (test-name (lsp-dart-test--build-test-name names))
          (group-kind? (string= kind "UNIT_TEST_GROUP"))
          (regex (concat "^"
@@ -233,17 +226,16 @@ to run otherwise run all tests from file-name in TEST."
         (lsp-dart-dap-debug-flutter-test file-name test-arg)
       (lsp-dart-dap-debug-dart-test file-name test-arg))))
 
-(defun lsp-dart-test--overlay-at-point ()
-  "Return test overlay at point.
-Return the overlay which has the smallest range of all test overlays in
-the current buffer."
-  (-some--> (overlays-in (point-min) (point-max))
-    (--filter (when (overlay-get it 'lsp-dart-test-code-lens)
-                (-let* (((beg . end) (overlay-get it 'lsp-dart-code-lens-overlay-test-range)))
-                  (and (>= (point) beg)
-                       (<= (point) end)))) it)
-    (--min-by (-let* (((beg1 . end1) (overlay-get it 'lsp-dart-code-lens-overlay-test-range))
-                      ((beg2 . end2) (overlay-get other 'lsp-dart-code-lens-overlay-test-range)))
+(defun lsp-dart-test--test-at-point ()
+  "Return the test at point.
+Return the test which has the smallest range of all tests ranges in the
+current buffer."
+  (-some--> lsp-dart-test--tests
+    (--filter (-let* (((beg . end) (plist-get it :code-range)))
+                (and (>= (point) beg)
+                     (<= (point) end))) it)
+    (--min-by (-let* (((beg1 . end1) (plist-get it :code-range))
+                      ((beg2 . end2) (plist-get other :code-range)))
                 (and (< beg1 beg2)
                      (> end1 end2))) it)))
 
@@ -253,6 +245,35 @@ the current buffer."
           (lsp-dart-test--handle-notification (intern (lsp-get notification :type)) notification))
         (lsp-dart-test--raw->response raw-response)))
 
+(defun lsp-dart-test--add-test (items &optional names)
+  "Add to test listfor ITEMS.
+NAMES arg is optional and are the group of tests representing a test name."
+  (seq-doseq (item items)
+    (-let* (((&Outline :children :code-range test-range :element
+                       (&Element :kind :name :range)) item)
+            (test-kind? (lsp-dart-test--test-kind-p kind))
+            (concatened-names (if test-kind?
+                                  (append names (list name))
+                                names))
+            (new-test (list :file-name (file-truename (buffer-file-name))
+                            :names (append names (list name))
+                            :kind kind
+                            :code-range (lsp--range-to-region test-range)
+                            :element-range (lsp--range-to-region range))))
+      (when test-kind?
+        (add-to-list 'lsp-dart-test--tests new-test))
+      (unless (seq-empty-p children)
+        (lsp-dart-test--add-test children concatened-names)))))
+
+(lsp-defun lsp-dart-test--check-tests ((&OutlineNotification :uri :outline (&Outline :children)))
+  "Check URI and outline for test adding them."
+  (when (lsp-dart-test-file-p uri)
+    (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
+      (with-current-buffer buffer
+        (setq lsp-dart-test--tests nil)
+        (lsp-dart-test--add-test children)
+        (run-hook-with-args 'lsp-dart-tests-added-hook lsp-dart-test--tests)))))
+
 
 ;;; Public
 
@@ -265,20 +286,18 @@ the current buffer."
 
 ;;;###autoload
 (defun lsp-dart-run-test-at-point ()
-  "Run test at point.
-Search for the last test overlay."
+  "Run test at point."
   (interactive)
-  (if-let (overlay (lsp-dart-test--overlay-at-point))
-      (lsp-dart-test--run (overlay-get overlay 'lsp-dart-test))
+  (if-let (test (lsp-dart-test--test-at-point))
+      (lsp-dart-test--run test)
     (lsp-dart-log "No test found at point.")))
 
 ;;;###autoload
 (defun lsp-dart-debug-test-at-point ()
-  "Debug test at point.
-Search for the last test overlay."
+  "Debug test at point."
   (interactive)
-  (if-let (overlay (lsp-dart-test--overlay-at-point))
-      (lsp-dart-test--debug (overlay-get overlay 'lsp-dart-test))
+  (if-let (test (lsp-dart-test--test-at-point))
+      (lsp-dart-test--debug test)
     (lsp-dart-log "No test found at point.")))
 
 ;;;###autoload
@@ -289,7 +308,7 @@ Search for the last test overlay."
       (lsp-dart-test--run (->> (current-buffer)
                                buffer-name
                                file-truename
-                               (make-lsp-dart-test-len :file-name)))
+                               (list :file-name)))
     (lsp-dart-log "Current buffer is not a Dart/Flutter test file.")))
 
 ;;;###autoload
@@ -303,17 +322,17 @@ Search for the last test overlay."
   "Visit the last ran test going to test definition."
   (interactive)
   (-if-let* ((test (lsp-workspace-get-metadata "last-ran-test"))
-             (file-name (lsp-dart-test-len-file-name test))
+             (file-name (plist-get test :file-name))
              (buffer (or (get-file-buffer file-name)
                          (find-file file-name)))
-             (position (lsp-dart-test-len-position test)))
+             (beg-position (car (plist-get test :element-range))))
       (if-let ((window (get-buffer-window buffer 'visible)))
           (progn
             (select-window window)
-            (goto-char position))
+            (goto-char beg-position))
         (with-current-buffer buffer
           (switch-to-buffer buffer nil t)
-          (goto-char position)))
+          (goto-char beg-position)))
     (lsp-dart-log "No last test found.")))
 
 ;;;###autoload
@@ -343,6 +362,15 @@ Search for the last test overlay."
     (setenv "PATH" (concat (lsp-dart-pub-command) ":" (getenv "PATH"))))
   (setq-local comint-output-filter-functions #'lsp-dart-test--handle-process-response))
 
+(define-minor-mode lsp-dart-test-mode
+  "Mode for saving tests info for runs."
+  nil nil nil
+  (cond
+   (lsp-dart-test-mode
+    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart-test--check-tests nil t))
+   (t
+    (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart-test--check-tests t))))
+
 
 (provide 'lsp-dart-test-support)
 ;;; lsp-dart-test-support.el ends here
diff --git a/lsp-dart.el b/lsp-dart.el
@@ -131,6 +131,7 @@ PARAMS is the data sent from server."
   (when lsp-dart-closing-labels (lsp-dart-closing-labels-mode 1))
   (when lsp-dart-outline (lsp-dart-outline-mode 1))
   (when lsp-dart-flutter-outline (lsp-dart-flutter-outline-mode 1))
+  (when (lsp-dart-test-file-p (buffer-file-name)) (lsp-dart-test-mode 1))
   (when lsp-dart-main-code-lens (lsp-dart-main-code-lens-mode 1))
   (when lsp-dart-test-code-lens (lsp-dart-test-code-lens-mode 1)))
 
