Merge pull request #68 from haskellari/issue-67

Add a test for issue #67

Author: phadej

.github/workflows/haskell-ci.yml

@@ -8,9 +8,9 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.15.20220808
+# version: 0.15.20221225
 #
-# REGENDATA ("0.15.20220808",["github","cabal.project"])
+# REGENDATA ("0.15.20221225",["github","cabal.project"])
 #
 name: Haskell-CI
 on:
@@ -300,3 +300,11 @@ jobs:
         run: |
           rm -f cabal.project.local
           $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
+      - name: prepare for constraint sets
+        run: |
+          rm -f cabal.project.local
+      - name: constraint set random-hashable
+        run: |
+          if [ $((! GHCJSARITH && HCNUMVER >= 90400)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --enable-tests --disable-benchmarks --constraint='hashable >=1.3.2.0' --constraint='hashable +random-initial-seed' --dependencies-only -j2 all ; fi
+          if [ $((! GHCJSARITH && HCNUMVER >= 90400)) -ne 0 ] ; then $CABAL v2-build $ARG_COMPILER --enable-tests --disable-benchmarks --constraint='hashable >=1.3.2.0' --constraint='hashable +random-initial-seed' all ; fi
+          if [ $((! GHCJSARITH && HCNUMVER >= 90400)) -ne 0 ] ; then $CABAL v2-test $ARG_COMPILER --enable-tests --disable-benchmarks --constraint='hashable >=1.3.2.0' --constraint='hashable +random-initial-seed' all ; fi

ChangeLog.md

@@ -1,3 +1,15 @@
+## 0.3
+
+- Breaking change:
+  Make HashSet and HashMap ToExpr instances sort the resulting
+  lists of expressions.
+  This makes the results deterministic.
+  ... but your golden files will need adjustment.
+  https://github.com/haskellari/tree-diff/issues/67
+
+- Add `Ord Expr` and `Ord OMap` instances
+- Depend on `data-array-byte` to provide more `ByteArray` instances
+
 ## 0.2.2
 
 - Add instances for base and primitive's `ByteArray`s.

cabal.haskell-ci

@@ -7,3 +7,9 @@ docspec:  >=8
 -- constraint-set bytestring-0.11
 --   ghc:         >=7.8
 --   constraints: bytestring ^>=0.11
+
+constraint-set random-hashable
+  ghc: ==9.4.*
+  constraints: hashable >=1.3.2.0, hashable +random-initial-seed
+  tests: True
+  run-tests: True

fixtures/HashSet.expr

@@ -0,0 +1,14 @@
+HS.fromList
+  [
+    "ax",
+    "ay",
+    "az",
+    "bx",
+    "by",
+    "bz",
+    "cx",
+    "cy",
+    "cz",
+    "dx",
+    "dy",
+    "dz"]

src/Data/TreeDiff/Class.hs

@@ -21,6 +21,7 @@ module Data.TreeDiff.Class (
     ) where
 
 import Data.Foldable    (toList)
+import Data.List        (sort)
 import Data.List.Compat (uncons)
 import Data.Proxy       (Proxy (..))
 import GHC.Generics
@@ -108,7 +109,7 @@ import Data.These (These (..))
 -- primitive
 import qualified Data.Primitive as Prim
 
-#if MIN_VERSION_base(4,17,0)
+#if MIN_VERSION_base(4,9,0)
 import Data.Array.Byte (ByteArray (..))
 #endif
 
@@ -550,9 +551,9 @@ instance ToExpr a => ToExpr (Hashed a) where
 -------------------------------------------------------------------------------
 
 instance (ToExpr k, ToExpr v) => ToExpr (HM.HashMap k v) where
-    toExpr x = App "HM.fromList" [ toExpr $ HM.toList x ]
+    toExpr x = App "HM.fromList" [ Lst $ sort $ map toExpr $ HM.toList x ]
 instance (ToExpr k) => ToExpr (HS.HashSet k) where
-    toExpr x = App "HS.fromList" [ toExpr $ HS.toList x ]
+    toExpr x = App "HS.fromList" [ Lst $ sort $ map toExpr $ HS.toList x ]
 
 -------------------------------------------------------------------------------
 -- aeson
@@ -601,7 +602,7 @@ instance (ToExpr a, ToExpr b) => ToExpr (These a b) where
 instance ToExpr Prim.ByteArray where
     toExpr ba = App "Prim.byteArrayFromList" [toExpr (Prim.foldrByteArray (:) [] ba :: [Word8])]
 
-#if MIN_VERSION_base(4,17,0)
+#if MIN_VERSION_base(4,9,0)
 -- | @since 0.2.2
 instance ToExpr ByteArray where
     toExpr (ByteArray ba) = App "byteArrayFromList" [toExpr (Prim.foldrByteArray (:) [] (Prim.ByteArray ba) :: [Word8])]

src/Data/TreeDiff/Expr.hs

@@ -35,7 +35,7 @@ data Expr
     = App ConstructorName [Expr]                 -- ^ application
     | Rec ConstructorName (OMap FieldName Expr)  -- ^ record constructor
     | Lst [Expr]                                 -- ^ list constructor
-  deriving (Eq, Show)
+  deriving (Eq, Ord, Show)
 
 instance NFData Expr where
     rnf (App n es) = rnf n `seq` rnf es

src/Data/TreeDiff/OMap.hs

@@ -61,12 +61,10 @@ instance (Show k, Show v) => Show (OMap k v) where
 -- False
 --
 instance (Eq k, Eq v) => Eq (OMap k v) where
-    xs == ys = go (toAscList xs) (toAscList ys) where
-        go [] [] = True
-        go _  [] = False
-        go [] _  = False
-        go ((k1, v1) : kvs1) ((k2, v2) : kvs2) =
-            k1 == k2 && v1 == v2 && go kvs1 kvs2
+    xs == ys = toAscList xs == toAscList ys
+
+instance (Ord k, Ord v) => Ord (OMap k v) where
+    compare xs ys = compare (toAscList xs) (toAscList ys)
 
 -------------------------------------------------------------------------------
 -- deepseq

tests/Tests.hs

@@ -11,6 +11,7 @@ import Test.Tasty                 (TestTree, defaultMain, testGroup)
 import Test.Tasty.Golden.Advanced (goldenTest)
 import Test.Tasty.QuickCheck      (testProperty)
 
+import qualified Data.HashSet                 as HS
 import qualified Text.Parsec                  as P
 import qualified Text.PrettyPrint.ANSI.Leijen as WL
 import qualified Text.Trifecta                as T (eof, parseString)
@@ -163,5 +164,9 @@ goldenTests = testGroup "Golden"
         return $ MyInt3 42
     , ediffGolden goldenTest "Positional" "fixtures/Positional.expr" $
         return $ Positional 12 True 'z'
+
+    -- issue #67
+    , ediffGolden goldenTest "HashSet" "fixtures/HashSet.expr" $
+        return $ HS.fromList [ [x,y] | x <- "abcd", y <- "xyz" ]
     ]
 

tree-diff.cabal

@@ -1,6 +1,6 @@
 cabal-version:      2.2
 name:               tree-diff
-version:            0.2.2
+version:            0.3
 synopsis:           Diffing of (expression) trees.
 category:           Data, Testing
 description:
@@ -85,22 +85,22 @@ library
 
   -- GHC boot libraries
   build-depends:
-    , base        >=4.5      && <4.18
-    , bytestring  ^>=0.9.2.1 || ^>=0.10.0.2 || ^>=0.11.0.0
-    , containers  ^>=0.4.2.1 || ^>=0.5.0.0 || ^>=0.6.0.1
-    , deepseq     ^>=1.3.0.0 || ^>=1.4.0.0
+    , base        >=4.5       && <4.18
+    , bytestring  ^>=0.9.2.1  || ^>=0.10.0.2 || ^>=0.11.0.0
+    , containers  ^>=0.4.2.1  || ^>=0.5.0.0  || ^>=0.6.0.1
+    , deepseq     ^>=1.3.0.0  || ^>=1.4.0.0
     , parsec      ^>=3.1.13.0
     , pretty      ^>=1.1.1.0
-    , text        ^>=1.2.3.0 || ^>=2.0
-    , time        >=1.4      && <1.5 || >=1.5.0.1 && <1.6 || >=1.6.0.1 && <1.7 || >=1.8.0.2 && <1.9 || >=1.9.3 && <1.13
+    , text        ^>=1.2.3.0  || ^>=2.0
+    , time        >=1.4       && <1.5        || >=1.5.0.1   && <1.6 || >=1.6.0.1 && <1.7 || >=1.8.0.2 && <1.9 || >=1.9.3 && <1.13
 
   build-depends:
-    , aeson                 ^>=1.4.6.0 || ^>=1.5.6.0 || ^>=2.0.0.0 || ^>=2.1.0.0
-    , ansi-terminal         >=0.10       && <0.12
+    , aeson                 ^>=1.4.6.0    || ^>=1.5.6.0  || ^>=2.0.0.0 || ^>=2.1.0.0
+    , ansi-terminal         >=0.10        && <0.12
     , ansi-wl-pprint        ^>=0.6.8.2
-    , base-compat           >=0.10.5     && <0.11 || >=0.11.0 && <0.13
+    , base-compat           >=0.10.5      && <0.11       || >=0.11.0   && <0.13
     , bytestring-builder    ^>=0.10.8.2.0
-    , hashable              ^>=1.2.7.0 || ^>=1.3.0.0 || ^>=1.4.0.1
+    , hashable              ^>=1.2.7.0    || ^>=1.3.0.0  || ^>=1.4.0.1
     , parsers               ^>=0.12.10
     , primitive             ^>=0.7.1.0
     , QuickCheck            ^>=2.14.2
@@ -111,7 +111,7 @@ library
     , these                 ^>=1.1.1.1
     , unordered-containers  ^>=0.2.8.0
     , uuid-types            ^>=1.0.3
-    , vector                ^>=0.12.0.0 || ^>=0.13.0.0
+    , vector                ^>=0.12.0.0   || ^>=0.13.0.0
 
   if impl(ghc <7.5)
     build-depends: ghc-prim
@@ -128,6 +128,9 @@ library
       , transformers  ^>=0.3.0.0 || ^>=0.4.2.0 || ^>=0.5.2.0
       , void          ^>=0.7.3
 
+  if impl(ghc >= 8) && !impl(ghc >=9.4)
+    build-depends: data-array-byte >=0.1.0.1 && <0.2
+
   other-extensions:
     CPP
     ConstraintKinds
@@ -160,16 +163,17 @@ test-suite tree-diff-test
     , QuickCheck
     , tagged
     , tree-diff
+    , unordered-containers
 
   if impl(ghc <7.5)
     build-depends: ghc-prim
 
   -- extra dependencies
   build-depends:
-    , tasty             ^>=1.2 || ^>=1.3.1 || ^>=1.4.2
+    , tasty             ^>=1.2     || ^>=1.3.1 || ^>=1.4.2
     , tasty-golden      ^>=2.3.1.1
     , tasty-quickcheck  ^>=0.10.1
-    , trifecta          >=2       && <2.2
+    , trifecta          >=2        && <2.2
 
 benchmark tree-diff-bench
   default-language: Haskell2010