Merge pull request #1776 from galaunay/better-docstring-folding

Better docstring detection when folding

Author: galaunay

elpy.el

@@ -3260,15 +3260,6 @@ display the current class and method instead."
   "^\\s-*[uU]?[rR]?\"\"\"\n?\\s-*"
   "Version of `hs-block-start-regexp' for docstrings.")
 
-;; Herlpers
-(defun elpy-info-docstring-p (&optional syntax-ppss)
-  "Return non-nil if point is in a docstring."
-  (save-excursion
-    (and (progn (python-nav-beginning-of-statement)
-                (looking-at "\\(\"\\|'\\)"))
-         (progn (forward-line -1)
-                (beginning-of-line)
-                (python-info-looking-at-beginning-of-defun)))))
 ;; Indicators
 (defun elpy-folding--display-code-line-counts (ov)
   "Display a folded region indicator with the number of folded lines.
@@ -3415,11 +3406,11 @@ docstring body."
   "Hide the docstring at point."
   (hs-life-goes-on
    (let ((hs-block-start-regexp elpy-docstring-block-start-regexp))
-     (when (and (elpy-info-docstring-p) (not (hs-already-hidden-p)))
+     (when (and (python-info-docstring-p) (not (hs-already-hidden-p)))
        (let (beg end line-beg line-end)
          ;; Get first doc line
          (if (not (save-excursion (forward-line -1)
-                                  (elpy-info-docstring-p)))
+                                  (python-info-docstring-p)))
              (setq beg (line-beginning-position))
            (forward-line -1)
            (end-of-line)
@@ -3432,7 +3423,7 @@ docstring body."
          (setq line-beg (line-number-at-pos))
          ;; Get last line
          (if (not (save-excursion (forward-line 1)
-                                  (elpy-info-docstring-p)))
+                                  (python-info-docstring-p)))
              (progn
                (setq end (line-end-position))
                (setq line-end (line-number-at-pos)))
@@ -3447,7 +3438,7 @@ docstring body."
   "Show docstring at point."
   (hs-life-goes-on
    (let ((hs-block-start-regexp elpy-docstring-block-start-regexp))
-     (when (elpy-info-docstring-p)
+     (when (python-info-docstring-p)
        (hs-show-block)))))
 
 (defvar-local elpy-folding-docstrings-hidden nil
@@ -3464,7 +3455,7 @@ docstring body."
        (while (python-nav-forward-defun)
          (search-forward-regexp ")\\s-*:" nil t)
          (forward-line)
-         (when (and (elpy-info-docstring-p)
+         (when (and (python-info-docstring-p)
                     (progn
                       (beginning-of-line)
                       (search-forward-regexp elpy-folding-docstring-regex
@@ -3577,14 +3568,14 @@ If a region is selected, fold that region."
          (elpy-folding--hide-region (region-beginning) (region-end))
        ;; Adapt starting regexp if on a docstring
        (let ((hs-block-start-regexp
-              (if (elpy-info-docstring-p)
+              (if (python-info-docstring-p)
                   elpy-docstring-block-start-regexp
                 hs-block-start-regexp)))
          ;; Hide or fold
          (cond
           ((hs-already-hidden-p)
            (hs-show-block))
-          ((elpy-info-docstring-p)
+          ((python-info-docstring-p)
            (elpy-folding--hide-docstring-at-point))
           (t
            (hs-hide-block))))))))
@@ -4029,5 +4020,15 @@ which we're looking."
       (rx eos))
      output)))
 
+(unless (fboundp 'python-info-docstring-p)
+  (defun python-info-docstring-p (&optional syntax-ppss)
+    "Return non-nil if point is in a docstring."
+    (save-excursion
+      (and (progn (python-nav-beginning-of-statement)
+                  (looking-at "\\(\"\\|'\\)"))
+           (progn (forward-line -1)
+                  (beginning-of-line)
+                  (python-info-looking-at-beginning-of-defun))))))
+
 (provide 'elpy)
 ;;; elpy.el ends here

test/elpy-folding-fold-all-comments-test.el

@@ -26,28 +26,27 @@
     (elpy-folding-toggle-comments)
     (let* ((overlays (overlays-in (point-min) (point-max)))
            overlay)
-      (should (= 6 (length overlays)))
       ;; first two lines comment
-      (setq overlay (nth 5 overlays))
+      (setq overlay (elpy-get-overlay-at 49 'comment))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'comment))
       (should (= (overlay-start overlay) 49))
       (should (= (overlay-end overlay) 83))
       ;; second three lines comment
-      (setq overlay (nth 2 overlays))
+      (setq overlay (elpy-get-overlay-at 184 'comment))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'comment))
       (should (= (overlay-start overlay) 184))
       (should (= (overlay-end overlay) 229))
       ;; third two lines comment
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 340 'comment))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'comment))
       (should (= (overlay-start overlay) 340))
       (should (= (overlay-end overlay) 354)))
     ;; point shouldn't move
     (should (= (point) 177))
     ;; Unfold all comments
     (elpy-folding-toggle-comments)
-    (let* ((overlays (overlays-in (point-min) (point-max)))
-           overlay)
-      (should (= 3 (length overlays))))
     ;; Position
     (should (= (point) 177))))

test/elpy-folding-fold-all-docstrings-test.el

@@ -36,12 +36,14 @@
            overlay)
       (should (= 6 (length overlays)))
       ;; First docstring
-      (setq overlay (nth 3 overlays))
+      (setq overlay (elpy-get-overlay-at 97 'docstring))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'docstring))
       (should (= (overlay-start overlay) 97))
       (should (= (overlay-end overlay) 124))
       ;; Second docstring
-      (setq overlay (nth 1 overlays))
+      (setq overlay (elpy-get-overlay-at 206 'docstring))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'docstring))
       (should (= (overlay-start overlay) 206))
       (should (= (overlay-end overlay) 280)))

test/elpy-folding-fold-blocks-test.el

@@ -11,18 +11,15 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (apply 'nconc (overlay-lists)))
            overlay)
-      (should (= 2 (length overlays)))
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 25 'code))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'code))
       (should (= (overlay-start overlay) 25))
       (should (or (= (overlay-end overlay) 37)
                   (= (overlay-end overlay) 38))))
     (should (= (point) 14))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (apply 'nconc (overlay-lists)))
-           overlay)
-      (should (= 1 (length overlays))))
     ;; Position
     (should (= (point) 14))))
 
