Align the mailbox counts in the summary report to the same column.

[mailbox-count.git] / src / Report.hs

diff --git a/src/Report.hs b/src/Report.hs
index e248879225323cfd32f0ba5e213192db659b42af..db9c4ad584f0a67b379611685cfffc3d84138693 100644 (file)
--- a/src/Report.hs
+++ b/src/Report.hs
@@ -5,7 +5,7 @@ module Report (
   report_tests )
 where
 
-import Data.List ( foldl' )
+import Data.List ( foldl', maximumBy )
 import qualified Data.Map as Map ( Map, alter, empty, foldl, mapWithKey )
 import Data.Maybe ( catMaybes )
 import Data.String.Utils ( join )
@@ -26,19 +26,9 @@ type Count = Int
 
 
 -- | A wrapper around a (domain, count) pair to keep things type-safe.
-data DomainCount = DomainCount Domain Count
-
-instance Show DomainCount where
-  -- | Display a DomainCount in the form \"domain: count\".
-  --
-  --   Examples:
-  --
-  --   >>> let dc = DomainCount "example.com" 100
-  --   >>> show dc
-  --   "example.com: 100"
-  --
-  show (DomainCount domain count) = domain ++ ": " ++ (show count)
-
+data DomainCount =
+  DomainCount Domain Count
+  deriving (Show)
 
 -- | A wrapper around a (domain, user) pair to keep things type-safe.
 data DomainUser =
@@ -61,7 +51,7 @@ type DomainUserMap = Map.Map Domain [Username]
 --   >>> import Database.HDBC ( iToSql, toSql )
 --
 --   >>> list_to_domain_count [toSql "example.com", iToSql 100]
---   Just example.com: 100
+--   Just (DomainCount "example.com" 100)
 --
 --   >>> list_to_domain_count [toSql "example.com"]
 --   Nothing
@@ -99,6 +89,24 @@ list_to_domain_user _ =
   Nothing
 
 
+-- | Pad each count on the left with spaces so that they start on the
+--   same column. The 'Int' argument is the length of the longest
+--   domain name with which this one will be aligned, so when you take
+--   into consideration the colon and subsequent space, the count will
+--   be placed in column @longest_length + 3@.
+--
+--   Examples:
+--
+--   >>> let dc = DomainCount "example.com" 20
+--   >>> format_domain_count 20 dc
+--   "example.com:          20"
+--
+format_domain_count :: Int -> DomainCount -> String
+format_domain_count longest_length (DomainCount d c) =
+  d ++ ": " ++ (replicate num_spaces ' ') ++ (show c)
+  where
+    num_spaces = longest_length - length d
+
 summary_header :: String
 summary_header = "Summary (number of mailboxes per domain)\n" ++
                  "----------------------------------------"
@@ -108,9 +116,26 @@ report_summary conn = do
   list_rows <- quickQuery conn query []
   let maybe_domain_counts = map list_to_domain_count list_rows
   let domain_counts = catMaybes maybe_domain_counts
-  let report_lines = summary_header : (map show domain_counts)
+  let n = longest_dc_length domain_counts
+  let formatted_domain_counts = map (format_domain_count n) domain_counts
+  let report_lines = summary_header : formatted_domain_counts
   return $ join "\n" report_lines
   where
+    -- | Compare two 'DomainCount's by the length of their domain. The
+    --   one with the longest domain is \"bigger\".
+    compare_dcs_by_length :: DomainCount -> DomainCount -> Ordering
+    compare_dcs_by_length (DomainCount x _) (DomainCount y _) =
+      compare (length x) (length y)
+
+    -- | Find the length of the 'DomainCount' in the list that has the
+    --   longest domain. We need to know this in order to pad the
+    --   counts on the left by the correct number of spaces.
+    longest_dc_length :: [DomainCount] -> Int
+    longest_dc_length dcs =
+      let (DomainCount d _) = longest in length d
+      where
+        longest = maximumBy compare_dcs_by_length dcs
+
     query = "SELECT domain,COUNT(username) " ++
             "FROM mailbox " ++
             "GROUP BY domain "++
@@ -175,21 +200,16 @@ report_detail conn = do
     format_domain domain users =
       (join "\n" (domain_header : indented_users)) ++ "\n"
       where
-        domain_header = "\n" ++ domain ++ ":"
+        count = length users
+        domain_header = "\n" ++ domain ++ " (" ++ (show count) ++ ")" ++ ":"
         indented_users = map ("  " ++) users
 
 
-report_both :: IConnection a => a -> IO String
-report_both conn = do
-  rs <- report_summary conn
-  rd <- report_detail conn
-  return (rs ++ rd)
-
-report :: IConnection a => a -> Bool -> Bool -> IO String
-report conn do_both do_detail =
-  if do_both
-  then (report_both conn)
-  else if do_detail then (report_detail conn) else (report_summary conn)
+report :: IConnection a => a -> Bool -> IO String
+report conn do_detail =
+  if do_detail
+  then report_detail conn
+  else report_summary conn
 
 
 
@@ -210,9 +230,10 @@ test_summary_report =
     desc = "Summary report looks like it should"
     expected = summary_header ++
                "\n" ++
-               "example.com: 3\n" ++
-               "example.net: 2\n" ++
-               "example.org: 1"
+               "example.com:     3\n" ++
+               "example.invalid: 1\n" ++
+               "example.net:     2\n" ++
+               "example.org:     1"
 
 
 test_detail_report :: TestTree
@@ -225,14 +246,17 @@ test_detail_report =
     desc = "Detail report looks like it should"
     expected = detail_header ++
                "\n" ++
-               "example.com:\n" ++
+               "example.com (3):\n" ++
                "  user1\n" ++
                "  user3\n" ++
                "  user5\n" ++
                "\n" ++
-               "example.net:\n" ++
+               "example.invalid (1):\n" ++
+               "  user7\n" ++
+               "\n" ++
+               "example.net (2):\n" ++
                "  user2\n" ++
                "  user4\n" ++
                "\n" ++
-               "example.org:\n" ++
+               "example.org (1):\n" ++
                "  user6\n"