Merge branch 'develop' into no-group

Author: Ericson2314

.github/workflows/haskell.yml

@@ -43,3 +43,5 @@ jobs:
       run: cabal build --enable-tests --enable-benchmarks all
     - name: Run tests
       run: cabal test all
+    - name: Build Docs
+      run: cabal haddock

ChangeLog.md

@@ -18,6 +18,14 @@
 * `Additive` now lives in `Data.Semigroup.Additive`, but is still reexported
   from `Data.Patch` for compatability.
 
+## Unreleased
+
+* Rewrite `PatchMapWithMove` in terms of `PatchMapWithPatchingMove`.
+  Care is taken to make this not a breaking change.
+  In particular, `PatchMapWithMove` is a newtype of `PatchMapWithPatchingMove`, as is the `NodeInfo` and `From` of `PatchMapWithPatchingMove`'s versions of those.
+  There are complete constructor and field patterns too, and everything is
+  exported under the newtype as real constructors and fields would be.
+
 ## 0.0.4.0
 
 * Enable PolyKinds

patch.cabal

@@ -57,6 +57,19 @@ library
   ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs
   default-extensions: PolyKinds
 
+test-suite tests
+  default-language: Haskell2010
+  type: exitcode-stdio-1.0
+  main-is: tests.hs
+  hs-source-dirs: test
+  build-depends: base
+               , patch
+               , containers
+               , hedgehog
+               , HUnit
+  if impl(ghcjs)
+    buildable: False
+
 test-suite hlint
   default-language: Haskell2010
   type: exitcode-stdio-1.0

src/Data/Patch/Class.hs

@@ -1,9 +1,11 @@
 {-# LANGUAGE CPP #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
 -- | The interface for types which represent changes made to other types
 module Data.Patch.Class where
 
 import Data.Functor.Identity
+import Data.Kind (Type)
 import Data.Maybe
 #if !MIN_VERSION_base(4,11,0)
 import Data.Semigroup (Semigroup(..))
@@ -15,7 +17,7 @@ import Data.Proxy
 -- If an instance of 'Patch' is also an instance of 'Semigroup', it should obey
 -- the law that @applyAlways (f <> g) == applyAlways f . applyAlways g@.
 class Patch p where
-  type PatchTarget p :: *
+  type PatchTarget p :: Type
   -- | Apply the patch @p a@ to the value @a@.  If no change is needed, return
   -- 'Nothing'.
   apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
@@ -30,7 +32,7 @@ instance Patch (Identity a) where
   apply (Identity a) _ = Just a
 
 -- | 'Proxy' can be used as a 'Patch' that does nothing.
-instance Patch (Proxy (a :: *)) where
+instance forall (a :: Type). Patch (Proxy a) where
   type PatchTarget (Proxy a) = a
   apply ~Proxy _ = Nothing
 

src/Data/Patch/DMapWithMove.hs

@@ -220,8 +220,8 @@ moveDMapKey src dst = case src `geq` dst of
 -- @
 --     let aMay = DMap.lookup a dmap
 --         bMay = DMap.lookup b dmap
---     in maybe id (DMap.insert a) (bMay `mplus` aMay)
---      . maybe id (DMap.insert b) (aMay `mplus` bMay)
+--     in maybe id (DMap.insert a) (bMay <> aMay)
+--      . maybe id (DMap.insert b) (aMay <> bMay)
 --      . DMap.delete a . DMap.delete b $ dmap
 -- @
 swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v