Catalog: ensure the catalog is sorted by category

Using the categories CategoryMask (and OrderedDict), sort the Catalog
such that it matches the original order in the catalog Doc.

Author: hojberg

elm.json

@@ -20,6 +20,7 @@
             "elm-community/list-extra": "8.2.4",
             "elm-community/maybe-extra": "5.2.0",
             "elm-community/string-extra": "4.0.1",
+            "j-maas/elm-ordered-containers": "1.0.0",
             "krisajenkins/remotedata": "6.0.1",
             "mgold/elm-nonempty-list": "4.1.0",
             "stoeffel/set-extra": "1.2.3",

src/UnisonShare/Catalog.elm

@@ -1,34 +1,38 @@
 module UnisonShare.Catalog exposing (..)
 
-import Dict exposing (Dict)
+import Dict
 import FullyQualifiedName as FQN
 import Json.Decode as Decode
+import OrderedDict exposing (OrderedDict)
 import Project exposing (ProjectListing)
 import UnisonShare.Catalog.CatalogMask as CatalogMask exposing (CatalogMask)
 
 
 type Catalog
-    = Catalog (Dict String (List ProjectListing))
+    = Catalog (OrderedDict String (List ProjectListing))
 
 
 
 -- CREATE
 
 
+{-| Create the empty Catalog
+-}
 empty : Catalog
 empty =
-    Catalog Dict.empty
+    Catalog OrderedDict.empty
 
 
+{-| Create a Catalog using a mask and listings. The mask is used to get the
+categories and to ensure the category sort order is preserved
+-}
 catalog : CatalogMask -> List ProjectListing -> Catalog
 catalog mask projectListings_ =
     let
-        catalog_ project ((Catalog dict) as acc) =
+        group project acc =
             let
                 projectName =
-                    project
-                        |> Project.slug
-                        |> FQN.toString
+                    project |> Project.slug |> FQN.toString
 
                 categoryName =
                     CatalogMask.categoryOf projectName mask
@@ -43,12 +47,39 @@ catalog mask projectListings_ =
             in
             case categoryName of
                 Just c ->
-                    Catalog (Dict.update c set dict)
+                    Dict.update c set acc
+
+                Nothing ->
+                    acc
+
+        grouped =
+            List.foldl group Dict.empty projectListings_
+
+        sortedCategories category acc =
+            case Dict.get category grouped of
+                Just ps ->
+                    insert category ps acc
 
                 Nothing ->
                     acc
     in
-    List.foldl catalog_ empty projectListings_
+    List.foldl sortedCategories empty (CatalogMask.categories mask)
+
+
+{-| Insert a category and projects within into a Catalog
+-}
+insert : String -> List ProjectListing -> Catalog -> Catalog
+insert categoryName projectListings_ (Catalog dict) =
+    Catalog (OrderedDict.insert categoryName projectListings_ dict)
+
+
+{-| Create a Catalog given a list of projects grouped by category
+-}
+fromList : List ( String, List ProjectListing ) -> Catalog
+fromList items =
+    items
+        |> OrderedDict.fromList
+        |> Catalog
 
 
 
@@ -57,22 +88,28 @@ catalog mask projectListings_ =
 
 isEmpty : Catalog -> Bool
 isEmpty (Catalog dict) =
-    Dict.isEmpty dict
+    OrderedDict.isEmpty dict
 
 
+{-| Extract all categories from a Catalog
+-}
 categories : Catalog -> List String
 categories (Catalog dict) =
-    Dict.keys dict
+    OrderedDict.keys dict
 
 
+{-| Extract all project listings from a Catalog
+-}
 projectListings : Catalog -> List ProjectListing
 projectListings (Catalog dict) =
-    List.concat (Dict.values dict)
+    List.concat (OrderedDict.values dict)
 
 
+{-| Convert a Catalog to a list of project listings grouped by category
+-}
 toList : Catalog -> List ( String, List ProjectListing )
 toList (Catalog dict) =
-    Dict.toList dict
+    OrderedDict.toList dict
 
 
 

src/UnisonShare/Catalog/CatalogMask.elm

