Merge pull request #45 from mbarbin/summary-box-in-buffer

Summary box in buffer

Author: mbarbin

CHANGES.md

@@ -1,8 +1,12 @@
 ## 0.0.2025XXXX (unreleased)
 
+### Added
+
+- Add 's' for summary tables in emacs crs-grep-mode (#45, @mbarbin).
+
 ### Changed
 
-- Add buffer line header in emacs crs-grep-mode by default (@mbarbin).
+- Add buffer line header in emacs crs-grep-mode by default (#44, @mbarbin).
 
 ### Fixed
 

editor-integration/emacs/crs-grep.el

@@ -47,7 +47,7 @@ Set this to an absolute path if the executable is not in your `PATH`."
 
 (defcustom crs-grep-default-filter "now"
   "Default filter for `crs-grep` when opening the CRs buffer.
-Should be one of: all, crs, xcrs, now, soon, someday, invalid."
+Should be one of: all, crs, xcrs, now, soon, someday, invalid, summary."
   :type
   '(choice
     (const "all")
@@ -56,7 +56,8 @@ Should be one of: all, crs, xcrs, now, soon, someday, invalid."
     (const "now")
     (const "soon")
     (const "someday")
-    (const "invalid"))
+    (const "invalid")
+    (const "summary"))
   :group 'crs-grep)
 
 (defcustom crs-grep-enable-next-error-follow nil
@@ -158,6 +159,8 @@ Always a string, e.g. \"now\", \"all\", etc.")
                              "emacs-grep"
                              "--path-display-mode=absolute"
                              (concat "--" crs-grep-current-filter))))