@@ -39,18 +36,15 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (apply 'nconc (overlay-lists)))
            overlay)
-      (should (= 2 (length overlays)))
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 25 'code))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'code))
       (should (= (overlay-start overlay) 25))
       (should (or (= (overlay-end overlay) 37)
                   (= (overlay-end overlay) 38))))
     (should (= (point) 14))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (apply 'nconc (overlay-lists)))
-           overlay)
-      (should (= 1 (length overlays))))
     ;; Position
     (should (= (point) 14))))
 
@@ -67,8 +61,6 @@
     (python-mode)
     (elpy-mode)
     (elpy-folding-toggle-at-point)
-    (let ((overlays (apply 'nconc (overlay-lists))))
-      (should (= 1 (length overlays))))
     ;; Position
     (should (= (point) 49))))
 
@@ -89,18 +81,15 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (apply 'nconc (overlay-lists)))
            overlay)
-      (should (= 3 (length overlays)))
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 54 'code))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'code))
       (should (= (overlay-start overlay) 54))
       (should (or (= (overlay-end overlay) 100)
                   (= (overlay-end overlay) 101))))
     (should (= (point) 43))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (apply 'nconc (overlay-lists)))
-           overlay)
-      (should (= 2 (length overlays))))
     ;; Position
     (should (= (point) 43))))
 
@@ -123,18 +112,15 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (apply 'nconc (overlay-lists)))
            overlay)
-      (should (= 4 (length overlays)))
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 104 'code))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'code))
       (should (= (overlay-start overlay) 104))
       (should (or (= (overlay-end overlay) 150)
                   (= (overlay-end overlay) 151))))
     (should (= (point) 93))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (apply 'nconc (overlay-lists)))
-           overlay)
-      (should (= 3 (length overlays))))
     ;; Position
     (should (= (point) 93))))
 
@@ -157,17 +143,14 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (apply 'nconc (overlay-lists)))
            overlay)
-      (should (= 4 (length overlays)))
-      (setq overlay (nth 0 overlays))
+      (setq overlay (elpy-get-overlay-at 29 'code))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'code))
       (should (= (overlay-start overlay) 29))
       (should (or (= (overlay-end overlay) 150)
                   (= (overlay-end overlay) 151))))
     (should (= (point) 16))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (apply 'nconc (overlay-lists)))
-           overlay)
-      (should (= 3 (length overlays))))
     ;; Position
     (should (= (point) 16))))

test/elpy-folding-fold-comments-test.el

@@ -20,17 +20,14 @@
     (elpy-folding-toggle-at-point)
     (let* ((overlays (overlays-in (point-min) (point-max)))
            overlay)
-      (should (= 4 (length overlays)))
-      (setq overlay (nth 1 overlays))
+      (setq overlay (elpy-get-overlay-at 111 'comment))
+      (should overlay)
       (should (eq (overlay-get overlay 'hs) 'comment))
       (should (= (overlay-start overlay) 111))
       (should (= (overlay-end overlay) 156)))
     (should (= (point) 92))
     ;; Unfold
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (overlays-in (point-min) (point-max)))
-           overlay)
-      (should (= 3 (length overlays))))
     ;; Position
     (should (= (point) 92))))
 
@@ -52,7 +49,4 @@
     (python-mode)
     (elpy-mode)
     (elpy-folding-toggle-at-point)
-    (let* ((overlays (overlays-in (point-min) (point-max)))
-           overlay)
-      (should (= 3 (length overlays))))
     (should (= (point) 112))))