Add information about commit message length

Author: gernd

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file. This change
 - File change statistics
 - Information about comitter/author emails and corresponding date information for commit
 - Log output using logback
+- Information about commit message length
 ### Changed
 - Rework commit lists, now displayed as table
 - Rework contributor list, now displayed as table

src/repo_analyzer/analyze.clj

@@ -1,6 +1,8 @@
 (ns repo-analyzer.analyze
   (:import (java.time LocalDateTime))
-  (:require [clojure.tools.logging :as log])
+  (:require [clojure.tools.logging :as log]
+            [clojure.string :as string]
+            )
   )
 
 (use 'clj-jgit.porcelain)
@@ -121,6 +123,15 @@
          )
     ))
 
+(defn compute-commit-message-length-ranking
+          "Computes a ranking regarding the length of the commit messages"
+          [logs]
+          (->> logs
+               (map #(hash-map :message (:msg %) :length (count (:msg %)) :author (get-in % [:author :email])))
+               (sort-by :length #(compare %2 %1))
+               )
+          )
+
 (defn compute-commit-statistics
   "Computes overall commit statistics"
   [logs]
@@ -131,19 +142,20 @@
           committed-by-different-dev (filter #(not (= (:name (:author %)) (:name (:committer %)))) logs)
           commit-statistics
           {
-           :commits                    logs
-           :count                      (count logs)
-           :self-committed             {
-                                        :commits    self-committed-commits
-                                        :count      (count self-committed-commits)
-                                        :percentage (* 100 (double (/ (count self-committed-commits) (count logs))))
-                                        }
-           :committed-by-different-dev {
-                                        :commits    committed-by-different-dev
-                                        :count      (count committed-by-different-dev)
-                                        :percentage (* 100 (double (/ (count committed-by-different-dev) (count logs))))
-                                        }
-           :time-distribution          (compute-commit-time-distribution logs)
+           :commits                       logs
+           :count                         (count logs)
+           :self-committed                {
+                                           :commits    self-committed-commits
+                                           :count      (count self-committed-commits)
+                                           :percentage (* 100 (double (/ (count self-committed-commits) (count logs))))
+                                           }
+           :committed-by-different-dev    {
+                                           :commits    committed-by-different-dev
+                                           :count      (count committed-by-different-dev)
+                                           :percentage (* 100 (double (/ (count committed-by-different-dev) (count logs))))
+                                           }
+           :time-distribution             (compute-commit-time-distribution logs)
+           :commit-message-length-ranking (compute-commit-message-length-ranking logs)
            }
           ]
       (log/info "Computation of commit statistics finished")

src/repo_analyzer/render.clj

@@ -57,7 +57,7 @@
     (spit filename site-html))
   )
 
-(deftrace create-commit-list-html
+(defn create-commit-list-html
   "Creates HTML for a list of commits"
   [list-of-commits]
   (html
@@ -163,7 +163,6 @@
         contributor-names (keys contributor-list)
         ]
     (html
-
       [:h1 "Contributors"]
       [:table {:class "table table-striped"}
        [:thead
@@ -241,6 +240,29 @@
       )
     ))
 
+(defn create-commit-length-statistics-html
+          [commit-length-statistics]
+          (let [
+                top5-longest-messages (take 5 commit-length-statistics)
+                top5-shortest-messages (take-last 5 commit-length-statistics)
+                ]
+            (html
+              [:h2 "Commit message length"]
+              [:h3 "Top 5 longest commit messages"]
+              [:ol
+               (map
+                 #(vector :li (string/join [(:author %) ": " (:message %) " (" (:length %) " characters)"])) top5-longest-messages
+                 )
+               ]
+              [:h3 "Top 5 shortest commit messages"]
+              [:ol
+               (map
+                 #(vector :li (string/join [(:author %) ": " (:message %) " (" (:length %) " characters)"])) top5-shortest-messages
+                 )
+               ]
+              )
+            )
+          )
 
 (defn create-commit-statistics
   "Creates commit statistics HTML and subpages. Returns the created HTML"
@@ -259,6 +281,7 @@
         line-chart-data-authored (string/join "," (map #(:authored (second %)) (get-in analysis [:commit-statistics :time-distribution])))
         line-chart-data-committed (string/join "," (map #(:committed (second %)) (get-in analysis [:commit-statistics :time-distribution])))
         file-change-statistics-html (create-file-change-statistics base-path (:file-change-statistics analysis))
+        commit-length-statistics-html (create-commit-length-statistics-html (get-in analysis [:commit-statistics :commit-message-length-ranking]))
         ]
     (create-site all-commits-filename "All commits" commit-list-html)
     (create-site self-commits-filename "Self committed commits" self-commit-list-html)
@@ -291,6 +314,7 @@
        (:count (:commit-statistics analysis)) "(" (get-in analysis [:commit-statistics :committed-by-different-dev :percentage]) "%)"
        [:a {:href "different-committer-list.html"} " See list of all commits where author and committer are different"]
        ]
+      commit-length-statistics-html
       file-change-statistics-html
       )
     ))