+          (when (fboundp 'ansi-color-apply-on-region)
+            (ansi-color-apply-on-region (point-min) (point-max)))
           (if (eq exit-code 0)
               (progn
                 (crs-grep-mode)
@@ -208,12 +211,13 @@ If `crs-grep-repo-root` is nil, shows an error message."
 (defun crs-grep-set-filter (filter-name)
   "Set the CRs type filter to FILTER-NAME (string) and refresh the CRs buffer.
 Prompts if called interactively."
-  (interactive (list
-                (completing-read
-                 "Filter (all, crs, xcrs, now, soon, someday, invalid): "
-                 '("all" "crs" "xcrs" "now" "soon" "someday" "invalid")
-                 nil
-                 t)))
+  (interactive
+   (list
+    (completing-read
+     "Filter (all, crs, xcrs, now, soon, someday, invalid, summary): "
+     '("all" "crs" "xcrs" "now" "soon" "someday" "invalid" "summary")
+     nil
+     t)))
   (setq crs-grep-current-filter filter-name)
   (crs-grep-refresh))
 
@@ -266,6 +270,13 @@ Further refreshing the buffer will continue to show invalid CRs only."
   (interactive)
   (crs-grep-set-filter "invalid"))
 
+(defun crs-grep-set-filter-summary ()
+  "Set the CRs type filter to \"summary\" and refresh the CRs buffer.
+This will show only the summary box.
+Further refreshing the buffer will continue to show the summary only."
+  (interactive)
+  (crs-grep-set-filter "summary"))
+
 ;;; Mode
 
 (defvar crs-grep-mode-map
@@ -280,6 +291,7 @@ Further refreshing the buffer will continue to show invalid CRs only."
     (define-key map "d" 'crs-grep-set-filter-someday)
     (define-key map "i" 'crs-grep-set-filter-invalid)
     (define-key map "a" 'crs-grep-set-filter-all)
+    (define-key map "s" 'crs-grep-set-filter-summary)
     map)
   "Keymap for `crs-grep-mode`.
 
@@ -293,6 +305,7 @@ Keys:
   o   Show only CRs to be worked on \"soon\" (set filter)
   d   Show only CRs to be worked on \"someday\" (set filter)
   i   Show only invalid CRs (set filter)
+  s   Show only the summary box (set filter)
   q   Quit")
 
 ;;;###autoload
@@ -310,6 +323,7 @@ Keys:
   o   Show only CRs to be worked on \"soon\" (set filter)
   d   Show only CRs to be worked on \"someday\" (set filter)
   i   Show only invalid CRs (set filter)
+  s   Show only the summary box (set filter)
   q   Quit"
  :keymap crs-grep-mode-map)
 

lib/crs_cli/src/cmd__tools__emacs_grep.ml

@@ -95,6 +95,10 @@ By default the file paths are displayed relative to the command's $(b,cwd).
          ~docv:"MODE"
          ~doc:"Specify how the paths are displayed."
          ~default:Relative_to_cwd
+     and+ summary =
+       Arg.flag
+         [ "summary" ]
+         ~doc:"Print CR counts in summary tables instead of listing each CR."
      and+ filters = Common_helpers.filters in
      let cwd = Unix.getcwd () |> Absolute_path.v in
      let { Enclosing_repo.vcs_kind = _; repo_root; vcs } =
@@ -111,10 +115,21 @@ By default the file paths are displayed relative to the command's $(b,cwd).
          List.filter all_crs ~f:(fun cr ->
            List.exists filters ~f:(fun filter -> Cr_comment.Filter.matches filter ~cr))
      in
-     output_list
-       crs
-       ~oc:Out_channel.stdout
-       ~repo_root
-       ~below:(Vcs.Path_in_repo.to_relative_path below)
-       ~path_display_mode)
+     if summary
+     then (
+       let by_type = Summary_table.By_type.make crs |> Summary_table.By_type.to_box in
+       let summary = Summary_table.make crs |> Summary_table.to_box in
+       let tables =
+         List.filter_opt [ by_type; summary ]
+         |> List.map ~f:Summary_table.Box.to_string
+         |> String.concat ~sep:"\n"
+       in
+       Out_channel.output_string Stdio.stdout tables)
+     else
+       output_list
+         crs
+         ~oc:Out_channel.stdout
+         ~repo_root
+         ~below:(Vcs.Path_in_repo.to_relative_path below)
+         ~path_display_mode)
 ;;

test/cram/emacs-grep.t

@@ -117,3 +117,39 @@ It is however also possible to display the path using some other styles.
 
 We do not exercise here the display of absolute path because it would make this
 test unstable, however this rendering option is available.
+
+The emacs grep command supports showing summary tables.
+
+  $ crs tools emacs-grep --summary
+  ┌─────────┬───────┐
+  │ CR Type │ Count │
+  ├─────────┼───────┤
+  │ CR      │     2 │
+  │ XCR     │     1 │
+  │ Soon    │     1 │
+  │ Someday │     1 │
+  └─────────┴───────┘
+  
+  ┌──────────┬───────┬─────┬──────┬──────┬─────────┬───────┐
+  │ Reporter │ For   │ CRs │ XCRs │ Soon │ Someday │ Total │
+  ├──────────┼───────┼─────┼──────┼──────┼─────────┼───────┤
+  │ user1    │       │     │    1 │    1 │       1 │     3 │
+  │ user1    │ user2 │   1 │      │      │         │     1 │
+  │ user1    │ user3 │   1 │      │      │         │     1 │
+  └──────────┴───────┴─────┴──────┴──────┴─────────┴───────┘
+
+This option may be combined with other filters when calling from the command
+line, however when used through emacs, the filter applied is always "all".
+
+  $ crs tools emacs-grep --summary --xcrs
+  ┌─────────┬───────┐
+  │ CR Type │ Count │
+  ├─────────┼───────┤
+  │ XCR     │     1 │
+  └─────────┴───────┘
+  
+  ┌──────────┬──────┬───────┐
+  │ Reporter │ XCRs │ Total │
+  ├──────────┼──────┼───────┤
+  │ user1    │    1 │     1 │
+  └──────────┴──────┴───────┘