@@ -12,9 +12,9 @@ module UnisonShare.Catalog.CatalogMask exposing
     )
 
 import Definition.Doc as Doc exposing (Doc)
-import Dict exposing (Dict)
 import Json.Decode as Decode exposing (field, index)
 import List.Extra as ListE
+import OrderedDict exposing (OrderedDict)
 
 
 {-| CatalogMask is used to create the Catalog and map ProjectListings to their
@@ -24,7 +24,7 @@ Indexed by project to category "unison.http" -> "Web & Networking"
 
 -}
 type CatalogMask
-    = CatalogMask (Dict String String)
+    = CatalogMask (OrderedDict String String)
 
 
 
@@ -33,12 +33,12 @@ type CatalogMask
 
 empty : CatalogMask
 empty =
-    CatalogMask Dict.empty
+    CatalogMask OrderedDict.empty
 
 
 fromList : List ( String, String ) -> CatalogMask
 fromList categories_ =
-    CatalogMask (Dict.fromList categories_)
+    CatalogMask (OrderedDict.fromList categories_)
 
 
 {-| For right now, a CatalogMask is fetched as a Doc from the server and as
@@ -78,27 +78,27 @@ fromDoc doc =
 
 isEmpty : CatalogMask -> Bool
 isEmpty (CatalogMask mask) =
-    Dict.isEmpty mask
+    OrderedDict.isEmpty mask
 
 
 categoryOf : String -> CatalogMask -> Maybe String
 categoryOf projectName (CatalogMask mask) =
-    Dict.get projectName mask
+    OrderedDict.get projectName mask
 
 
 categories : CatalogMask -> List String
 categories (CatalogMask mask) =
-    Dict.values mask |> ListE.unique
+    OrderedDict.values mask |> ListE.unique
 
 
 projectNames : CatalogMask -> List String
 projectNames (CatalogMask mask) =
-    Dict.keys mask
+    OrderedDict.keys mask
 
 
 toList : CatalogMask -> List ( String, String )
 toList (CatalogMask mask) =
-    Dict.toList mask
+    OrderedDict.toList mask
 
 
 

tests/UnisonShare/Catalog/CatalogMaskTests.elm

@@ -11,8 +11,8 @@ fromDoc =
     describe "CatalogMask.fromDoc"
         [ test "Creates a CatalogMask from a Doc" <|
             \_ ->
-                Expect.equal (List.sort rawMask)
-                    (CatalogMask.fromDoc doc |> CatalogMask.toList |> List.sort)
+                Expect.equal rawMask
+                    (CatalogMask.fromDoc doc |> CatalogMask.toList)
         ]
 
 
@@ -25,8 +25,8 @@ fromList =
                     catalogMask =
                         CatalogMask.fromList rawMask
                 in
-                Expect.equal (List.sort rawMask)
-                    (CatalogMask.toList catalogMask |> List.sort)
+                Expect.equal rawMask
+                    (CatalogMask.toList catalogMask)
         ]
 
 
@@ -53,14 +53,12 @@ categories =
                         CatalogMask.fromList rawMask
                 in
                 Expect.equal
-                    (List.sort
-                        [ "Featured"
-                        , "Web & Networking"
-                        , "Parsers & Text Manipulation"
-                        , "Datatypes"
-                        ]
-                    )
-                    (CatalogMask.categories catalogMask |> List.sort)
+                    [ "Featured"
+                    , "Web & Networking"
+                    , "Parsers & Text Manipulation"
+                    , "Datatypes"
+                    ]
+                    (CatalogMask.categories catalogMask)
         ]
 
 
@@ -74,15 +72,13 @@ projectNames =
                         CatalogMask.fromList rawMask
                 in
                 Expect.equal
-                    (List.sort
-                        [ "unison.base"
-                        , "unison.distributed"
-                        , "unison.http"
-                        , "hojberg.textExtra"
-                        , "hojberg.nanoid"
-                        ]
-                    )
-                    (CatalogMask.projectNames catalogMask |> List.sort)
+                    [ "unison.base"
+                    , "unison.distributed"
+                    , "unison.http"
+                    , "hojberg.textExtra"
+                    , "hojberg.nanoid"
+                    ]
+                    (CatalogMask.projectNames catalogMask)
         ]