From 151facf3b99c77ab9119ad89612114629a01af20 Mon Sep 17 00:00:00 2001
From: Karl Ostmo <kostmo@gmail.com>
Date: Wed, 26 Oct 2022 22:05:14 -0700
Subject: [PATCH] Use Set instead of a list for entity properties, for
 sortability

---
 src/Swarm/Game/Entity.hs | 9 +++++----
 src/Swarm/TUI/View.hs    | 3 ++-
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/src/Swarm/Game/Entity.hs b/src/Swarm/Game/Entity.hs
index 7a4cc7bb9..7b3fe83d9 100644
--- a/src/Swarm/Game/Entity.hs
+++ b/src/Swarm/Game/Entity.hs
@@ -97,6 +97,7 @@ import Data.Map (Map)
 import Data.Map qualified as M
 import Data.Maybe (fromMaybe, isJust, listToMaybe)
 import Data.Set (Set)
+import Data.Set qualified as Set (fromList)
 import Data.Set.Lens (setOf)
 import Data.Text (Text)
 import Data.Text qualified as T
@@ -219,7 +220,7 @@ data Entity = Entity
     -- grabbed.
     _entityYields :: Maybe Text
   , -- | Properties of the entity.
-    _entityProperties :: [EntityProperty]
+    _entityProperties :: Set EntityProperty
   , -- | Capabilities provided by this entity.
     _entityCapabilities :: [Capability]
   , -- | Inventory of other entities held by this entity.
@@ -274,7 +275,7 @@ mkEntity ::
   [Capability] ->
   Entity
 mkEntity disp nm descr props caps =
-  rehashEntity $ Entity 0 disp nm Nothing descr Nothing Nothing Nothing props caps empty
+  rehashEntity $ Entity 0 disp nm Nothing descr Nothing Nothing Nothing (Set.fromList props) caps empty
 
 ------------------------------------------------------------
 -- Entity map
@@ -330,7 +331,7 @@ instance FromJSON Entity where
               <*> v .:? "orientation"
               <*> v .:? "growth"
               <*> v .:? "yields"
-              <*> v .:? "properties" .!= []
+              <*> v .:? "properties" .!= mempty
               <*> v .:? "capabilities" .!= []
               <*> pure empty
           )
@@ -431,7 +432,7 @@ entityYields :: Lens' Entity (Maybe Text)
 entityYields = hashedLens _entityYields (\e x -> e {_entityYields = x})
 
 -- | The properties enjoyed by this entity.
-entityProperties :: Lens' Entity [EntityProperty]
+entityProperties :: Lens' Entity (Set EntityProperty)
 entityProperties = hashedLens _entityProperties (\e x -> e {_entityProperties = x})
 
 -- | Test whether an entity has a certain property.
diff --git a/src/Swarm/TUI/View.hs b/src/Swarm/TUI/View.hs
index 344f06c68..a3cad8a77 100644
--- a/src/Swarm/TUI/View.hs
+++ b/src/Swarm/TUI/View.hs
@@ -63,6 +63,7 @@ import Data.Map qualified as M
 import Data.Maybe (catMaybes, fromMaybe, mapMaybe, maybeToList)
 import Data.Semigroup (sconcat)
 import Data.Sequence qualified as Seq
+import Data.Set qualified as Set (toList)
 import Data.String (fromString)
 import Data.Text (Text)
 import Data.Text qualified as T
@@ -956,7 +957,7 @@ explainFocusedItem s = case focusedItem s of
 explainEntry :: AppState -> Entity -> Widget Name
 explainEntry s e =
   vBox
-    [ displayProperties (e ^. entityProperties)
+    [ displayProperties $ Set.toList (e ^. entityProperties)
     , displayParagraphs (e ^. entityDescription)
     , explainRecipes s e
     ]