Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --sort-by-stats flag to html reporter #433

Merged
merged 3 commits into from
Feb 12, 2024
Merged

Add --sort-by-stats flag to html reporter #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24765e2
Add --sort-by-stats flag to html reporter
mbarbin Feb 10, 2024
90f24a3
Fix for older stdlib versions (List.concat_map requires >= 4.10)
mbarbin Feb 10, 2024
feed667
Nits
aantron Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions src/report/html.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,36 @@ type index_element =
| File of index_file
| Directory of (string * index_element list * (int * int))

let output_html_index ~tree title theme filename files =
module Index_element :
sig
val sort_by_stats : index_element list -> index_element list
val flatten : index_element list -> index_element list
end =
struct
let percentage = function
| File (_, _, stat) -> percentage stat
| Directory (_, _, stat) -> percentage stat

let compare_by_stat e1 e2 =
compare (percentage e1, e1) (percentage e2, e2)

let rec sort_by_stats files =
files
|> List.map (function
| (File _) as f -> f
| Directory (name, files, stats) ->
Directory (name, sort_by_stats files, stats))
|> List.sort compare_by_stat

let rec flatten files =
files
|> List.map (function
| (File _) as f -> [f]
| Directory (_, files, _) -> flatten files)
|> List.concat
end

let output_html_index ~tree ~sort_by_stats title theme filename files =
Util.info "Writing index file...";

let add_stats (visited, total) (visited', total') =
Expand Down Expand Up @@ -138,6 +167,14 @@ let output_html_index ~tree title theme filename files =

let (files, stats) = collate files in

let files =
match sort_by_stats, tree with
| false, _ -> files
| true, false ->
files |> Index_element.flatten |> Index_element.sort_by_stats
| true, true -> files |> Index_element.sort_by_stats
in

let overall_coverage =
Printf.sprintf "%.02f%%" (floor ((percentage stats) *. 100.) /. 100.) in
write {|<!DOCTYPE html>
Expand Down Expand Up @@ -501,7 +538,8 @@ let output_string_to_separate_file content filename =

let output
~to_directory ~title ~tab_size ~theme ~coverage_files ~coverage_paths
~source_paths ~ignore_missing_files ~expect ~do_not_expect ~tree =
~source_paths ~ignore_missing_files ~expect ~do_not_expect ~tree
~sort_by_stats =

(* Read all the [.coverage] files and get per-source file visit counts. *)
let coverage =
Expand Down Expand Up @@ -535,6 +573,7 @@ let output
(* Write the coverage report landing page. *)
output_html_index
~tree
~sort_by_stats
title
theme
(Filename.concat to_directory "index.html")
Expand Down
1 change: 1 addition & 0 deletions src/report/html.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ val output :
expect:string list ->
do_not_expect:string list ->
tree:bool ->
sort_by_stats:bool ->
unit
12 changes: 10 additions & 2 deletions src/report/main.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,17 +179,25 @@ let html =
info ["tree"] ~doc:
("Generate collapsible directory tree with per-directory summaries."))
in
let sort_by_stats =
Arg.(value @@ flag @@
info ["sort-by-stats"] ~doc:
("Sort files in order of increasing coverage stats."))
in

let call_with_labels
to_directory title tab_size theme coverage_files coverage_paths
source_paths ignore_missing_files expect do_not_expect tree =
source_paths ignore_missing_files expect do_not_expect tree
sort_by_stats =
Html.output
~to_directory ~title ~tab_size ~theme ~coverage_files ~coverage_paths
~source_paths ~ignore_missing_files ~expect ~do_not_expect ~tree
~sort_by_stats
in
Term.(const set_verbose $ verbose $ const call_with_labels $ to_directory
$ title $ tab_size $ theme $ coverage_files 0 $ coverage_paths
$ source_paths $ ignore_missing_files $ expect $ do_not_expect $ tree),
$ source_paths $ ignore_missing_files $ expect $ do_not_expect $ tree
$ sort_by_stats),
term_info "html" ~doc:"Generate HTML report locally."
~man:[
`S "USAGE EXAMPLE";
Expand Down
Loading