on develop help sign in
19 files changed+198−1193
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+1−1 .travis.yml−171 ChangeLog.md+14−10 cabal.haskell-ci−14 patch.cabal+20−7 src/Control/Category/DecidablyEmpty.hs−9 src/Data/Functor/Misc.hs+5−28 src/Data/Patch.hs+8−27 src/Data/Patch/Class.hs+5−131 src/Data/Patch/DMap.hs+1−3 src/Data/Patch/DMapWithMove.hs+1−4 src/Data/Patch/DMapWithPatchingMove.hs−644 src/Data/Patch/DMapWithPatchingMove/By.hs−89 src/Data/Patch/IntMap.hs+1−3 src/Data/Patch/Map.hs+1−3 src/Data/Patch/MapWithMove.hs+8−11 src/Data/Patch/MapWithPatchingMove.hs+36−38 src/Data/Semigroup/Additive.hs+54 test/tests.hs+43
.github/workflows/haskell.yml+1−1
@@ -42,6 +42,6 @@ jobs:
4242 - name: Build
4343 run: cabal build --enable-tests --enable-benchmarks all
4444 - name: Run tests
45− run: cabal test all
45+ run: cabal test --enable-tests all
4646 - name: Build Docs
4747 run: cabal haddock
.travis.ymldeleted−171
@@ -1,171 +0,0 @@
1−# This Travis job script has been generated by a script via
2−#
3−# haskell-ci '--config=cabal.haskell-ci' 'cabal.project'
4−#
5−# For more information, see https://github.com/haskell-CI/haskell-ci
6−#
7−# version: 0.3.20190814
8−#
9−language: c
10−dist: xenial
11−sudo: required
12−git:
13− # whether to recursively clone submodules
14− submodules: false
15−cache:
16− directories:
17− - $HOME/.cabal/packages
18− - $HOME/.cabal/store
19−before_cache:
20− - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
21− # remove files that are regenerated by 'cabal update'
22− - rm -fv $CABALHOME/packages/hackage.haskell.org/00-index.*
23− - rm -fv $CABALHOME/packages/hackage.haskell.org/*.json
24− - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
25− - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
26− - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
27− - rm -rfv $CABALHOME/packages/head.hackage
28−matrix:
29− include:
30− - compiler: ghcjs-8.4
31− addons: {"apt":{"sources":["hvr-ghc"],"packages":["cabal-install-3.0"]}}
32− - compiler: ghc-8.8.1
33− addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.8.1","cabal-install-3.0"]}}
34− - compiler: ghc-8.6.5
35− addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.6.5","cabal-install-2.4"]}}
36− - compiler: ghc-8.4.4
37− addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.4.4","cabal-install-2.4"]}}
38− - compiler: ghc-8.2.2
39− addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.2.2","cabal-install-2.4"]}}
40− - compiler: ghc-8.0.2
41− addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.0.2","cabal-install-2.4"]}}
42−before_install:
43− - |
44− if [ "$TRAVIS_OS_NAME" = "linux" ]; then
45− sudo add-apt-repository -y ppa:hvr/ghcjs;
46− curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | sudo apt-key add -
47− sudo apt-add-repository 'https://deb.nodesource.com/node_8.x xenial main'
48− sudo apt-get update;
49− sudo apt-get install $CC cabal-install-3.0 nodejs;
50− fi
51− - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
52− - WITHCOMPILER="-w $HC"
53− - |
54− if echo $CC | grep -q ghcjs; then
55− GHCJS=true
56− HC=${HC}js
57− WITHCOMPILER="--ghcjs ${WITHCOMPILER}js"
58− else
59− GHCJS=false;
60− fi
61− - if $GHCJS ; then sudo apt-get install -y ghc-8.4.4 ; fi
62− - if $GHCJS ; then PATH="/opt/ghc/8.4.4/bin:$PATH" ; fi
63− - HCPKG="$HC-pkg"
64− - unset CC
65− - CABAL=/opt/ghc/bin/cabal
66− - CABALHOME=$HOME/.cabal
67− - export PATH="$CABALHOME/bin:$PATH"
68− - TOP=$(pwd)
69− - "HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\\d+)\\.(\\d+)\\.(\\d+)(\\.(\\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')"
70− - echo $HCNUMVER
71− - CABAL="$CABAL -vnormal+nowrap+markoutput"
72− - set -o pipefail
73− - |
74− echo 'function blue(s) { printf "\033[0;34m" s "\033[0m " }' >> .colorful.awk
75− echo 'BEGIN { state = "output"; }' >> .colorful.awk
76− echo '/^-----BEGIN CABAL OUTPUT-----$/ { state = "cabal" }' >> .colorful.awk
77− echo '/^-----END CABAL OUTPUT-----$/ { state = "output" }' >> .colorful.awk
78− echo '!/^(-----BEGIN CABAL OUTPUT-----|-----END CABAL OUTPUT-----)/ {' >> .colorful.awk
79− echo ' if (state == "cabal") {' >> .colorful.awk
80− echo ' print blue($0)' >> .colorful.awk
81− echo ' } else {' >> .colorful.awk
82− echo ' print $0' >> .colorful.awk
83− echo ' }' >> .colorful.awk
84− echo '}' >> .colorful.awk
85− - cat .colorful.awk
86− - |
87− color_cabal_output () {
88− awk -f $TOP/.colorful.awk
89− }
90− - echo text | color_cabal_output
91−install:
92− - ${CABAL} --version
93− - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
94− - node --version
95− - echo $GHCJS
96− - TEST=--enable-tests
97− - BENCH=--enable-benchmarks
98− - BENCH=--disable-benchmarks
99− - HEADHACKAGE=false
100− - rm -f $CABALHOME/config
101− - |
102− echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config
103− echo "remote-build-reporting: anonymous" >> $CABALHOME/config
104− echo "write-ghc-environment-files: always" >> $CABALHOME/config
105− echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config
106− echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config
107− echo "world-file: $CABALHOME/world" >> $CABALHOME/config
108− echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config
109− echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config
110− echo "installdir: $CABALHOME/bin" >> $CABALHOME/config
111− echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config
112− echo "store-dir: $CABALHOME/store" >> $CABALHOME/config
113− echo "install-dirs user" >> $CABALHOME/config
114− echo " prefix: $CABALHOME" >> $CABALHOME/config
115− echo "repository hackage.haskell.org" >> $CABALHOME/config
116− echo " url: http://hackage.haskell.org/" >> $CABALHOME/config
117− - cat $CABALHOME/config
118− - rm -fv cabal.project cabal.project.local cabal.project.freeze
119− - travis_retry ${CABAL} v2-update -v
120− - if $GHCJS ; then (cd /tmp && ${CABAL} v2-install -w ghc-8.4.4 happy) ; fi
121− # Generate cabal.project
122− - rm -rf cabal.project cabal.project.local cabal.project.freeze
123− - touch cabal.project
124− - |
125− echo "packages: ." >> cabal.project
126− - |
127− - cat cabal.project || true
128− - cat cabal.project.local || true
129− - if [ -f "./configure.ac" ]; then (cd "." && autoreconf -i); fi
130− - ${CABAL} v2-freeze $WITHCOMPILER ${TEST} ${BENCH} | color_cabal_output
131− - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
132− - rm cabal.project.freeze
133−script:
134− - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
135− # Packaging...
136− - ${CABAL} v2-sdist all | color_cabal_output
137− # Unpacking...
138− - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
139− - cd ${DISTDIR} || false
140− - find . -maxdepth 1 -type f -name '*.tar.gz' -exec tar -xvf '{}' \;
141− - find . -maxdepth 1 -type f -name '*.tar.gz' -exec rm '{}' \;
142− - PKGDIR_patch="$(find . -maxdepth 1 -type d -regex '.*/patch-[0-9.]*')"
143− # Generate cabal.project
144− - rm -rf cabal.project cabal.project.local cabal.project.freeze
145− - touch cabal.project
146− - |
147− echo "packages: ${PKGDIR_patch}" >> cabal.project
148− - |
149− - cat cabal.project || true
150− - cat cabal.project.local || true
151− # Building...
152− # this builds all libraries and executables (without tests/benchmarks)
153− - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks all | color_cabal_output
154− # Building with tests and benchmarks...
155− # build & run tests, build benchmarks
156− - ${CABAL} v2-build $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output
157− # Testing...
158− - if ! $GHCJS ; then ${CABAL} v2-test $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output ; fi
159− # cabal check...
160− - (cd ${PKGDIR_patch} && ${CABAL} -vnormal check)
161− # haddock...
162− - if ! $GHCJS ; then ${CABAL} v2-haddock $WITHCOMPILER ${TEST} ${BENCH} all | color_cabal_output ; fi
163− # Constraint sets
164− - rm -rf cabal.project.local
165− # Constraint set old-these
166− - if $GHCJS || ! $GHCJS && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='these <1' all | color_cabal_output ; fi
167− # Constraint set old-witherable
168− - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='witherable <0.3.2' all | color_cabal_output
169−
170−# REGENDATA ["--config=cabal.haskell-ci","cabal.project"]
171−# EOF
ChangeLog.md+14−10
@@ -2,9 +2,13 @@
22
33## Unreleased
44
5−* `PatchMapWithMove` supports moves with a patch.
5+* New dep of `data-orphans` for old GHC to get instances honestly instead of
6+ via `monoidal-containers`.
67
7−* `PatchDMapWithMove` supports moves with a patch.
8+## 0.0.5.0 - 2021-12-17
9+
10+* `Additive` now lives in `Data.Semigroup.Additive`, but is still reexported
11+ from `Data.Patch` for compatability.
812
913* Rewrite `PatchMapWithMove` in terms of `PatchMapWithPatchingMove`.
1014 Care is taken to make this not a breaking change.
@@ -12,25 +16,25 @@
1216 There are complete constructor and field patterns too, and everything is
1317 exported under the newtype as real constructors and fields would be.
1418
15−## 0.0.4.0
19+## 0.0.4.0 - 2021-04-20
1620
1721* Enable PolyKinds
1822
19−## 0.0.3.2
23+## 0.0.3.2 - 2020-11-06
2024
2125* Update version bounds
2226
23−## 0.0.3.1
27+## 0.0.3.1 - 2020-02-05
2428
2529* Replace `fromJust` with something easier to debug.
2630
27−## 0.0.3.0
31+## 0.0.3.0 - 2020-02-05
2832
2933* Create `PatchMapWithPatchingMove` variant which supports moves with a patch.
3034
3135* Create `DecidablyEmpty` subclass of `Monoid`.
3236
33−## 0.0.2.0
37+## 0.0.2.0 - 2020-01-17
3438
3539* Consistently provide:
3640
@@ -42,16 +46,16 @@
4246
4347 for `PatchMap`, `PatchIntMap`, and `PatchMapWithMove`.
4448
45−## 0.0.1.0
49+## 0.0.1.0 - 2020-01-09
4650
4751* Support older GHCs with `split-these` flag.
4852
4953* Additional instances for the `Group` class for basic types.
5054
51−## 0.0.0.1
55+## 0.0.0.1 - 2020-01-08
5256
5357* Remove unneeded dependencies
5458
55−## 0.0.0.0
59+## 0.0.0.0 - 2020-01-08
5660
5761* Extract patching functionality from Reflex.
cabal.haskell-cideleted−14
@@ -1,14 +0,0 @@
1−distribution: xenial
2−benchmarks: False
3−unconstrained: False
4−installed: -all
5−
6−-- https://github.com/haskell/cabal/issues/6106
7−install-dependencies: False
8−
9−constraint-set old-these
10− ghc: <8.8
11− constraints: these <1
12−
13−constraint-set old-witherable
14− constraints: witherable <0.3.2
patch.cabal+20−7
@@ -1,5 +1,5 @@
11Name: patch
2−Version: 0.0.4.0
2+Version: 0.0.5.0
33Synopsis: Data structures for describing changes to other data structures.
44Description:
55 Data structures for describing changes to other data structures.
@@ -41,34 +41,47 @@ library
4141 , lens >= 4.7 && < 5
4242 , semigroupoids >= 4.0 && < 6
4343 , transformers >= 0.5.6.0 && < 0.6
44− , witherable >= 0.3 && < 0.4
44+ , witherable >= 0.3 && < 0.5
4545
46− exposed-modules: Control.Category.DecidablyEmpty
47− , Data.Functor.Misc
46+ if impl(ghc < 8.6) -- really, if base < 8.12
47+ build-depends: base-orphans >= 0.8 && < 0.9
48+
49+ exposed-modules: Data.Functor.Misc
4850 , Data.Monoid.DecidablyEmpty
4951 , Data.Patch
5052 , Data.Patch.Class
5153 , Data.Patch.DMap
5254 , Data.Patch.DMapWithMove
53− , Data.Patch.DMapWithPatchingMove
54− , Data.Patch.DMapWithPatchingMove.By
5555 , Data.Patch.IntMap
5656 , Data.Patch.Map
5757 , Data.Patch.MapWithMove
5858 , Data.Patch.MapWithPatchingMove
59+ , Data.Semigroup.Additive
5960
6061 ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs
6162 default-extensions: PolyKinds
6263
6364 if flag(split-these)
6465 build-depends: these >= 1 && <1.2
65− , these-lens >= 1 && <1.1
6666 , semialign >=1 && <1.2
6767 , monoidal-containers >= 0.6 && < 0.7
6868 else
6969 build-depends: these >= 0.4 && <0.9
7070 , monoidal-containers == 0.4.0.0
7171
72+test-suite tests
73+ default-language: Haskell2010
74+ type: exitcode-stdio-1.0
75+ main-is: tests.hs
76+ hs-source-dirs: test
77+ build-depends: base
78+ , patch
79+ , containers
80+ , hedgehog
81+ , HUnit
82+ if impl(ghcjs)
83+ buildable: False
84+
7285test-suite hlint
7386 default-language: Haskell2010
7487 type: exitcode-stdio-1.0
src/Control/Category/DecidablyEmpty.hsdeleted−9
@@ -1,9 +0,0 @@
1−{-# LANGUAGE TypeOperators #-}
2−-- TODO upstream somwhere else?
3−module Control.Category.DecidablyEmpty where
4−
5−import Control.Category
6−import Data.Type.Equality
7−
8−class Category c => DecidablyEmpty c where
9− isId :: c a b -> Maybe (a :~: b)
src/Data/Functor/Misc.hs+5−28
@@ -1,6 +1,6 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveTraversable #-}
3+{-# LANGUAGE DeriveFunctor #-}
44{-# LANGUAGE FlexibleContexts #-}
55{-# LANGUAGE FlexibleInstances #-}
66{-# LANGUAGE GADTs #-}
@@ -16,8 +16,6 @@
1616module Data.Functor.Misc
1717 ( -- * Const2
1818 Const2 (..)
19− , Proxy3 (..)
20− , First2 (..)
2119 , unConst2
2220 , dmapToMap
2321 , dmapToIntMap
@@ -38,7 +36,6 @@ module Data.Functor.Misc
3836 , ComposeMaybe (..)
3937 ) where
4038
41−import qualified Control.Category as Cat
4239import Control.Applicative ((<$>))
4340import Data.Dependent.Map (DMap)
4441import qualified Data.Dependent.Map as DMap
@@ -50,7 +47,6 @@ import Data.IntMap (IntMap)
5047import qualified Data.IntMap as IntMap
5148import Data.Map (Map)
5249import qualified Data.Map as Map
53−import qualified Data.Semigroupoid as Cat
5450import Data.Some (Some, mkSome)
5551import Data.These
5652import Data.Type.Equality ((:~:)(Refl))
@@ -66,15 +62,15 @@ data Const2 :: * -> x -> x -> * where
6662 Const2 :: k -> Const2 k v v
6763 deriving (Typeable)
6864
65+-- | Extract the value from a Const2
66+unConst2 :: Const2 k v v' -> k
67+unConst2 (Const2 k) = k
68+
6969deriving instance Eq k => Eq (Const2 k v v')
7070deriving instance Ord k => Ord (Const2 k v v')
7171deriving instance Show k => Show (Const2 k v v')
7272deriving instance Read k => Read (Const2 k v v)
7373
74−-- | Extract the value from a Const2
75−unConst2 :: Const2 k v v' -> k
76−unConst2 (Const2 k) = k
77−
7874instance Show k => GShow (Const2 k v) where
7975 gshowsPrec n x@(Const2 _) = showsPrec n x
8076
@@ -90,25 +86,6 @@ instance Ord k => GCompare (Const2 k v) where
9086 EQ -> GEQ
9187 GT -> GGT
9288
93−data Proxy3 :: x -> y -> z -> * where
94− Proxy3 :: Proxy3 vx vy vz
95− deriving ( Show, Read, Eq, Ord
96− , Functor, Foldable, Traversable
97− , Typeable
98− )
99−
100−instance Cat.Category (Proxy3 x) where
101− id = Proxy3
102− ~Proxy3 . ~Proxy3 = Proxy3
103−
104−newtype First2 (t :: k -> *) (a :: k) (b :: k) = First2 (t b)
105− deriving ( Show, Read, Eq, Ord
106− , Functor, Foldable, Traversable
107− )
108−
109−instance Cat.Semigroupoid (First2 x) where
110− First2 x `o` ~(First2 _) = First2 x
111−
11289-- | Convert a 'DMap' to a regular 'Map'
11390dmapToMap :: DMap (Const2 k v) Identity -> Map k v
11491dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
src/Data/Patch.hs+8−27
@@ -23,6 +23,7 @@ import Data.Semigroup (Semigroup (..))
2323#endif
2424import GHC.Generics
2525
26+import Data.Semigroup.Additive as X
2627import Data.Patch.Class as X
2728import Data.Patch.DMap as X hiding (getDeletions)
2829import Data.Patch.DMapWithMove as X
@@ -31,12 +32,6 @@ import Data.Patch.DMapWithMove as X
3132 , traversePatchDMapWithMoveWithKey, unPatchDMapWithMove
3233 , unsafePatchDMapWithMove, weakenPatchDMapWithMoveWith
3334 )
34−import Data.Patch.DMapWithPatchingMove as X
35− ( PatchDMapWithPatchingMove, const2PatchDMapWithPatchingMoveWith, mapPatchDMapWithPatchingMove
36− , patchDMapWithPatchingMoveToPatchMapWithPatchingMoveWith
37− , traversePatchDMapWithPatchingMoveWithKey, unPatchDMapWithPatchingMove
38− , unsafePatchDMapWithPatchingMove, weakenPatchDMapWithPatchingMoveWith
39− )
4035import Data.Patch.IntMap as X hiding (getDeletions)
4136import Data.Patch.Map as X
4237import Data.Patch.MapWithMove as X
@@ -51,34 +46,25 @@ class (Semigroup q, Monoid q) => Group q where
5146 (~~) :: q -> q -> q
5247 r ~~ s = r <> negateG s
5348
54−-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
55−class Semigroup q => Additive q where
56−
5749-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
5850newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
5951
60−instance Additive p => PatchHet (AdditivePatch p) where
61− type PatchSource (AdditivePatch p) = p
62− type PatchTarget (AdditivePatch p) = p
6352instance Additive p => Patch (AdditivePatch p) where
53+ type PatchTarget (AdditivePatch p) = p
6454 apply (AdditivePatch p) q = Just $ p <> q
6555
6656instance (Ord k, Group q) => Group (MonoidalMap k q) where
6757 negateG = fmap negateG
6858
69−instance (Ord k, Additive q) => Additive (MonoidalMap k q)
70−
7159-- | Trivial group.
7260instance Group () where
73− negateG ~() = ()
74− ~() ~~ ~() = ()
75−instance Additive ()
61+ negateG _ = ()
62+ _ ~~ _ = ()
7663
7764-- | Product group. A Pair of groups gives rise to a group
7865instance (Group a, Group b) => Group (a, b) where
7966 negateG (a, b) = (negateG a, negateG b)
8067 (a, b) ~~ (c, d) = (a ~~ c, b ~~ d)
81−instance (Additive a, Additive b) => Additive (a, b)
8268
8369-- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
8470-- Base does not define Monoid (Compose f g a) so this is the best we can
@@ -86,29 +72,24 @@ instance (Additive a, Additive b) => Additive (a, b)
8672instance Group (f (g a)) => Group ((f :.: g) a) where
8773 negateG (Comp1 xs) = Comp1 (negateG xs)
8874 Comp1 xs ~~ Comp1 ys = Comp1 (xs ~~ ys)
89−instance Additive (f (g a)) => Additive ((f :.: g) a)
9075
9176-- | Product of groups, Functor style.
9277instance (Group (f a), Group (g a)) => Group ((f :*: g) a) where
9378 negateG (a :*: b) = negateG a :*: negateG b
9479 (a :*: b) ~~ (c :*: d) = (a ~~ c) :*: (b ~~ d)
95−instance (Additive (f a), Additive (g a)) => Additive ((f :*: g) a)
9680
9781-- | Trivial group, Functor style
9882instance Group (Proxy x) where
99− negateG ~Proxy = Proxy
100− ~Proxy ~~ ~Proxy = Proxy
101−instance Additive (Proxy x)
83+ negateG _ = Proxy
84+ _ ~~ _ = Proxy
10285
10386-- | Const lifts groups into a functor.
10487deriving instance Group a => Group (Const a x)
105−instance Additive a => Additive (Const a x)
106−-- | Ideitnty lifts groups pointwise (at only one point)
88+
89+-- | Identity lifts groups pointwise (at only one point)
10790deriving instance Group a => Group (Identity a)
108−instance Additive a => Additive (Identity a)
10991
11092-- | Functions lift groups pointwise.
11193instance Group b => Group (a -> b) where
11294 negateG f = negateG . f
11395 (~~) = liftA2 (~~)
114−instance Additive b => Additive (a -> b)
src/Data/Patch/Class.hs+5−131
@@ -1,58 +1,23 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DefaultSignatures #-}
3−{-# LANGUAGE DerivingStrategies #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE PolyKinds #-}
82{-# LANGUAGE ScopedTypeVariables #-}
93{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
114-- | The interface for types which represent changes made to other types
125module Data.Patch.Class where
136
14−import qualified Data.Semigroupoid as Cat
157import Data.Functor.Identity
16−import Data.Functor.Misc
178import Data.Kind (Type)
189import Data.Maybe
1910#if !MIN_VERSION_base(4,11,0)
2011import Data.Semigroup (Semigroup(..))
2112#endif
2213import Data.Proxy
23−import Data.Type.Equality ((:~:) (..))
24−
25−class PatchHet p where
26− type PatchSource p :: Type
27− type PatchTarget p :: Type
28− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
29− -- 'Nothing'.
30− applyHet
31− :: p
32− -> PatchSource p
33− -> Either (PatchSource p :~: PatchTarget p) (PatchTarget p)
34− default applyHet
35− :: Patch p
36− => p
37− -> PatchSource p
38− -> Either (PatchSource p :~: PatchTarget p) (PatchTarget p)
39− applyHet p a = case apply p a of
40− Nothing -> Left Refl
41− Just a' -> Right a'
42−
43−-- | Apply a 'PatchHet'; if it does nothing, return the original value
44−applyAlwaysHet :: PatchHet p => p -> PatchSource p -> PatchTarget p
45−applyAlwaysHet p t = case applyHet p t of
46− Left Refl -> t
47− Right t' -> t'
4814
4915-- | A 'Patch' type represents a kind of change made to a datastructure.
5016--
5117-- If an instance of 'Patch' is also an instance of 'Semigroup', it should obey
5218-- the law that @applyAlways (f <> g) == applyAlways f . applyAlways g@.
53−class ( PatchHet p
54− , PatchSource p ~ PatchTarget p
55− ) => Patch p where
19+class Patch p where
20+ type PatchTarget p :: Type
5621 -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
5722 -- 'Nothing'.
5823 apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
@@ -62,110 +27,19 @@ applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
6227applyAlways p t = fromMaybe t $ apply p t
6328
6429-- | 'Identity' can be used as a 'Patch' that always fully replaces the value
65−instance PatchHet (Identity a) where
66− type PatchSource (Identity a) = a
67− type PatchTarget (Identity a) = a
6830instance Patch (Identity a) where
31+ type PatchTarget (Identity a) = a
6932 apply (Identity a) _ = Just a
7033
7134-- | 'Proxy' can be used as a 'Patch' that does nothing.
72−instance forall (a :: Type). PatchHet (Proxy a) where
73− type PatchSource (Proxy a) = a
74− type PatchTarget (Proxy a) = a
7535instance forall (a :: Type). Patch (Proxy a) where
36+ type PatchTarget (Proxy a) = a
7637 apply ~Proxy _ = Nothing
7738
7839-- | Like '(.)', but composes functions that return patches rather than
7940-- functions that return new values. The Semigroup instance for patches must
8041-- apply patches right-to-left, like '(.)'.
81−composePatchFunctions
82− :: (Patch p, Semigroup p)
83− => (PatchTarget p -> p)
84− -> (PatchTarget p -> p)
85− -> PatchTarget p -> p
42+composePatchFunctions :: (Patch p, Semigroup p) => (PatchTarget p -> p) -> (PatchTarget p -> p) -> PatchTarget p -> p
8643composePatchFunctions g f a =
8744 let fp = f a
8845 in g (applyAlways fp a) <> fp
89−
90−
91−class PatchHet2Base (p :: k -> k -> *) where
92− type PatchSource1 p :: k -> *
93− type PatchTarget1 p :: k -> *
94−
95−class ( PatchHet2Base p
96− , PatchHet (p from to)
97− , PatchSource1 p from ~ PatchSource (p from to)
98− , PatchTarget1 p to ~ PatchTarget (p from to)
99− ) => PatchHet2Locally (p :: k -> k -> *) from to where
100−instance ( PatchHet2Base p
101− , PatchHet (p from to)
102− , PatchSource1 p from ~ PatchSource (p from to)
103− , PatchTarget1 p to ~ PatchTarget (p from to)
104− ) => PatchHet2Locally (p :: k -> k -> *) from to where
105−
106−applyHet2Locally
107− :: PatchHet2Locally p from to
108− => p from to
109− -> PatchSource1 p from
110− -> Either (PatchSource1 p from :~: PatchTarget1 p to) (PatchTarget1 p to)
111−applyHet2Locally = applyHet
112−
113−applyAlwaysHet2Locally
114− :: PatchHet2Locally p from to
115− => p from to
116− -> PatchSource1 p from
117− -> PatchTarget1 p to
118−applyAlwaysHet2Locally = applyAlwaysHet
119−
120−-- TODO once we can use quantified constraints, perhaps combine PatchHet2Base and
121−-- PatchHet2Locally, or at least get rid of this.
122−class PatchHet2Base p => PatchHet2 (p :: k -> k -> *) where
123− applyHet2
124− :: p from to
125− -> PatchSource1 p from
126− -> Either (PatchSource1 p from :~: PatchTarget1 p to) (PatchTarget1 p to)
127−
128−applyAlwaysHet2
129− :: PatchHet2 p
130− => p from to
131− -> PatchSource1 p from
132− -> PatchTarget1 p to
133−applyAlwaysHet2 p t = case applyHet2 p t of
134− Left Refl -> t
135− Right t' -> t'
136−
137−-- | Connect the classes without quanitified constraints
138−newtype ProjectLocal p from to = ProjectLocal { unProjectLocal :: p from to }
139− deriving newtype Cat.Semigroupoid
140−
141−instance PatchHet2 p => PatchHet (ProjectLocal p from to) where
142− type PatchSource (ProjectLocal p from to) = PatchSource1 p from
143− type PatchTarget (ProjectLocal p from to) = PatchTarget1 p to
144− applyHet (ProjectLocal p) = applyHet2 p
145−
146−instance PatchHet2 p => PatchHet2Base (ProjectLocal p) where
147− type PatchSource1 (ProjectLocal p) = PatchSource1 p
148− type PatchTarget1 (ProjectLocal p) = PatchTarget1 p
149−
150−class ( PatchHet2Base p
151− , PatchSource1 p ~ PatchTarget1 p
152− ) => Patch2 p
153−instance ( PatchHet2Base p
154− , PatchSource1 p ~ PatchTarget1 p
155− ) => Patch2 p
156−
157−-- | 'First2' can be used as a 'Patch' that always fully replaces the value
158−instance PatchHet (First2 (t :: k -> *) (from :: k) (to :: k)) where
159− type PatchSource (First2 t from to) = t from
160− type PatchTarget (First2 t from to) = t to
161− applyHet (First2 val) _ = Right val
162−
163−-- | 'Proxy3' can be used as a 'Patch' that always does nothing
164−instance PatchHet (Proxy3 (t :: k -> *) (a :: k) (a :: k)) where
165− type PatchSource (Proxy3 t a a) = t a
166− type PatchTarget (Proxy3 t a a) = t a
167− applyHet ~Proxy3 _ = Left Refl
168−
169−instance PatchHet2Base (Proxy3 (t :: k -> *) :: k -> k -> *) where
170− type PatchSource1 (Proxy3 t) = t
171− type PatchTarget1 (Proxy3 t) = t
src/Data/Patch/DMap.hs+1−3
@@ -42,10 +42,8 @@ instance GCompare k => DecidablyEmpty (PatchDMap k v) where
4242 isEmpty (PatchDMap m) = DMap.null m
4343
4444-- | Apply the insertions or deletions to a given 'DMap'.
45−instance GCompare k => PatchHet (PatchDMap k v) where
46− type PatchSource (PatchDMap k v) = DMap k v
47− type PatchTarget (PatchDMap k v) = DMap k v
4845instance GCompare k => Patch (PatchDMap k v) where
46+ type PatchTarget (PatchDMap k v) = DMap k v
4947 apply (PatchDMap diff) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
5048 where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
5149 deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
src/Data/Patch/DMapWithMove.hs+1−4
@@ -350,11 +350,8 @@ const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fr
350350 }
351351
352352-- | Apply the insertions, deletions, and moves to a given 'DMap'.
353−instance GCompare k => PatchHet (PatchDMapWithMove k v) where
354− type PatchSource (PatchDMapWithMove k v) = DMap k v
355− type PatchTarget (PatchDMapWithMove k v) = DMap k v
356−
357353instance GCompare k => Patch (PatchDMapWithMove k v) where
354+ type PatchTarget (PatchDMapWithMove k v) = DMap k v
358355 apply (PatchDMapWithMove p) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
359356 where insertions = DMap.mapMaybeWithKey insertFunc p
360357 insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
src/Data/Patch/DMapWithPatchingMove.hsdeleted−644
@@ -1,644 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE InstanceSigs #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE PatternGuards #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE StandaloneDeriving #-}
14−{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE UndecidableInstances #-}
16−{-# LANGUAGE UndecidableSuperClasses #-}
17−
18−-- |Module containing @'PatchDMapWithPatchingMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
19−-- move values between keys.
20−module Data.Patch.DMapWithPatchingMove where
21−
22−import qualified Control.Category as Cat
23−--import qualified Control.Category.DecidablyEmpty as Cat
24−
25−import Data.Constraint.Extras (Has')
26−import Data.Dependent.Map (DMap)
27−import Data.Dependent.Sum (DSum (..))
28−import qualified Data.Dependent.Map as DMap
29−import Data.Functor.Constant (Constant (..))
30−import Data.Functor.Misc
31− ( Const2 (..), Proxy3 (..)
32− , weakenDMapWith
33− , dmapToMapWith
34− )
35−import Data.Functor.Product (Product (..))
36−import Data.GADT.Compare (GEq (..), GCompare (..))
37−import Data.GADT.Show (GRead, GShow, gshow)
38−import qualified Data.Map as Map
39−import Data.Maybe
40−import Data.Monoid.DecidablyEmpty
41−import Data.Semigroupoid as Cat
42−#if !MIN_VERSION_base(4,11,0)
43−import Data.Semigroup (Semigroup (..), (<>))
44−#endif
45−import Data.Some (Some (Some), mkSome)
46−import Data.Proxy (Proxy (..))
47−import Data.These (These (..))
48−import Data.Type.Equality ((:~:)(..))
49−
50−import Data.Patch.Class
51− ( Patch (..), PatchHet (..)
52− , PatchHet2 (..), PatchSource1, PatchTarget1
53− , applyAlwaysHet2
54− )
55−import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove (..))
56−import qualified Data.Patch.MapWithPatchingMove as MapWithPatchingMove
57−
58−-- | Like 'PatchMapWithPatchingMove', but for 'DMap'. Each key carries a 'NodeInfo'
59−-- which describes how it will be changed by the patch and connects move sources
60−-- and destinations.
61−--
62−-- Invariants:
63−--
64−-- * A key should not move to itself.
65−--
66−-- * A move should always be represented with both the destination key (as a
67−-- 'From_Move') and the source key (as a @'ComposeMaybe' ('Just'
68−-- destination)@)
69−newtype PatchDMapWithPatchingMove k v = PatchDMapWithPatchingMove (DMap k (NodeInfo k v))
70−
71−--deriving instance ( GShow k
72−-- , HasZip Show k p
73−-- , Has' Show k (PatchTarget1 p)
74−-- ) => Show (PatchDMapWithPatchingMove k p)
75−--deriving instance ( GRead k
76−-- , HasZip Read k p
77−-- , Has' Read k (PatchTarget1 p)
78−-- ) => Read (PatchDMapWithPatchingMove k p)
79−--deriving instance ( GEq k
80−-- , HasZip Eq k p
81−-- , Has' Eq k (PatchTarget1 p)
82−-- ) => Eq (PatchDMapWithPatchingMove k p)
83−--deriving instance ( GCompare k
84−-- , HasZip Ord k p
85−-- , Has' Ord k (PatchTarget1 p)
86−-- ) => Ord (PatchDMapWithPatchingMove k p)
87−
88−-- It won't let me derive for some reason
89−instance ( GCompare k
90− , Cat.Semigroupoid v
91− , PatchHet2 v
92− , PatchSource1 v ~ PatchTarget1 v
93− ) => DecidablyEmpty (PatchDMapWithPatchingMove k v) where
94− isEmpty (PatchDMapWithPatchingMove m) = DMap.null m
95−
96−-- | Structure which represents what changes apply to a particular key.
97−-- @_nodeInfo_from@ specifies what happens to this key, and in particular what
98−-- other key the current key is moving from, while @_nodeInfo_to@ specifies what
99−-- key the current key is moving to if involved in a move.
100−data NodeInfo k p a = NodeInfo
101− { _nodeInfo_from :: !(From k p a)
102− -- ^ Change applying to the current key, be it an insert, move, or delete.
103− , _nodeInfo_to :: !(To k p a)
104− -- ^ Where this key is moving to, if involved in a move. Should only be
105− -- @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
106− }
107−
108−--deriving instance ( Show (k a)
109−-- , Show (p a a)
110−-- , Show (PatchTarget1 p a)
111−-- ) => Show (NodeInfo k p a)
112−--deriving instance ( Read (k a)
113−-- , Read (p a a)
114−-- , Read (PatchTarget1 p a)
115−-- ) => Read (NodeInfo k p a)
116−--deriving instance ( Eq (k a)
117−-- , Eq (p a a)
118−-- , Eq (PatchTarget1 p a)
119−-- ) => Eq (NodeInfo k p a)
120−--deriving instance ( Ord (k a)
121−-- , Ord (p a a)
122−-- , Ord (PatchTarget1 p a)
123−-- ) => Ord (NodeInfo k p a)
124−
125−-- | Structure describing a particular change to a key, be it inserting a new
126−-- key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting
127−-- a key (@From_Delete@), or moving a key (@From_Move@).
128−--
129−-- This type isn't used directly as the from field patch, but is instead wrapped
130−-- in an existential. However, it is nice to be able to reason about this in
131−-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
132−data From (k :: a -> *) (p :: a -> a -> *) :: a -> * where
133− -- | Insert a new or update an existing key with the given value @PatchTarget1
134− -- p a@
135− From_Insert :: PatchTarget1 p to -> From k p to
136− -- | Delete the existing key
137− From_Delete :: From k p to
138− -- | Move the value from the given key @k a@ to this key. The source key
139− -- should also have an entry in the patch giving the current key as
140− -- @_nodeInfo_to@, usually but not necessarily with @From_Delete@.
141− From_Move :: !(DSum k (Flip p to)) -> From k p to
142−
143−deriving instance ( Show (k a), GShow k
144− , Has' Show k (Flip p a)
145− , Show (PatchTarget1 p a)
146− ) => Show (From k p a)
147−deriving instance ( Read (k a), GRead k
148− , Has' Read k (Flip p a)
149− , Read (PatchTarget1 p a)
150− ) => Read (From k p a)
151−deriving instance ( GEq k
152− , Has' Eq k (Flip p a)
153− , Eq (PatchTarget1 p a)
154− ) => Eq (From k p a)
155−deriving instance ( GCompare k
156− , Has' Eq k (Flip p a) -- superclass bug
157− , Has' Ord k (Flip p a)
158− , Ord (PatchTarget1 p a)
159− ) => Ord (From k p a)
160−
161−newtype Flip p to from = Flip (p from to)
162−
163−instance Cat.Category p => Cat.Category (Flip (p :: k -> k -> *)) where
164− id = Flip Cat.id
165− Flip y . Flip x = Flip $ x Cat.. y
166−
167−-- | The "to" part of a 'NodeInfo'. Rather than be built out of @From@ like @From@
168−-- is, we store just the information necessary to compose a @To@ and @From@ like
169−-- @oLocal@ composes two @From@s.
170−data To (k :: a -> *) (p :: a -> a -> *) :: a -> * where
171− -- | Delete or leave in place
172− To_NonMove :: To k p from
173− -- | Move the value from the given key @k a@ to this key. The target key
174− -- should also have an entry in the patch giving the current key in
175− -- @_nodeInfo_from@, usually but not necessarily with @To_Delete@.
176− To_Move :: !(Some k) -> To k p from
177−
178−deriving instance ( Show (k a), GShow k
179− , Has' Show k (p a)
180− , Show (PatchTarget1 p a)
181− ) => Show (To k p a)
182−deriving instance ( Read (k a), GRead k
183− , Has' Read k (p a)
184− , Read (PatchTarget1 p a)
185− ) => Read (To k p a)
186−deriving instance ( GEq k
187− , Has' Eq k (p a)
188− , Eq (PatchTarget1 p a)
189− ) => Eq (To k p a)
190−deriving instance ( GCompare k
191− , Has' Eq k (p a) -- superclass bug
192− , Has' Ord k (p a)
193− , Ord (PatchTarget1 p a)
194− ) => Ord (To k p a)
195−
196−-- |Test whether a 'PatchDMapWithPatchingMove' satisfies its invariants.
197−validPatchDMapWithPatchingMove
198− :: forall k v
199− . (GCompare k, GShow k)
200− => DMap k (NodeInfo k v)
201− -> Bool
202−validPatchDMapWithPatchingMove = not . null . validationErrorsForPatchDMapWithPatchingMove
203−
204−-- |Enumerate what reasons a 'PatchDMapWithPatchingMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
205−validationErrorsForPatchDMapWithPatchingMove
206− :: forall k v
207− . (GCompare k, GShow k)
208− => DMap k (NodeInfo k v)
209− -> [String]
210−validationErrorsForPatchDMapWithPatchingMove m =
211− noSelfMoves <> movesBalanced
212− where
213− noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
214− selfMove (dst :=> NodeInfo (From_Move (src :=> _)) _)
215− | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
216− selfMove (src :=> NodeInfo _ (To_Move (Some dst)))
217− | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
218− selfMove _ = Nothing
219− movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
220− unbalancedMove (dst :=> NodeInfo (From_Move (src :=> _)) _) =
221− case DMap.lookup src m of
222− Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
223− Just (NodeInfo _ (To_Move (Some dst'))) ->
224− if isNothing (dst' `geq` dst)
225− then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
226− else Nothing
227− _ ->
228− Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
229− unbalancedMove (src :=> NodeInfo _ (To_Move (Some dst))) =
230− case DMap.lookup dst m of
231− Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
232− Just (NodeInfo (From_Move (src' :=> _)) _) ->
233− if isNothing (src' `geq` src)
234− then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
235− else Nothing
236−
237− _ ->
238− Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
239− unbalancedMove _ = Nothing
240−
241−-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
242−data Pair1 f g a = Pair1 (f a) (g a)
243−
244−-- |Helper data structure used for composing patches using the monoid instance.
245−data Fixup k p a
246− = Fixup_Delete
247− | Fixup_Update (These (DSum k (From k p)) (To k p a))
248−
249−-- | Compose patches having the same effect as applying the patches in turn:
250−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
251−instance forall k p
252− . ( GCompare k
253− , Cat.Semigroupoid p
254− -- , Cat.DecidablyEmpty p
255− , PatchHet2 p
256− , PatchSource1 p ~ PatchTarget1 p
257− )
258− => Semigroup (PatchDMapWithPatchingMove k p) where
259− PatchDMapWithPatchingMove ma <> PatchDMapWithPatchingMove mb = PatchDMapWithPatchingMove m
260− where
261− connections :: [DSum k (Pair1 (To k p) (From k p))]
262− connections = DMap.toList $ DMap.intersectionWithKey
263− (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b))
264− ma
265− mb
266− h :: DSum k (Pair1 (To k p) (From k p)) -> [DSum k (Fixup k p)]
267− h ((between :: k between) :=> Pair1 editAfter editBefore) = case (editAfter, editBefore) of
268− (To_Move (Some (toAfter :: k after)), From_Move ((fromBefore :: k before) :=> Flip p) :: From k p between) ->
269− --case toAfter `geq` fromBefore of
270− -- Just Refl | Just Refl <- Cat.isId p0 ->
271− -- [ toAfter :=> Fixup_Delete ]
272− -- _ ->
273− [ toAfter :=> Fixup_Update (This $ between :=> From_Move (fromBefore :=> Flip p))
274− , fromBefore :=> Fixup_Update (That $ To_Move $ Some toAfter)
275− ]
276− (To_NonMove, From_Move (fromBefore :=> _)) ->
277− -- The item is destroyed in the second patch, so indicate that it is
278− -- destroyed in the source map
279− [fromBefore :=> Fixup_Update (That To_NonMove)]
280− --(To_Move (Some toAfter), From_Insert val) ->
281− -- [toAfter :=> Fixup_Update (This $ From_Insert $ applyAlwaysHet2 p val)]
282− --(To_Move (Some toAfter), From_Delete) ->
283− -- [toAfter :=> Fixup_Update (This From_Delete)]
284− (To_Move (Some toAfter), _) ->
285− [toAfter :=> Fixup_Update (This $ between :=> editBefore)]
286− (To_NonMove, _) ->
287− []
288− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
289− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
290− | This x <- a, That y <- b
291− = Fixup_Update $ These x y
292− | That y <- a, This x <- b
293− = Fixup_Update $ These x y
294− mergeFixups _ _ _ = error "PatchDMapWithPatchingMove: incompatible fixups"
295− fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
296− combineNodeInfos _ nia nib = NodeInfo
297− { _nodeInfo_from = _nodeInfo_from nia
298− , _nodeInfo_to = _nodeInfo_to nib
299− }
300− applyFixup :: k a -> NodeInfo k p a -> Fixup k p a -> Maybe (NodeInfo k p a)
301− applyFixup _ ni = \case
302− Fixup_Delete -> Nothing
303− Fixup_Update u -> Just $ NodeInfo
304− { _nodeInfo_from = case _nodeInfo_from ni of
305− f@(From_Move ((between0 :: k between0) :=> Flip (p' :: p between0 a))) -> case getHere u of -- The `from` fixup comes from the "old" patch
306− Nothing -> f -- If there's no `from` fixup, just use the "new" `from`
307− Just ((between1 :: k between1) :=> frm) -> case geq between0 between1 of
308− Nothing -> error "fixup joined-on key did not match"
309− Just Refl -> case frm of
310− From_Insert v -> From_Insert $ applyAlwaysHet2 p' v
311− From_Delete -> From_Delete
312− From_Move (oldKey :=> Flip (p :: p oldKey between1)) -> From_Move $ oldKey :=> Flip (p' `o` p :: p oldKey a)
313− _ -> error "PatchMapWithPatchingMove: fixup for non-move From"
314− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
315− }
316− m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
317− getHere :: These a b -> Maybe a
318− getHere = \case
319− This a -> Just a
320− These a _ -> Just a
321− That _ -> Nothing
322− getThere :: These a b -> Maybe b
323− getThere = \case
324− This _ -> Nothing
325− These _ b -> Just b
326− That b -> Just b
327−
328−-- | Compose patches having the same effect as applying the patches in turn:
329−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
330−instance ( GCompare k
331− , Cat.Semigroupoid p
332− -- , DecidablyEmpty p
333− , PatchHet2 p
334− , PatchSource1 p ~ PatchTarget1 p
335− ) => Monoid (PatchDMapWithPatchingMove k p) where
336− mempty = PatchDMapWithPatchingMove mempty
337− mappend = (<>)
338−
339−{-
340−mappendPatchDMapWithPatchingMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithPatchingMove k v -> PatchDMapWithPatchingMove k v -> PatchDMapWithPatchingMove k v
341−PatchDMapWithPatchingMove dstAfter srcAfter `mappendPatchDMapWithPatchingMoveSlow` PatchDMapWithPatchingMove dstBefore srcBefore = PatchDMapWithPatchingMove dst src
342− where
343− getDstAction k m = fromMaybe (From_Move k) $ DMap.lookup k m -- Any key that isn't present is treated as that key moving to itself
344− removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
345− removeRedundantDst _ a = Just a
346− f :: forall a. k a -> From k v a -> Maybe (From k v a)
347− f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
348− From_Move fromKey -> getDstAction fromKey dstBefore
349− nonMove -> nonMove
350− dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
351− getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
352− removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
353− removeRedundantSrc _ a = Just a
354− g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
355− g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
356− ComposeMaybe Nothing -> ComposeMaybe Nothing
357− ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
358− src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
359−-}
360−
361−-- | Make a @'PatchDMapWithPatchingMove' k v@ which has the effect of inserting or
362−-- updating a value @PatchTarget1 p a@ to the given key @k a@, like
363−-- 'DMap.insert'.
364−insertDMapKey :: k a -> PatchTarget1 p a -> PatchDMapWithPatchingMove k p
365−insertDMapKey k v =
366− PatchDMapWithPatchingMove . DMap.singleton k $ NodeInfo (From_Insert v) To_NonMove
367−
368−-- | Make a @'PatchDMapWithPatchingMove' k v@ which has the effect of moving the value
369−-- from the first key @k a@ to the second key @k a@, equivalent to:
370−--
371−-- @
372−-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
373−-- @
374−moveDMapKey
375− :: GCompare k
376− => k a -> k a -> PatchDMapWithPatchingMove k (Proxy3 v)
377−moveDMapKey src dst = case src `geq` dst of
378− Nothing -> PatchDMapWithPatchingMove $ DMap.fromList
379− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) To_NonMove
380− , src :=> NodeInfo From_Delete (To_Move $ Some dst)
381− ]
382− Just _ -> PatchDMapWithPatchingMove DMap.empty
383−
384−-- | Make a @'PatchDMapWithPatchingMove' k v@ which has the effect of swapping two keys
385−-- in the mapping, equivalent to:
386−--
387−-- @
388−-- let aMay = DMap.lookup a dmap
389−-- bMay = DMap.lookup b dmap
390−-- in maybe id (DMap.insert a) (bMay <> aMay)
391−-- . maybe id (DMap.insert b) (aMay <> bMay)
392−-- . DMap.delete a . DMap.delete b $ dmap
393−-- @
394−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithPatchingMove k (Proxy3 v)
395−swapDMapKey src dst = case src `geq` dst of
396− Nothing -> PatchDMapWithPatchingMove $ DMap.fromList
397− [ dst :=> NodeInfo (From_Move (src :=> Flip Proxy3)) (To_Move $ Some src)
398− , src :=> NodeInfo (From_Move (dst :=> Flip Proxy3)) (To_Move $ Some dst)
399− ]
400− Just _ -> PatchDMapWithPatchingMove DMap.empty
401−
402−-- | Make a @'PatchDMapWithPatchingMove' k v@ which has the effect of deleting a key in
403−-- the mapping, equivalent to 'DMap.delete'.
404−deleteDMapKey :: k a -> PatchDMapWithPatchingMove k v
405−deleteDMapKey k = PatchDMapWithPatchingMove $ DMap.singleton k $ NodeInfo From_Delete To_NonMove
406−
407−{-
408−k1, k2 :: Const2 Int () ()
409−k1 = Const2 1
410−k2 = Const2 2
411−p1, p2 :: PatchDMapWithPatchingMove (Const2 Int ()) Identity
412−p1 = moveDMapKey k1 k2
413−p2 = moveDMapKey k2 k1
414−p12 = p1 <> p2
415−p21 = p2 <> p1
416−p12Slow = p1 `mappendPatchDMapWithPatchingMoveSlow` p2
417−p21Slow = p2 `mappendPatchDMapWithPatchingMoveSlow` p1
418−
419−testPatchDMapWithPatchingMove = do
420− print p1
421− print p2
422− print $ p12 == deleteDMapKey k1
423− print $ p21 == deleteDMapKey k2
424− print $ p12Slow == deleteDMapKey k1
425− print $ p21Slow == deleteDMapKey k2
426−
427−dst (PatchDMapWithPatchingMove x _) = x
428−src (PatchDMapWithPatchingMove _ x) = x
429−-}
430−
431−-- | Extract the 'DMap' representing the patch changes from the
432−-- 'PatchDMapWithPatchingMove'.
433−unPatchDMapWithPatchingMove :: PatchDMapWithPatchingMove k v -> DMap k (NodeInfo k v)
434−unPatchDMapWithPatchingMove (PatchDMapWithPatchingMove p) = p
435−
436−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithPatchingMove',
437−-- without checking any invariants.
438−--
439−-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithPatchingMove' are preserved; they will not be checked.
440−unsafePatchDMapWithPatchingMove :: DMap k (NodeInfo k v) -> PatchDMapWithPatchingMove k v
441−unsafePatchDMapWithPatchingMove = PatchDMapWithPatchingMove
442−
443−-- | Wrap a 'DMap' representing patch changes into a 'PatchDMapWithPatchingMove' while
444−-- checking invariants. If the invariants are satisfied, @Right p@ is returned
445−-- otherwise @Left errors@.
446−patchDMapWithPatchingMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithPatchingMove k v)
447−patchDMapWithPatchingMove dm =
448− case validationErrorsForPatchDMapWithPatchingMove dm of
449− [] -> Right $ unsafePatchDMapWithPatchingMove dm
450− errs -> Left errs
451−
452−-- | Map a natural transform @v -> v'@ over the given patch, transforming
453−-- @'PatchDMapWithPatchingMove' k v@ into @'PatchDMapWithPatchingMove' k v'@.
454−mapPatchDMapWithPatchingMove
455− :: forall k p p'
456− . (forall a. PatchTarget1 p a -> PatchTarget1 p' a)
457− -> (forall from to. p from to -> p' from to)
458− -> PatchDMapWithPatchingMove k p
459− -> PatchDMapWithPatchingMove k p'
460−mapPatchDMapWithPatchingMove f g (PatchDMapWithPatchingMove m) =
461− PatchDMapWithPatchingMove $ DMap.map (\ni -> NodeInfo
462− { _nodeInfo_from = h $ _nodeInfo_from ni
463− , _nodeInfo_to = j $ _nodeInfo_to ni
464− }) m
465− where h :: forall a. From k p a -> From k p' a
466− h = \case
467− From_Insert v -> From_Insert $ f v
468− From_Delete -> From_Delete
469− From_Move (k :=> Flip p) -> From_Move $ k :=> Flip (g p)
470− j :: forall a. To k p a -> To k p' a
471− j = \case
472− To_NonMove -> To_NonMove
473− To_Move (Some k) -> To_Move $ Some k
474−
475−-- | Traverse an effectful function @forall a. PatchTarget1 p a -> m (v ' a)@
476−-- over the given patch, transforming @'PatchDMapWithPatchingMove' k v@ into @m
477−-- ('PatchDMapWithPatchingMove' k v')@.
478−traversePatchDMapWithPatchingMove
479− :: forall m k p p'
480− . Applicative m
481− => (forall a. PatchTarget1 p a -> m (PatchTarget1 p' a))
482− -> (forall from to. p from to -> m (p' from to))
483− -> PatchDMapWithPatchingMove k p
484− -> m (PatchDMapWithPatchingMove k p')
485−traversePatchDMapWithPatchingMove f g = traversePatchDMapWithPatchingMoveWithKey
486− (\_ -> f)
487− (\_ _ -> g)
488−
489−-- | Map an effectful function @forall a. k a -> PatchTarget1 p a -> m (v ' a)@
490−-- over the given patch, transforming @'PatchDMapWithPatchingMove' k v@ into @m
491−-- ('PatchDMapWithPatchingMove' k v')@.
492−traversePatchDMapWithPatchingMoveWithKey
493− :: forall m k p p'
494− . Applicative m
495− => (forall a. k a -> PatchTarget1 p a -> m (PatchTarget1 p' a))
496− -> (forall from to. k from -> k to -> p from to -> m (p' from to))
497− -> PatchDMapWithPatchingMove k p
498− -> m (PatchDMapWithPatchingMove k p')
499−traversePatchDMapWithPatchingMoveWithKey f g (PatchDMapWithPatchingMove m) =
500− PatchDMapWithPatchingMove <$> DMap.traverseWithKey (\k ni -> NodeInfo
501− <$> h k (_nodeInfo_from ni)
502− <*> j k (_nodeInfo_to ni)) m
503− where h :: forall a. k a -> From k p a -> m (From k p' a)
504− h k = \case
505− From_Insert v -> From_Insert <$> f k v
506− From_Delete -> pure From_Delete
507− From_Move (fromKey :=> Flip p) -> From_Move . (fromKey :=>) . Flip <$> g fromKey k p
508− j :: forall a. k a -> To k p a -> m (To k p' a)
509− j _ = \case
510− To_NonMove -> pure To_NonMove
511− To_Move (Some toKey) -> pure $ To_Move $ Some toKey
512−
513−-- | Map a function which transforms @'From k PatchTarget1 p a@ into a @'From k
514−-- PatchTarget1 p' a@ over a @'NodeInfo' k PatchTarget1 p a@.
515−nodeInfoMapFrom
516− :: (From k p a -> From k p' a)
517− -> (To k p a -> To k p' a)
518− -> NodeInfo k p a
519− -> NodeInfo k p' a
520−nodeInfoMapFrom f g ni = NodeInfo
521− { _nodeInfo_from = f $ _nodeInfo_from ni
522− , _nodeInfo_to = g $ _nodeInfo_to ni
523− }
524−
525−-- | Map an effectful function which transforms @'From k PatchTarget1 p a@ into
526−-- a @f ('From k PatchTarget1 p' a)@ over a @'NodeInfo' k PatchTarget1 p a@.
527−nodeInfoMapFromM
528− :: Applicative f
529− => (From k p a -> f (From k p' a))
530− -> (To k p a -> f (To k p' a))
531− -> NodeInfo k p a
532− -> f (NodeInfo k p' a)
533−nodeInfoMapFromM f g ni = NodeInfo
534− <$> f (_nodeInfo_from ni)
535− <*> g (_nodeInfo_to ni)
536−
537−-- | Weaken a 'PatchDMapWithPatchingMove' to a 'PatchMapWithPatchingMove' by weakening the keys
538−-- from @k a@ to @'Some' k@ and applying a given weakening function
539−-- @PatchTarget1 p a -> v'@ to values.
540−weakenPatchDMapWithPatchingMoveWith
541− :: forall k p p'
542− . (forall a. PatchTarget1 p a -> PatchTarget p')
543− -> (forall from to. p from to -> p')
544− -> PatchDMapWithPatchingMove k p
545− -> PatchMapWithPatchingMove (Some k) p'
546−weakenPatchDMapWithPatchingMoveWith f g (PatchDMapWithPatchingMove m) =
547− PatchMapWithPatchingMove $ weakenDMapWith h m
548− where h :: forall a. NodeInfo k p a -> MapWithPatchingMove.NodeInfo (Some k) p'
549− h ni = MapWithPatchingMove.NodeInfo
550− { MapWithPatchingMove._nodeInfo_from = case _nodeInfo_from ni of
551− From_Insert v -> MapWithPatchingMove.From_Insert $ f v
552− From_Delete -> MapWithPatchingMove.From_Delete
553− From_Move (k :=> Flip p) -> MapWithPatchingMove.From_Move (mkSome k) $ g p
554− , MapWithPatchingMove._nodeInfo_to = case _nodeInfo_to ni of
555− To_NonMove -> Nothing
556− To_Move (Some k) -> Just (mkSome k)
557− }
558−
559−-- | "Weaken" a @'PatchDMapWithPatchingMove' (Const2 k a) v@ to a @'PatchMapWithPatchingMove' k
560−-- v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
561−-- dependency in the typing and all points are already @a@, hence the function
562−-- to map each value to @v'@ is not higher rank.
563−patchDMapWithPatchingMoveToPatchMapWithPatchingMoveWith
564− :: forall k p p' a
565− . (PatchTarget1 p a -> PatchTarget p')
566− -> (p a a -> p')
567− -> PatchDMapWithPatchingMove (Const2 k a) p
568− -> PatchMapWithPatchingMove k p'
569−patchDMapWithPatchingMoveToPatchMapWithPatchingMoveWith f g (PatchDMapWithPatchingMove m) =
570− PatchMapWithPatchingMove $ dmapToMapWith h m
571− where h :: NodeInfo (Const2 k a) p a -> MapWithPatchingMove.NodeInfo k p'
572− h ni = MapWithPatchingMove.NodeInfo
573− { MapWithPatchingMove._nodeInfo_from = case _nodeInfo_from ni of
574− From_Insert v -> MapWithPatchingMove.From_Insert $ f v
575− From_Delete -> MapWithPatchingMove.From_Delete
576− From_Move (Const2 k :=> Flip p) -> MapWithPatchingMove.From_Move k $ g p
577− , MapWithPatchingMove._nodeInfo_to = case _nodeInfo_to ni of
578− To_NonMove -> Nothing
579− To_Move (Some (Const2 k)) -> Just k
580− }
581−
582−-- | "Strengthen" a @'PatchMapWithPatchingMove' k v@ into a @'PatchDMapWithPatchingMove
583−-- ('Const2' k a)@; that is, turn a non-dependently-typed patch into a
584−-- dependently typed one but which always has a constant key type represented by
585−-- 'Const2'. Apply the given function to each @v@ to produce a @PatchTarget1 p'
586−-- a@. Completemented by 'patchDMapWithPatchingMoveToPatchMapWithPatchingMoveWith'
587−const2PatchDMapWithPatchingMoveWith
588− :: forall k v v' a
589− . (v -> v' a)
590− -> PatchMapWithPatchingMove k (Proxy v)
591− -> PatchDMapWithPatchingMove (Const2 k a) (Proxy3 v')
592−const2PatchDMapWithPatchingMoveWith f (PatchMapWithPatchingMove p) =
593− PatchDMapWithPatchingMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
594− where g :: (k, MapWithPatchingMove.NodeInfo k (Proxy v))
595− -> DSum (Const2 k a) (NodeInfo (Const2 k a) (Proxy3 v'))
596− g (k, ni) = Const2 k :=> NodeInfo
597− { _nodeInfo_from = case MapWithPatchingMove._nodeInfo_from ni of
598− MapWithPatchingMove.From_Insert v -> From_Insert $ f v
599− MapWithPatchingMove.From_Delete -> From_Delete
600− MapWithPatchingMove.From_Move fromKey Proxy -> From_Move $ Const2 fromKey :=> Flip Proxy3
601− , _nodeInfo_to = case MapWithPatchingMove._nodeInfo_to ni of
602− Nothing -> To_NonMove
603− Just toKey -> To_Move $ Some (Const2 toKey)
604− }
605−
606−-- | Apply the insertions, deletions, and moves to a given 'DMap'.
607−instance ( GCompare k
608− , PatchHet2 p
609− , PatchSource1 p ~ PatchTarget1 p
610− ) => PatchHet (PatchDMapWithPatchingMove k p) where
611− type PatchSource (PatchDMapWithPatchingMove k p) = DMap k (PatchSource1 p)
612− type PatchTarget (PatchDMapWithPatchingMove k p) = DMap k (PatchTarget1 p)
613−
614−instance ( GCompare k
615− , PatchHet2 p
616− , PatchSource1 p ~ PatchTarget1 p
617− ) => Patch (PatchDMapWithPatchingMove k p) where
618− apply (PatchDMapWithPatchingMove m) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions)
619− -- TODO: return Nothing sometimes --Note: the strict application here is
620− -- critical to ensuring that incremental merges don't hold onto all their
621− -- prerequisite events forever; can we make this more robust?
622− where insertions = DMap.mapMaybeWithKey insertFunc m
623− insertFunc :: forall a. k a -> NodeInfo k p a -> Maybe (PatchTarget1 p a)
624− insertFunc _ ni = case _nodeInfo_from ni of
625− From_Insert v -> Just v
626− From_Move (k :=> Flip p) -> applyAlwaysHet2 p <$> DMap.lookup k old
627− From_Delete -> Nothing
628− deletions = DMap.mapMaybeWithKey deleteFunc m
629− deleteFunc :: forall a. k a -> NodeInfo k p a -> Maybe (Constant () a)
630− deleteFunc _ ni = case _nodeInfo_from ni of
631− From_Delete -> Just $ Constant ()
632− _ -> Nothing
633−
634−-- | Get the values that will be replaced, deleted, or moved if the given patch
635−-- is applied to the given 'DMap'.
636−getDeletionsAndMoves
637− :: ( GCompare k
638− , PatchSource1 p ~ PatchTarget1 p
639− )
640− => PatchDMapWithPatchingMove k p
641− -> DMap k (PatchSource1 p)
642− -> DMap k (Product (PatchTarget1 p) (To k p))
643−getDeletionsAndMoves (PatchDMapWithPatchingMove p) m = DMap.intersectionWithKey f m p
644− where f _ v ni = Pair v $ _nodeInfo_to ni
src/Data/Patch/DMapWithPatchingMove/By.hsdeleted−89
@@ -1,89 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE InstanceSigs #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE Rank2Types #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE StandaloneDeriving #-}
13−{-# LANGUAGE TypeFamilies #-}
14−{-# LANGUAGE UndecidableInstances #-}
15−{-# LANGUAGE UndecidableSuperClasses #-}
16−
17−module Data.Patch.DMapWithPatchingMove.By where
18−
19−import Data.Semigroupoid as Cat
20−
21−import Data.Patch.Class
22−
23−-- | Structure describing a particular change to a key, be it inserting a new
24−-- key (@By_Insert@), updating an existing key (@By_Insert@ again), deleting
25−-- a key (@By_Delete@), or moving a key (@By_Move@).
26−--
27−-- This type isn't used directly as the from field patch, but is instead wrapped
28−-- in an existential. However, it is nice to be able to reason about this in
29−-- isolation as it is itself a @Semigroupoid@ when the underlying patch is.
30−data By (k :: a -> *) (p :: a -> a -> *) :: a -> a -> * where
31− -- | Insert a new or update an existing key with the given value @PatchTarget1
32− -- p a@
33− By_Insert :: PatchTarget1 p to -> By k p from to
34− -- | Delete the existing key
35− By_Delete :: By k p from to
36− -- | Move the value from the given key @k a@ to this key. The source key
37− -- should also have an entry in the patch giving the current key as
38− -- @_nodeInfo_to@, usually but not necessarily with @By_Delete@.
39− By_Move :: !(k from) -> p from to -> By k p from to
40−
41−deriving instance ( Show (k from), Show (k to)
42− , Show (p from to)
43− , Show (PatchTarget1 p to)
44− ) => Show (By k p from to)
45−deriving instance ( Read (k from), Read (k to)
46− , Read (p from to)
47− , Read (PatchTarget1 p to)
48− ) => Read (By k p from to)
49−deriving instance ( Eq (k from), Eq (k to)
50− , Eq (p from to)
51− , Eq (PatchTarget1 p to)
52− ) => Eq (By k p from to)
53−deriving instance ( Ord (k from), Ord (k to)
54− , Ord (p from to)
55− , Ord (PatchTarget1 p to)
56− ) => Ord (By k p from to)
57−
58−mapByPatch
59− :: PatchTarget1 p0 ~ PatchTarget1 p1
60− => (p0 from to -> p1 from to)
61− -> By k p0 from to
62− -> By k p1 from to
63−mapByPatch f = \case
64− By_Insert v -> By_Insert v
65− By_Delete -> By_Delete
66− By_Move k p -> By_Move k $ f p
67−
68−-- | Compose patches having the same effect as applying the patches in turn:
69−-- @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
70−instance ( PatchSource1 p ~ PatchTarget1 p
71− , Cat.Semigroupoid p
72− , PatchHet2 p
73− ) => Cat.Semigroupoid (By k p) where
74− o p0 p1 = mapByPatch unProjectLocal $
75− oLocal (mapByPatch ProjectLocal p0) (mapByPatch ProjectLocal p1)
76−
77−oLocal
78− :: ( PatchSource1 p ~ PatchTarget1 p
79− , PatchHet2Locally p between after
80− , Cat.Semigroupoid p
81− )
82− => By k p between after
83− -> By k p before between
84− -> By k p before after
85−By_Insert new `oLocal` _ = By_Insert new
86−By_Delete `oLocal` _ = By_Delete
87−By_Move _ x `oLocal` By_Insert y = By_Insert $ applyAlwaysHet2Locally x y
88−By_Move _ x `oLocal` By_Move src y = By_Move src $ x `o` y
89−By_Move _ _ `oLocal` By_Delete = By_Delete
src/Data/Patch/IntMap.hs+1−3
@@ -38,10 +38,8 @@ deriving instance Semigroup (PatchIntMap v)
3838makeWrapped ''PatchIntMap
3939
4040-- | Apply the insertions or deletions to a given 'IntMap'.
41−instance PatchHet (PatchIntMap a) where
42− type PatchSource (PatchIntMap a) = IntMap a
43− type PatchTarget (PatchIntMap a) = IntMap a
4441instance Patch (PatchIntMap a) where
42+ type PatchTarget (PatchIntMap a) = IntMap a
4543 apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
4644 let removes = IntMap.filter isNothing p
4745 adds = IntMap.mapMaybe id p
src/Data/Patch/Map.hs+1−3
@@ -45,10 +45,8 @@ instance Ord k => Semigroup (PatchMap k v) where
4545 stimes = stimesIdempotentMonoid
4646
4747-- | Apply the insertions or deletions to a given 'Map'.
48−instance Ord k => PatchHet (PatchMap k v) where
49− type PatchSource (PatchMap k v) = Map k v
50− type PatchTarget (PatchMap k v) = Map k v
5148instance Ord k => Patch (PatchMap k v) where
49+ type PatchTarget (PatchMap k v) = Map k v
5250 {-# INLINABLE apply #-}
5351 apply (PatchMap p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
5452 where insertions = Map.mapMaybeWithKey (const id) p
src/Data/Patch/MapWithMove.hs+8−11
@@ -137,7 +137,7 @@ instance TraversableWithIndex k (PatchMapWithMove k) where
137137
138138-- | Create a 'PatchMapWithMove', validating it
139139patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
140−patchMapWithMove = fmap coerce . PM.patchMapWithPatchingMove . coerce
140+patchMapWithMove = fmap PatchMapWithMove' . PM.patchMapWithPatchingMove . coerce
141141
142142-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
143143patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
@@ -175,14 +175,11 @@ deleteMapKey = PatchMapWithMove' . PM.deleteMapKey
175175--
176176-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
177177unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
178−unsafePatchMapWithMove = PatchMapWithMove' . PM.unsafePatchMapWithPatchingMove . coerce
178+unsafePatchMapWithMove = coerce PM.unsafePatchMapWithPatchingMove
179179
180180-- | Apply the insertions, deletions, and moves to a given 'Map'
181−instance Ord k => PatchHet (PatchMapWithMove k v) where
182− type PatchSource (PatchMapWithMove k v) = Map k v
183− type PatchTarget (PatchMapWithMove k v) = Map k v
184−
185181instance Ord k => Patch (PatchMapWithMove k v) where
182+ type PatchTarget (PatchMapWithMove k v) = Map k v
186183 apply (PatchMapWithMove' p) = apply p
187184
188185-- | Returns all the new elements that will be added to the 'Map'.
@@ -202,7 +199,7 @@ patchThatSortsMapWith cmp = PatchMapWithMove' . PM.patchThatSortsMapWith cmp
202199-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
203200-- will produce a 'Map' with the same values as the second 'Map' but with the
204201-- values sorted with the given ordering function.
205−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
202+patchThatChangesAndSortsMapWith :: (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
206203patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
207204 where newList = Map.toList newByIndexUnsorted
208205 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
@@ -258,13 +255,13 @@ bitraverseNodeInfo
258255 => (k0 -> f k1)
259256 -> (v0 -> f v1)
260257 -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
261−bitraverseNodeInfo fk fv = fmap coerce
258+bitraverseNodeInfo fk fv = fmap NodeInfo'
262259 . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
263260 . coerce
264261
265262-- | Change the 'From' value of a 'NodeInfo'
266263nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
267−nodeInfoMapFrom f = coerce . PM.nodeInfoMapFrom (unFrom' . f . From') . coerce
264+nodeInfoMapFrom f = coerce $ PM.nodeInfoMapFrom (unFrom' . f . From')
268265
269266-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
270267-- 'Applicative', 'Monad', etc.) action to get the new value
@@ -272,7 +269,7 @@ nodeInfoMapMFrom
272269 :: Functor f
273270 => (From k v -> f (From k v))
274271 -> NodeInfo k v -> f (NodeInfo k v)
275−nodeInfoMapMFrom f = fmap coerce
272+nodeInfoMapMFrom f = fmap NodeInfo'
276273 . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
277274 . coerce
278275
@@ -306,7 +303,7 @@ bitraverseFrom
306303 => (k0 -> f k1)
307304 -> (v0 -> f v1)
308305 -> From k0 v0 -> f (From k1 v1)
309−bitraverseFrom fk fv = fmap coerce
306+bitraverseFrom fk fv = fmap From'
310307 . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
311308 . coerce
312309
src/Data/Patch/MapWithPatchingMove.hs+36−38
@@ -48,10 +48,10 @@ module Data.Patch.MapWithPatchingMove
4848
4949import Data.Patch.Class
5050
51−import Control.Arrow
51+import Control.Lens hiding (from, to)
5252import Control.Lens.TH (makeWrapped)
53−import Control.Monad.Trans.State
54−import Data.Foldable
53+import Data.Align (align)
54+import Data.Foldable (toList)
5555import Data.Function
5656import Data.List
5757import Data.Map (Map)
@@ -61,9 +61,9 @@ import Data.Maybe
6161import Data.Semigroup (Semigroup (..))
6262#endif
6363import Data.Monoid.DecidablyEmpty
64+import Data.Set (Set)
6465import qualified Data.Set as Set
6566import Data.These (These (..))
66−import Data.Tuple
6767
6868-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
6969-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
@@ -170,11 +170,8 @@ unsafePatchMapWithPatchingMove
170170unsafePatchMapWithPatchingMove = PatchMapWithPatchingMove
171171
172172-- | Apply the insertions, deletions, and moves to a given 'Map'
173−instance (Ord k, Patch p) => PatchHet (PatchMapWithPatchingMove k p) where
174− type PatchSource (PatchMapWithPatchingMove k p) = Map k (PatchSource p)
175− type PatchTarget (PatchMapWithPatchingMove k p) = Map k (PatchTarget p)
176−
177173instance (Ord k, Patch p) => Patch (PatchMapWithPatchingMove k p) where
174+ type PatchTarget (PatchMapWithPatchingMove k p) = Map k (PatchTarget p)
178175 -- TODO: return Nothing sometimes
179176 -- Note: the strict application here is critical to ensuring that incremental
180177 -- merges don't hold onto all their prerequisite events forever; can we make
@@ -232,39 +229,40 @@ patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatCha
232229
233230-- | Create a 'PatchMapWithPatchingMove' that, if applied to the first 'Map' provided,
234231-- will produce the second 'Map'.
232+-- Note: this will never produce a patch on a value.
235233patchThatChangesMap
236− :: (Ord k, Ord (PatchTarget p), Monoid p)
234+ :: forall k p
235+ . (Ord k, Ord (PatchTarget p), Monoid p)
237236 => Map k (PatchTarget p) -> Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
238237patchThatChangesMap oldByIndex newByIndex = patch
239− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
240− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
241− let f k v = do
242− remainingValues <- get
243− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
244− then Map.delete v remainingValues
245− else Map.insert v remainingKeys remainingValues
246− case Map.lookup v remainingValues of
247− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
248− Just fromKs ->
249− if k `Set.member` fromKs
250− then do
251− putRemainingKeys $ Set.delete k fromKs
252− return $ NodeInfo (From_Move k mempty) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
253− else do
254− (fromK, remainingKeys) <- return $
255− fromMaybe (error "PatchMapWithPatchingMove.patchThatChangesMap: impossible: fromKs was empty") $
256− Set.minView fromKs -- There's an existing value, but it's not here; move it here
257− putRemainingKeys remainingKeys
258− return $ NodeInfo (From_Move fromK mempty) $ Just undefined
259− Map.traverseWithKey f newByIndex
260− unusedOldKeys = fold unusedValuesByValue
261− pointlessMove k = \case
262− From_Move k' _ | k == k' -> True
263− _ -> False
264− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
265− then Just undefined
266− else Nothing
267− patch = unsafePatchMapWithPatchingMove $ Map.filterWithKey (\k -> not . pointlessMove k . _nodeInfo_from) $ Map.mergeWithKey (\k a _ -> Just $ nodeInfoSetTo (keyWasMoved k) a) (Map.mapWithKey $ \k -> nodeInfoSetTo $ keyWasMoved k) (Map.mapWithKey $ \k _ -> NodeInfo From_Delete $ keyWasMoved k) insertsAndMoves oldByIndex
238+ where invert :: Map k (PatchTarget p) -> Map (PatchTarget p) (Set k)
239+ invert = Map.fromListWith (<>) . fmap (\(k, v) -> (v, Set.singleton k)) . Map.toList
240+ -- In the places where we use unionDistinct, a non-distinct key indicates a bug in this function
241+ unionDistinct :: forall k' v'. Ord k' => Map k' v' -> Map k' v' -> Map k' v'
242+ unionDistinct = Map.unionWith (error "patchThatChangesMap: non-distinct keys")
243+ unionPairDistinct :: (Map k (From k v), Map k (To k)) -> (Map k (From k v), Map k (To k)) -> (Map k (From k v), Map k (To k))
244+ unionPairDistinct (oldFroms, oldTos) (newFroms, newTos) = (unionDistinct oldFroms newFroms, unionDistinct oldTos newTos)
245+ -- Generate patch info for a single value
246+ -- Keys that are found in both the old and new sets will not be patched
247+ -- Keys that are found in only the old set will be moved to a new position if any are available; otherwise they will be deleted
248+ -- Keys that are found in only the new set will be populated by moving an old key if any are available; otherwise they will be inserted
249+ patchSingleValue :: PatchTarget p -> Set k -> Set k -> (Map k (From k p), Map k (To k))
250+ patchSingleValue v oldKeys newKeys = foldl' unionPairDistinct mempty $ align (toList $ oldKeys `Set.difference` newKeys) (toList $ newKeys `Set.difference` oldKeys) <&> \case
251+ This oldK -> (mempty, Map.singleton oldK Nothing) -- There's nowhere for this value to go, so we know we are deleting it
252+ That newK -> (Map.singleton newK $ From_Insert v, mempty) -- There's nowhere fo this value to come from, so we know we are inserting it
253+ These oldK newK -> (Map.singleton newK $ From_Move oldK mempty, Map.singleton oldK $ Just newK)
254+ -- Run patchSingleValue on a These. Missing old or new sets are considered empty
255+ patchSingleValueThese :: PatchTarget p -> These (Set k) (Set k) -> (Map k (From k p), Map k (To k))
256+ patchSingleValueThese v = \case
257+ This oldKeys -> patchSingleValue v oldKeys mempty
258+ That newKeys -> patchSingleValue v mempty newKeys
259+ These oldKeys newKeys -> patchSingleValue v oldKeys newKeys
260+ -- Generate froms and tos for all values, then merge them together
261+ (froms, tos) = foldl' unionPairDistinct mempty $ Map.mapWithKey patchSingleValueThese $ align (invert oldByIndex) (invert newByIndex)
262+ patch = unsafePatchMapWithPatchingMove $ align froms tos <&> \case
263+ This from -> NodeInfo from Nothing -- Since we don't have a 'to' record for this key, that must mean it isn't being moved anywhere, so it should be deleted.
264+ That to -> NodeInfo From_Delete to -- Since we don't have a 'from' record for this key, it must be getting deleted
265+ These from to -> NodeInfo from to
268266
269267--
270268-- NodeInfo
src/Data/Semigroup/Additive.hsnew file+54
@@ -0,0 +1,54 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE TypeOperators #-}
3+{-# LANGUAGE TypeFamilies #-}
4+-- |
5+-- Module:
6+-- Data.Semigroup.Additive
7+-- Description:
8+-- This module defines a class for commutative semigroups, until it is moved
9+-- to another library.
10+module Data.Semigroup.Additive
11+ ( Additive
12+ ) where
13+
14+import Data.Functor.Const (Const (..))
15+import Data.Functor.Identity
16+import Data.Proxy
17+#if !MIN_VERSION_base(4,12,0)
18+-- for :*: and :.: semigroup instances
19+import Data.Orphans ()
20+#endif
21+#if !MIN_VERSION_base(4,11,0)
22+import Data.Semigroup (Semigroup (..))
23+#endif
24+import GHC.Generics
25+
26+-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
27+class Semigroup q => Additive q where
28+
29+-- | Trivial additive semigroup.
30+instance Additive ()
31+
32+-- | Product additive semigroup.
33+-- A Pair of additive semigroups gives rise to a additive semigroup
34+instance (Additive a, Additive b) => Additive (a, b)
35+
36+-- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
37+-- Base does not define Monoid (Compose f g a) so this is the best we can
38+-- really do for functor composition.
39+instance Additive (f (g a)) => Additive ((f :.: g) a)
40+
41+-- | Product of additive semigroups, Functor style.
42+instance (Additive (f a), Additive (g a)) => Additive ((f :*: g) a)
43+
44+-- | Trivial additive semigroup, Functor style
45+instance Additive (Proxy x)
46+
47+-- | Const lifts additive semigroups into a functor.
48+instance Additive a => Additive (Const a x)
49+
50+-- | Identity lifts additive semigroups pointwise (at only one point)
51+instance Additive a => Additive (Identity a)
52+
53+-- | Functions lift additive semigroups pointwise.
54+instance Additive b => Additive (a -> b)
test/tests.hsnew file+43
@@ -0,0 +1,43 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+module Main where
3+
4+import Test.HUnit (runTestTT, (~:), assertEqual, errors, failures, test)
5+import Data.Patch ( Patch(apply) )
6+import Data.Patch.MapWithMove ( patchThatChangesMap )
7+import Data.Map as Map ( Map, fromList, singleton )
8+import Hedgehog (checkParallel, discover, Property, property, forAll, PropertyT, (===))
9+import Hedgehog.Gen as Gen ( int )
10+import Hedgehog.Range as Range ( linear )
11+import Control.Monad (replicateM)
12+import System.Exit (exitFailure, exitSuccess)
13+import Data.Sequence as Seq ( foldMapWithIndex, replicateM )
14+
15+main :: IO ()
16+main = do
17+ counts <- runTestTT $ test [
18+ "Simple Move" ~: (do
19+ let mapBefore = Map.fromList [(0,1)]
20+ mapAfter = Map.fromList [(0,0),(1,1)]
21+ patch = patchThatChangesMap mapBefore mapAfter
22+ afterPatch = apply patch mapBefore
23+ assertEqual "Patch creates the same Map" (Just mapAfter) afterPatch),
24+ "Property Checks" ~: propertyChecks
25+ ]
26+ if errors counts + failures counts == 0 then exitSuccess else exitFailure
27+
28+propertyChecks :: IO Bool
29+propertyChecks = checkParallel $$(discover)
30+
31+prop_patchThatChangesMap :: Property
32+prop_patchThatChangesMap = property $ do
33+ mapBefore <- makeRandomIntMap
34+ mapAfter <- makeRandomIntMap
35+ let patch = patchThatChangesMap mapBefore mapAfter
36+ Just mapAfter === apply patch mapBefore
37+
38+makeRandomIntMap :: Monad m => PropertyT m (Map Int Int)
39+makeRandomIntMap = do
40+ let genNum = Gen.int (Range.linear 0 100)
41+ length <- forAll genNum
42+ listOfNumbers <- forAll $ Seq.replicateM length genNum
43+ pure $ Seq.foldMapWithIndex Map.singleton listOfNumbers