on db340cf help sign in
12 files changed+483−501
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+1−3 .travis.yml+171 ChangeLog.md+7−27 cabal.haskell-ci+14 patch.cabal+2−20 src/Data/Patch.hs+14−3 src/Data/Patch/Class.hs+2−4 src/Data/Patch/DMapWithMove.hs+2−2 src/Data/Patch/MapWithMove.hs+182−205 src/Data/Patch/MapWithPatchingMove.hs+88−140 src/Data/Semigroup/Additive.hs−54 test/tests.hs−43
.github/workflows/haskell.yml+1−3
@@ -42,6 +42,4 @@ jobs:
4242 - name: Build
4343 run: cabal build --enable-tests --enable-benchmarks all
4444 - name: Run tests
45− run: cabal test --enable-tests all
46− - name: Build Docs
47− run: cabal haddock
45+ run: cabal test all
.travis.ymlnew file+171
@@ -0,0 +1,171 @@
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+7−27
@@ -1,40 +1,20 @@
11# Revision history for patch
22
3−## Unreleased
4−
5−* New dep of `data-orphans` for old GHC to get instances honestly instead of
6− via `monoidal-containers`.
7−
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.
12−
13−* Rewrite `PatchMapWithMove` in terms of `PatchMapWithPatchingMove`.
14− Care is taken to make this not a breaking change.
15− In particular, `PatchMapWithMove` is a newtype of `PatchMapWithPatchingMove`, as is the `NodeInfo` and `From` of `PatchMapWithPatchingMove`'s versions of those.
16− There are complete constructor and field patterns too, and everything is
17− exported under the newtype as real constructors and fields would be.
18−
19−## 0.0.4.0 - 2021-04-20
20−
21−* Enable PolyKinds
22−
23−## 0.0.3.2 - 2020-11-06
3+## 0.0.3.2
244
255* Update version bounds
266
27−## 0.0.3.1 - 2020-02-05
7+## 0.0.3.1
288
299* Replace `fromJust` with something easier to debug.
3010
31−## 0.0.3.0 - 2020-02-05
11+## 0.0.3.0
3212
3313* Create `PatchMapWithPatchingMove` variant which supports moves with a patch.
3414
3515* Create `DecidablyEmpty` subclass of `Monoid`.
3616
37−## 0.0.2.0 - 2020-01-17
17+## 0.0.2.0
3818
3919* Consistently provide:
4020
@@ -46,16 +26,16 @@
4626
4727 for `PatchMap`, `PatchIntMap`, and `PatchMapWithMove`.
4828
49−## 0.0.1.0 - 2020-01-09
29+## 0.0.1.0
5030
5131* Support older GHCs with `split-these` flag.
5232
5333* Additional instances for the `Group` class for basic types.
5434
55−## 0.0.0.1 - 2020-01-08
35+## 0.0.0.1
5636
5737* Remove unneeded dependencies
5838
59−## 0.0.0.0 - 2020-01-08
39+## 0.0.0.0
6040
6141* Extract patching functionality from Reflex.
cabal.haskell-cinew file+14
@@ -0,0 +1,14 @@
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+2−20
@@ -1,5 +1,5 @@
11Name: patch
2−Version: 0.0.5.0
2+Version: 0.0.3.2
33Synopsis: Data structures for describing changes to other data structures.
44Description:
55 Data structures for describing changes to other data structures.
@@ -41,10 +41,7 @@ library
4141 , lens >= 4.7 && < 5
4242 , semigroupoids >= 4.0 && < 6
4343 , transformers >= 0.5.6.0 && < 0.6
44− , witherable >= 0.3 && < 0.5
45−
46− if impl(ghc < 8.6) -- really, if base < 8.12
47− build-depends: base-orphans >= 0.8 && < 0.9
44+ , witherable >= 0.3 && < 0.4
4845
4946 exposed-modules: Data.Functor.Misc
5047 , Data.Monoid.DecidablyEmpty
@@ -56,10 +53,8 @@ library
5653 , Data.Patch.Map
5754 , Data.Patch.MapWithMove
5855 , Data.Patch.MapWithPatchingMove
59− , Data.Semigroup.Additive
6056
6157 ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs
62− default-extensions: PolyKinds
6358
6459 if flag(split-these)
6560 build-depends: these >= 1 && <1.2
@@ -69,19 +64,6 @@ library
6964 build-depends: these >= 0.4 && <0.9
7065 , monoidal-containers == 0.4.0.0
7166
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−
8567test-suite hlint
8668 default-language: Haskell2010
8769 type: exitcode-stdio-1.0
src/Data/Patch.hs+14−3
@@ -23,7 +23,6 @@ import Data.Semigroup (Semigroup (..))
2323#endif
2424import GHC.Generics
2525
26−import Data.Semigroup.Additive as X
2726import Data.Patch.Class as X
2827import Data.Patch.DMap as X hiding (getDeletions)
2928import Data.Patch.DMapWithMove as X
@@ -46,6 +45,9 @@ class (Semigroup q, Monoid q) => Group q where
4645 (~~) :: q -> q -> q
4746 r ~~ s = r <> negateG s
4847
48+-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
49+class Semigroup q => Additive q where
50+
4951-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
5052newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
5153
@@ -56,15 +58,19 @@ instance Additive p => Patch (AdditivePatch p) where
5658instance (Ord k, Group q) => Group (MonoidalMap k q) where
5759 negateG = fmap negateG
5860
61+instance (Ord k, Additive q) => Additive (MonoidalMap k q)
62+
5963-- | Trivial group.
6064instance Group () where
6165 negateG _ = ()
6266 _ ~~ _ = ()
67+instance Additive ()
6368
6469-- | Product group. A Pair of groups gives rise to a group
6570instance (Group a, Group b) => Group (a, b) where
6671 negateG (a, b) = (negateG a, negateG b)
6772 (a, b) ~~ (c, d) = (a ~~ c, b ~~ d)
73+instance (Additive a, Additive b) => Additive (a, b)
6874
6975-- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
7076-- Base does not define Monoid (Compose f g a) so this is the best we can
@@ -72,24 +78,29 @@ instance (Group a, Group b) => Group (a, b) where
7278instance Group (f (g a)) => Group ((f :.: g) a) where
7379 negateG (Comp1 xs) = Comp1 (negateG xs)
7480 Comp1 xs ~~ Comp1 ys = Comp1 (xs ~~ ys)
81+instance Additive (f (g a)) => Additive ((f :.: g) a)
7582
7683-- | Product of groups, Functor style.
7784instance (Group (f a), Group (g a)) => Group ((f :*: g) a) where
7885 negateG (a :*: b) = negateG a :*: negateG b
7986 (a :*: b) ~~ (c :*: d) = (a ~~ c) :*: (b ~~ d)
87+instance (Additive (f a), Additive (g a)) => Additive ((f :*: g) a)
8088
8189-- | Trivial group, Functor style
8290instance Group (Proxy x) where
8391 negateG _ = Proxy
8492 _ ~~ _ = Proxy
93+instance Additive (Proxy x)
8594
8695-- | Const lifts groups into a functor.
8796deriving instance Group a => Group (Const a x)
88−
89−-- | Identity lifts groups pointwise (at only one point)
97+instance Additive a => Additive (Const a x)
98+-- | Ideitnty lifts groups pointwise (at only one point)
9099deriving instance Group a => Group (Identity a)
100+instance Additive a => Additive (Identity a)
91101
92102-- | Functions lift groups pointwise.
93103instance Group b => Group (a -> b) where
94104 negateG f = negateG . f
95105 (~~) = liftA2 (~~)
106+instance Additive b => Additive (a -> b)
src/Data/Patch/Class.hs+2−4
@@ -1,11 +1,9 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
32{-# LANGUAGE TypeFamilies #-}
43-- | The interface for types which represent changes made to other types
54module Data.Patch.Class where
65
76import Data.Functor.Identity
8−import Data.Kind (Type)
97import Data.Maybe
108#if !MIN_VERSION_base(4,11,0)
119import Data.Semigroup (Semigroup(..))
@@ -17,7 +15,7 @@ import Data.Proxy
1715-- If an instance of 'Patch' is also an instance of 'Semigroup', it should obey
1816-- the law that @applyAlways (f <> g) == applyAlways f . applyAlways g@.
1917class Patch p where
20− type PatchTarget p :: Type
18+ type PatchTarget p :: *
2119 -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
2220 -- 'Nothing'.
2321 apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
@@ -32,7 +30,7 @@ instance Patch (Identity a) where
3230 apply (Identity a) _ = Just a
3331
3432-- | 'Proxy' can be used as a 'Patch' that does nothing.
35−instance forall (a :: Type). Patch (Proxy a) where
33+instance Patch (Proxy a) where
3634 type PatchTarget (Proxy a) = a
3735 apply ~Proxy _ = Nothing
3836
src/Data/Patch/DMapWithMove.hs+2−2
@@ -220,8 +220,8 @@ moveDMapKey src dst = case src `geq` dst of
220220-- @
221221-- let aMay = DMap.lookup a dmap
222222-- bMay = DMap.lookup b dmap
223−-- in maybe id (DMap.insert a) (bMay <> aMay)
224−-- . maybe id (DMap.insert b) (aMay <> bMay)
223+-- in maybe id (DMap.insert a) (bMay `mplus` aMay)
224+-- . maybe id (DMap.insert b) (aMay `mplus` bMay)
225225-- . DMap.delete a . DMap.delete b $ dmap
226226-- @
227227swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
src/Data/Patch/MapWithMove.hs+182−205
@@ -2,150 +2,98 @@
22{-# LANGUAGE DeriveTraversable #-}
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
65{-# LANGUAGE LambdaCase #-}
76{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE PatternGuards #-}
9−{-# LANGUAGE PatternSynonyms #-}
108{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE StandaloneDeriving #-}
129{-# LANGUAGE TemplateHaskell #-}
1310{-# LANGUAGE TypeApplications #-}
1411{-# LANGUAGE TypeFamilies #-}
15−{-# LANGUAGE ViewPatterns #-}
1612
1713-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
1814-- another
19−module Data.Patch.MapWithMove
20− ( PatchMapWithMove
21− ( PatchMapWithMove
22− , unPatchMapWithMove
23− , ..
24− )
25− , patchMapWithMove
26− , patchMapWithMoveInsertAll
27− , insertMapKey
28− , moveMapKey
29− , swapMapKey
30− , deleteMapKey
31− , unsafePatchMapWithMove
32− , patchMapWithMoveNewElements
33− , patchMapWithMoveNewElementsMap
34− , patchThatSortsMapWith
35− , patchThatChangesAndSortsMapWith
36− , patchThatChangesMap
15+module Data.Patch.MapWithMove where
3716
38− -- * Node Info
39− , NodeInfo
40− ( NodeInfo
41− , _nodeInfo_to
42− , _nodeInfo_from
43− , ..
44− )
45− , bitraverseNodeInfo
46− , nodeInfoMapFrom
47− , nodeInfoMapMFrom
48− , nodeInfoSetTo
49−
50− -- * From
51− , From
52− ( From_Insert
53− , From_Delete
54− , From_Move
55− , ..
56− )
57− , bitraverseFrom
58−
59− -- * To
60− , To
61− ) where
62−
63−import Data.Coerce
64−import Data.Kind (Type)
6517import Data.Patch.Class
66−import Data.Patch.MapWithPatchingMove (PatchMapWithPatchingMove(..), To)
67−import qualified Data.Patch.MapWithPatchingMove as PM -- already a transparent synonym
6818
69−import Control.Lens
19+import Control.Arrow
20+import Control.Lens hiding (from, to)
21+import Control.Monad.Trans.State
22+import Data.Foldable
23+import Data.Function
7024import Data.List
7125import Data.Map (Map)
7226import qualified Data.Map as Map
73−import Data.Proxy
27+import Data.Maybe
7428#if !MIN_VERSION_base(4,11,0)
7529import Data.Semigroup (Semigroup (..))
7630#endif
77−import Data.Traversable (foldMapDefault)
31+import qualified Data.Set as Set
32+import Data.These (These(..))
33+import Data.Tuple
7834
7935-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
8036-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
8137-- and vice versa. There should never be any unpaired From/To keys.
82−newtype PatchMapWithMove k (v :: Type) = PatchMapWithMove'
83− { -- | Extract the underlying 'PatchMapWithPatchingMove k (Proxy v)'
84− unPatchMapWithMove' :: PatchMapWithPatchingMove k (Proxy v)
38+newtype PatchMapWithMove k v = PatchMapWithMove
39+ { -- | Extract the internal representation of the 'PatchMapWithMove'
40+ unPatchMapWithMove :: Map k (NodeInfo k v)
8541 }
8642 deriving ( Show, Read, Eq, Ord
87−-- Haddock cannot handle documentation here before GHC 8.6
88− ,
89−#if __GLASGOW_HASKELL__ >= 806
90− -- | Compose patches having the same effect as applying the
91− -- patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p .
92− -- 'applyAlways' q@
93−#endif
94− Semigroup
95− , Monoid
43+ , Functor, Foldable, Traversable
9644 )
9745
98−pattern Coerce :: Coercible a b => a -> b
99−pattern Coerce x <- (coerce -> x)
100− where Coerce x = coerce x
101−
102−{-# COMPLETE PatchMapWithMove #-}
103−pattern PatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
104−-- | Extract the representation of the 'PatchMapWithMove' as a map of
105−-- 'NodeInfo'.
106−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
107−pattern PatchMapWithMove { unPatchMapWithMove } = PatchMapWithMove' (PatchMapWithPatchingMove (Coerce unPatchMapWithMove))
108−
109−_PatchMapWithMove
110− :: Iso
111− (PatchMapWithMove k0 v0)
112− (PatchMapWithMove k1 v1)
113− (Map k0 (NodeInfo k0 v0))
114− (Map k1 (NodeInfo k1 v1))
115−_PatchMapWithMove = iso unPatchMapWithMove PatchMapWithMove
46+-- | Holds the information about each key: where its new value should come from,
47+-- and where its old value should go to
48+data NodeInfo k v = NodeInfo
49+ { _nodeInfo_from :: !(From k v)
50+ -- ^ Where do we get the new value for this key?
51+ , _nodeInfo_to :: !(To k)
52+ -- ^ If the old value is being kept (i.e. moved rather than deleted or
53+ -- replaced), where is it going?
54+ }
55+ deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
11656
117−instance Functor (PatchMapWithMove k) where
118− fmap f = runIdentity . traverse (Identity . f)
57+-- | Describe how a key's new value should be produced
58+data From k v
59+ = From_Insert v -- ^ Insert the given value here
60+ | From_Delete -- ^ Delete the existing value, if any, from here
61+ | From_Move !k -- ^ Move the value here from the given key
62+ deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
11963
120−instance Foldable (PatchMapWithMove k) where
121− foldMap = foldMapDefault
64+-- | Describe where a key's old value will go. If this is 'Just', that means
65+-- the key's old value will be moved to the given other key; if it is 'Nothing',
66+-- that means it will be deleted.
67+type To = Maybe
12268
123−instance Traversable (PatchMapWithMove k) where
124− traverse =
125− _PatchMapWithMove .
126− traverse .
127− traverse
69+makeWrapped ''PatchMapWithMove
12870
12971instance FunctorWithIndex k (PatchMapWithMove k)
13072instance FoldableWithIndex k (PatchMapWithMove k)
13173instance TraversableWithIndex k (PatchMapWithMove k) where
13274 itraverse = itraversed . Indexed
133− itraversed =
134− _PatchMapWithMove .>
135− itraversed <.
136− traverse
75+ itraversed = _Wrapped .> itraversed <. traversed
13776
13877-- | Create a 'PatchMapWithMove', validating it
13978patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
140−patchMapWithMove = fmap PatchMapWithMove' . PM.patchMapWithPatchingMove . coerce
79+patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
80+ where valid = forwardLinks == backwardLinks
81+ forwardLinks = Map.mapMaybe _nodeInfo_to m
82+ backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
83+ case _nodeInfo_from v of
84+ From_Move from -> Just (from, to)
85+ _ -> Nothing
14186
14287-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
14388patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
144−patchMapWithMoveInsertAll = PatchMapWithMove' . PM.patchMapWithPatchingMoveInsertAll
89+patchMapWithMoveInsertAll m = PatchMapWithMove $ flip fmap m $ \v -> NodeInfo
90+ { _nodeInfo_from = From_Insert v
91+ , _nodeInfo_to = Nothing
92+ }
14593
14694-- | Make a @'PatchMapWithMove' k v@ which has the effect of inserting or updating a value @v@ to the given key @k@, like 'Map.insert'.
14795insertMapKey :: k -> v -> PatchMapWithMove k v
148−insertMapKey k v = PatchMapWithMove' $ PM.insertMapKey k v
96+insertMapKey k v = PatchMapWithMove . Map.singleton k $ NodeInfo (From_Insert v) Nothing
14997
15098-- |Make a @'PatchMapWithMove' k v@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
15199--
@@ -153,53 +101,84 @@ insertMapKey k v = PatchMapWithMove' $ PM.insertMapKey k v
153101-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
154102-- @
155103moveMapKey :: Ord k => k -> k -> PatchMapWithMove k v
156−moveMapKey src dst = PatchMapWithMove' $ PM.moveMapKey src dst
104+moveMapKey src dst
105+ | src == dst = mempty
106+ | otherwise =
107+ PatchMapWithMove $ Map.fromList
108+ [ (dst, NodeInfo (From_Move src) Nothing)
109+ , (src, NodeInfo From_Delete (Just dst))
110+ ]
157111
158112-- |Make a @'PatchMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
159113--
160114-- @
161115-- let aMay = Map.lookup a map
162116-- bMay = Map.lookup b map
163−-- in maybe id (Map.insert a) (bMay <> aMay)
164−-- . maybe id (Map.insert b) (aMay <> bMay)
117+-- in maybe id (Map.insert a) (bMay `mplus` aMay)
118+-- . maybe id (Map.insert b) (aMay `mplus` bMay)
165119-- . Map.delete a . Map.delete b $ map
166120-- @
167121swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
168−swapMapKey src dst = PatchMapWithMove' $ PM.swapMapKey src dst
122+swapMapKey src dst
123+ | src == dst = mempty
124+ | otherwise =
125+ PatchMapWithMove $ Map.fromList
126+ [ (dst, NodeInfo (From_Move src) (Just src))
127+ , (src, NodeInfo (From_Move dst) (Just dst))
128+ ]
169129
170130-- |Make a @'PatchMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'Map.delete'.
171131deleteMapKey :: k -> PatchMapWithMove k v
172−deleteMapKey = PatchMapWithMove' . PM.deleteMapKey
132+deleteMapKey k = PatchMapWithMove . Map.singleton k $ NodeInfo From_Delete Nothing
173133
174134-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithMove' k v@, without checking any invariants.
175135--
176136-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
177137unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
178−unsafePatchMapWithMove = coerce PM.unsafePatchMapWithPatchingMove
138+unsafePatchMapWithMove = PatchMapWithMove
179139
180140-- | Apply the insertions, deletions, and moves to a given 'Map'
181141instance Ord k => Patch (PatchMapWithMove k v) where
182142 type PatchTarget (PatchMapWithMove k v) = Map k v
183− apply (PatchMapWithMove' p) = apply p
143+ apply (PatchMapWithMove 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?
144+ where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
145+ From_Insert v -> Just v
146+ From_Move k -> Map.lookup k old
147+ From_Delete -> Nothing
148+ deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
149+ From_Delete -> Just ()
150+ _ -> Nothing
184151
185152-- | Returns all the new elements that will be added to the 'Map'.
186153patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
187−patchMapWithMoveNewElements = PM.patchMapWithPatchingMoveNewElements . unPatchMapWithMove'
154+patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
188155
189156-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithMove' k v@.
190157patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
191−patchMapWithMoveNewElementsMap = PM.patchMapWithPatchingMoveNewElementsMap . unPatchMapWithMove'
158+patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
159+ where f ni = case _nodeInfo_from ni of
160+ From_Insert v -> Just v
161+ From_Move _ -> Nothing
162+ From_Delete -> Nothing
192163
193164-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
194165-- its values using the given ordering function. The set keys of the 'Map' is
195166-- not changed.
196167patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
197−patchThatSortsMapWith cmp = PatchMapWithMove' . PM.patchThatSortsMapWith cmp
168+patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
169+ where unsorted = Map.toList m
170+ sorted = sortBy (cmp `on` snd) unsorted
171+ f (to, _) (from, _) = if to == from then Nothing else
172+ Just (from, to)
173+ reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
174+ g (to, _) (from, _) = if to == from then Nothing else
175+ let Just movingTo = Map.lookup to reverseMapping
176+ in Just (to, NodeInfo (From_Move from) $ Just movingTo)
198177
199178-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
200179-- will produce a 'Map' with the same values as the second 'Map' but with the
201180-- values sorted with the given ordering function.
202−patchThatChangesAndSortsMapWith :: (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
181+patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
203182patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
204183 where newList = Map.toList newByIndexUnsorted
205184 newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
@@ -207,106 +186,104 @@ patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatCha
207186-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
208187-- will produce the second 'Map'.
209188patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
210−patchThatChangesMap oldByIndex newByIndex = PatchMapWithMove' $
211− PM.patchThatChangesMap oldByIndex newByIndex
212−
213−--
214−-- NodeInfo
215−--
216−
217−-- | Holds the information about each key: where its new value should come from,
218−-- and where its old value should go to
219−newtype NodeInfo k (v :: Type) = NodeInfo' { unNodeInfo' :: PM.NodeInfo k (Proxy v) }
220−
221−deriving instance (Show k, Show p) => Show (NodeInfo k p)
222−deriving instance (Read k, Read p) => Read (NodeInfo k p)
223−deriving instance (Eq k, Eq p) => Eq (NodeInfo k p)
224−deriving instance (Ord k, Ord p) => Ord (NodeInfo k p)
225−
226−{-# COMPLETE NodeInfo #-}
227−pattern NodeInfo :: To k -> From k v -> NodeInfo k v
228−_nodeInfo_to :: NodeInfo k v -> To k
229−_nodeInfo_from :: NodeInfo k v -> From k v
230−pattern NodeInfo { _nodeInfo_to, _nodeInfo_from } = NodeInfo'
231− PM.NodeInfo
232− { PM._nodeInfo_to = _nodeInfo_to
233− , PM._nodeInfo_from = Coerce _nodeInfo_from
234− }
235−
236−_NodeInfo
237− :: Iso
238− (NodeInfo k0 v0)
239− (NodeInfo k1 v1)
240− (PM.NodeInfo k0 (Proxy v0))
241− (PM.NodeInfo k1 (Proxy v1))
242−_NodeInfo = iso unNodeInfo' NodeInfo'
243−
244−instance Functor (NodeInfo k) where
245− fmap f = runIdentity . traverse (Identity . f)
246−
247−instance Foldable (NodeInfo k) where
248− foldMap = foldMapDefault
249−
250−instance Traversable (NodeInfo k) where
251− traverse = bitraverseNodeInfo pure
252−
253−bitraverseNodeInfo
254− :: Applicative f
255− => (k0 -> f k1)
256− -> (v0 -> f v1)
257− -> NodeInfo k0 v0 -> f (NodeInfo k1 v1)
258−bitraverseNodeInfo fk fv = fmap NodeInfo'
259− . PM.bitraverseNodeInfo fk (\ ~Proxy -> pure Proxy) fv
260− . coerce
189+patchThatChangesMap oldByIndex newByIndex = patch
190+ where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
191+ (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
192+ let f k v = do
193+ remainingValues <- get
194+ let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
195+ then Map.delete v remainingValues
196+ else Map.insert v remainingKeys remainingValues
197+ case Map.lookup v remainingValues of
198+ Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
199+ Just fromKs ->
200+ if k `Set.member` fromKs
201+ then do
202+ putRemainingKeys $ Set.delete k fromKs
203+ return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
204+ else do
205+ (fromK, remainingKeys) <- return $
206+ fromMaybe (error "PatchMapWithMove.patchThatChangesMap: impossible: fromKs was empty") $
207+ Set.minView fromKs -- There's an existing value, but it's not here; move it here
208+ putRemainingKeys remainingKeys
209+ return $ NodeInfo (From_Move fromK) $ Just undefined
210+ Map.traverseWithKey f newByIndex
211+ unusedOldKeys = fold unusedValuesByValue
212+ pointlessMove k = \case
213+ From_Move k' | k == k' -> True
214+ _ -> False
215+ keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
216+ then Just undefined
217+ else Nothing
218+ patch = unsafePatchMapWithMove $ 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
261219
262220-- | Change the 'From' value of a 'NodeInfo'
263221nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
264−nodeInfoMapFrom f = coerce $ PM.nodeInfoMapFrom (unFrom' . f . From')
222+nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
265223
266224-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
267225-- 'Applicative', 'Monad', etc.) action to get the new value
268−nodeInfoMapMFrom
269− :: Functor f
270− => (From k v -> f (From k v))
271− -> NodeInfo k v -> f (NodeInfo k v)
272−nodeInfoMapMFrom f = fmap NodeInfo'
273− . PM.nodeInfoMapMFrom (fmap unFrom' . f . From')
274− . coerce
226+nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
227+nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
275228
276229-- | Set the 'To' field of a 'NodeInfo'
277230nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
278−nodeInfoSetTo = coerce . PM.nodeInfoSetTo
279−
280−--
281−-- From
282−--
283−
284−-- | Describe how a key's new value should be produced
285−newtype From k (v :: Type) = From' { unFrom' :: PM.From k (Proxy v) }
286−
287−{-# COMPLETE From_Insert, From_Delete, From_Move #-}
288−
289−-- | Insert the given value here
290−pattern From_Insert :: v -> From k v
291−pattern From_Insert v = From' (PM.From_Insert v)
292−
293−-- | Delete the existing value, if any, from here
294−pattern From_Delete :: From k v
295−pattern From_Delete = From' PM.From_Delete
296−
297−-- | Move the value here from the given key
298−pattern From_Move :: k -> From k v
299−pattern From_Move k = From' (PM.From_Move k Proxy)
300−
301−bitraverseFrom
302− :: Applicative f
303− => (k0 -> f k1)
304− -> (v0 -> f v1)
305− -> From k0 v0 -> f (From k1 v1)
306−bitraverseFrom fk fv = fmap From'
307− . PM.bitraverseFrom fk (\ ~Proxy -> pure Proxy) fv
308− . coerce
309−
310−makeWrapped ''PatchMapWithMove
311−makeWrapped ''NodeInfo
312−makeWrapped ''From
231+nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
232+
233+-- |Helper data structure used for composing patches using the monoid instance.
234+data Fixup k v
235+ = Fixup_Delete
236+ | Fixup_Update (These (From k v) (To k))
237+
238+-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
239+instance Ord k => Semigroup (PatchMapWithMove k v) where
240+ PatchMapWithMove ma <> PatchMapWithMove mb = PatchMapWithMove m
241+ where
242+ connections = Map.toList $ Map.intersectionWithKey (\_ a b -> (_nodeInfo_to a, _nodeInfo_from b)) ma mb
243+ h :: (k, (Maybe k, From k v)) -> [(k, Fixup k v)]
244+ h (_, (mToAfter, editBefore)) = case (mToAfter, editBefore) of
245+ (Just toAfter, From_Move fromBefore)
246+ | fromBefore == toAfter
247+ -> [(toAfter, Fixup_Delete)]
248+ | otherwise
249+ -> [ (toAfter, Fixup_Update (This editBefore))
250+ , (fromBefore, Fixup_Update (That mToAfter))
251+ ]
252+ (Nothing, From_Move fromBefore) -> [(fromBefore, Fixup_Update (That mToAfter))] -- The item is destroyed in the second patch, so indicate that it is destroyed in the source map
253+ (Just toAfter, _) -> [(toAfter, Fixup_Update (This editBefore))]
254+ (Nothing, _) -> []
255+ mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
256+ mergeFixups _ (Fixup_Update a) (Fixup_Update b)
257+ | This x <- a, That y <- b
258+ = Fixup_Update $ These x y
259+ | That y <- a, This x <- b
260+ = Fixup_Update $ These x y
261+ mergeFixups _ _ _ = error "PatchMapWithMove: incompatible fixups"
262+ fixups = Map.fromListWithKey mergeFixups $ concatMap h connections
263+ combineNodeInfos _ nia nib = NodeInfo
264+ { _nodeInfo_from = _nodeInfo_from nia
265+ , _nodeInfo_to = _nodeInfo_to nib
266+ }
267+ applyFixup _ ni = \case
268+ Fixup_Delete -> Nothing
269+ Fixup_Update u -> Just $ NodeInfo
270+ { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
271+ , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
272+ }
273+ m = Map.differenceWithKey applyFixup (Map.unionWithKey combineNodeInfos ma mb) fixups
274+ getHere :: These a b -> Maybe a
275+ getHere = \case
276+ This a -> Just a
277+ These a _ -> Just a
278+ That _ -> Nothing
279+ getThere :: These a b -> Maybe b
280+ getThere = \case
281+ This _ -> Nothing
282+ These _ b -> Just b
283+ That b -> Just b
284+
285+--TODO: Figure out how to implement this in terms of PatchDMapWithMove rather than duplicating it here
286+-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
287+instance Ord k => Monoid (PatchMapWithMove k v) where
288+ mempty = PatchMapWithMove mempty
289+ mappend = (<>)
src/Data/Patch/MapWithPatchingMove.hs+88−140
@@ -13,45 +13,14 @@
1313
1414-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
1515-- another
16−module Data.Patch.MapWithPatchingMove
17− ( PatchMapWithPatchingMove (..)
18− , patchMapWithPatchingMove
19− , patchMapWithPatchingMoveInsertAll
20− , insertMapKey
21− , moveMapKey
22− , swapMapKey
23− , deleteMapKey
24− , unsafePatchMapWithPatchingMove
25− , patchMapWithPatchingMoveNewElements
26− , patchMapWithPatchingMoveNewElementsMap
27− , patchThatSortsMapWith
28− , patchThatChangesAndSortsMapWith
29− , patchThatChangesMap
30−
31− -- * Node Info
32− , NodeInfo (..)
33− , bitraverseNodeInfo
34− , nodeInfoMapFrom
35− , nodeInfoMapMFrom
36− , nodeInfoSetTo
37−
38− -- * From
39− , From(..)
40− , bitraverseFrom
41−
42− -- * To
43− , To
44−
45− -- TODO internals module
46− , Fixup (..)
47− ) where
16+module Data.Patch.MapWithPatchingMove where
4817
4918import Data.Patch.Class
5019
51−import Control.Lens hiding (from, to)
20+import Control.Arrow
5221import Control.Lens.TH (makeWrapped)
53−import Data.Align (align)
54−import Data.Foldable (toList)
22+import Control.Monad.Trans.State
23+import Data.Foldable
5524import Data.Function
5625import Data.List
5726import Data.Map (Map)
@@ -61,9 +30,9 @@ import Data.Maybe
6130import Data.Semigroup (Semigroup (..))
6231#endif
6332import Data.Monoid.DecidablyEmpty
64−import Data.Set (Set)
6533import qualified Data.Set as Set
6634import Data.These (These (..))
35+import Data.Tuple
6736
6837-- | Patch a Map with additions, deletions, and moves. Invariant: If key @k1@
6938-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
@@ -86,6 +55,57 @@ deriving instance ( Ord k
8655 , Patch p
8756 ) => DecidablyEmpty (PatchMapWithPatchingMove k p)
8857
58+-- | Holds the information about each key: where its new value should come from,
59+-- and where its old value should go to
60+data NodeInfo k p = NodeInfo
61+ { _nodeInfo_from :: !(From k p)
62+ -- ^ Where do we get the new value for this key?
63+ , _nodeInfo_to :: !(To k)
64+ -- ^ If the old value is being kept (i.e. moved rather than deleted or
65+ -- replaced), where is it going?
66+ }
67+deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (NodeInfo k p)
68+deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (NodeInfo k p)
69+deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (NodeInfo k p)
70+deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (NodeInfo k p)
71+
72+bitraverseNodeInfo
73+ :: Applicative f
74+ => (k0 -> f k1)
75+ -> (p0 -> f p1)
76+ -> (PatchTarget p0 -> f (PatchTarget p1))
77+ -> NodeInfo k0 p0 -> f (NodeInfo k1 p1)
78+bitraverseNodeInfo fk fp fpt (NodeInfo from to) = NodeInfo
79+ <$> bitraverseFrom fk fp fpt from
80+ <*> traverse fk to
81+
82+-- | Describe how a key's new value should be produced
83+data From k p
84+ = From_Insert (PatchTarget p) -- ^ Insert the given value here
85+ | From_Delete -- ^ Delete the existing value, if any, from here
86+ | From_Move !k !p -- ^ Move the value here from the given key, and apply the given patch
87+
88+bitraverseFrom
89+ :: Applicative f
90+ => (k0 -> f k1)
91+ -> (p0 -> f p1)
92+ -> (PatchTarget p0 -> f (PatchTarget p1))
93+ -> From k0 p0 -> f (From k1 p1)
94+bitraverseFrom fk fp fpt = \case
95+ From_Insert pt -> From_Insert <$> fpt pt
96+ From_Delete -> pure From_Delete
97+ From_Move k p -> From_Move <$> fk k <*> fp p
98+
99+deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (From k p)
100+deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (From k p)
101+deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (From k p)
102+deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (From k p)
103+
104+-- | Describe where a key's old value will go. If this is 'Just', that means
105+-- the key's old value will be moved to the given other key; if it is 'Nothing',
106+-- that means it will be deleted.
107+type To = Maybe
108+
89109-- | Create a 'PatchMapWithPatchingMove', validating it
90110patchMapWithPatchingMove
91111 :: Ord k => Map k (NodeInfo k p) -> Maybe (PatchMapWithPatchingMove k p)
@@ -136,8 +156,8 @@ moveMapKey src dst
136156-- @
137157-- let aMay = Map.lookup a map
138158-- bMay = Map.lookup b map
139−-- in maybe id (Map.insert a) (bMay <> aMay)
140−-- . maybe id (Map.insert b) (aMay <> bMay)
159+-- in maybe id (Map.insert a) (bMay `mplus` aMay)
160+-- . maybe id (Map.insert b) (aMay `mplus` bMay)
141161-- . Map.delete a . Map.delete b $ map
142162-- @
143163swapMapKey
@@ -229,70 +249,39 @@ patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatCha
229249
230250-- | Create a 'PatchMapWithPatchingMove' that, if applied to the first 'Map' provided,
231251-- will produce the second 'Map'.
232−-- Note: this will never produce a patch on a value.
233252patchThatChangesMap
234− :: forall k p
235− . (Ord k, Ord (PatchTarget p), Monoid p)
253+ :: (Ord k, Ord (PatchTarget p), Monoid p)
236254 => Map k (PatchTarget p) -> Map k (PatchTarget p) -> PatchMapWithPatchingMove k p
237255patchThatChangesMap oldByIndex newByIndex = patch
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
266−
267−--
268−-- NodeInfo
269−--
270−
271−-- | Holds the information about each key: where its new value should come from,
272−-- and where its old value should go to
273−data NodeInfo k p = NodeInfo
274− { _nodeInfo_from :: !(From k p)
275− -- ^ Where do we get the new value for this key?
276− , _nodeInfo_to :: !(To k)
277− -- ^ If the old value is being kept (i.e. moved rather than deleted or
278− -- replaced), where is it going?
279− }
280−deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (NodeInfo k p)
281−deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (NodeInfo k p)
282−deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (NodeInfo k p)
283−deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (NodeInfo k p)
284−
285−-- | Traverse the 'NodeInfo' over the key, patch, and patch target. Because of
286−-- the type families here, this doesn't it any bi- or tri-traversal class.
287−bitraverseNodeInfo
288− :: Applicative f
289− => (k0 -> f k1)
290− -> (p0 -> f p1)
291− -> (PatchTarget p0 -> f (PatchTarget p1))
292− -> NodeInfo k0 p0 -> f (NodeInfo k1 p1)
293−bitraverseNodeInfo fk fp fpt (NodeInfo from to) = NodeInfo
294− <$> bitraverseFrom fk fp fpt from
295− <*> traverse fk to
256+ where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
257+ (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
258+ let f k v = do
259+ remainingValues <- get
260+ let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
261+ then Map.delete v remainingValues
262+ else Map.insert v remainingKeys remainingValues
263+ case Map.lookup v remainingValues of
264+ Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
265+ Just fromKs ->
266+ if k `Set.member` fromKs
267+ then do
268+ putRemainingKeys $ Set.delete k fromKs
269+ return $ NodeInfo (From_Move k mempty) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
270+ else do
271+ (fromK, remainingKeys) <- return $
272+ fromMaybe (error "PatchMapWithPatchingMove.patchThatChangesMap: impossible: fromKs was empty") $
273+ Set.minView fromKs -- There's an existing value, but it's not here; move it here
274+ putRemainingKeys remainingKeys
275+ return $ NodeInfo (From_Move fromK mempty) $ Just undefined
276+ Map.traverseWithKey f newByIndex
277+ unusedOldKeys = fold unusedValuesByValue
278+ pointlessMove k = \case
279+ From_Move k' _ | k == k' -> True
280+ _ -> False
281+ keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
282+ then Just undefined
283+ else Nothing
284+ 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
296285
297286-- | Change the 'From' value of a 'NodeInfo'
298287nodeInfoMapFrom
@@ -310,47 +299,6 @@ nodeInfoSetTo
310299 :: To k -> NodeInfo k v -> NodeInfo k v
311300nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
312301
313−--
314−-- From
315−--
316−
317−-- | Describe how a key's new value should be produced
318−data From k p
319− = From_Insert (PatchTarget p) -- ^ Insert the given value here
320− | From_Delete -- ^ Delete the existing value, if any, from here
321− | From_Move !k !p -- ^ Move the value here from the given key, and apply the given patch
322−
323−deriving instance (Show k, Show p, Show (PatchTarget p)) => Show (From k p)
324−deriving instance (Read k, Read p, Read (PatchTarget p)) => Read (From k p)
325−deriving instance (Eq k, Eq p, Eq (PatchTarget p)) => Eq (From k p)
326−deriving instance (Ord k, Ord p, Ord (PatchTarget p)) => Ord (From k p)
327−
328−-- | Traverse the 'From' over the key, patch, and patch target. Because of
329−-- the type families here, this doesn't it any bi- or tri-traversal class.
330−bitraverseFrom
331− :: Applicative f
332− => (k0 -> f k1)
333− -> (p0 -> f p1)
334− -> (PatchTarget p0 -> f (PatchTarget p1))
335− -> From k0 p0 -> f (From k1 p1)
336−bitraverseFrom fk fp fpt = \case
337− From_Insert pt -> From_Insert <$> fpt pt
338− From_Delete -> pure From_Delete
339− From_Move k p -> From_Move <$> fk k <*> fp p
340−
341−--
342−-- To
343−--
344−
345−-- | Describe where a key's old value will go. If this is 'Just', that means
346−-- the key's old value will be moved to the given other key; if it is 'Nothing',
347−-- that means it will be deleted.
348−type To = Maybe
349−
350−--
351−-- Fixup
352−--
353−
354302-- | Helper data structure used for composing patches using the monoid instance.
355303data Fixup k v
356304 = Fixup_Delete
src/Data/Semigroup/Additive.hsdeleted−54
@@ -1,54 +0,0 @@
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.hsdeleted−43
@@ -1,43 +0,0 @@
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