Merge branch 'develop' into patchable

Author: Ericson2314

ChangeLog.md

@@ -1,32 +1,40 @@
 # Revision history for patch
 
-## Unreleased
+## 0.0.5.1 - 2021-12-28
+
+* New dep of `data-orphans` for old GHC to get instances honestly instead of
+  via `monoidal-containers`.
+
+## 0.0.5.0 - 2021-12-17
+
+* `Additive` now lives in `Data.Semigroup.Additive`, but is still reexported
+  from `Data.Patch` for compatability.
 
 * 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
+## 0.0.4.0 - 2021-04-20
 
 * Enable PolyKinds
 
-## 0.0.3.2
+## 0.0.3.2 - 2020-11-06
 
 * Update version bounds
 
-## 0.0.3.1
+## 0.0.3.1 - 2020-02-05
 
 * Replace `fromJust` with something easier to debug.
 
-## 0.0.3.0
+## 0.0.3.0 - 2020-02-05
 
 * Create `PatchMapWithPatchingMove` variant which supports moves with a patch.
 
 * Create `DecidablyEmpty` subclass of `Monoid`.
 
-## 0.0.2.0
+## 0.0.2.0 - 2020-01-17
 
 * Consistently provide:
 
@@ -38,16 +46,16 @@
 
   for `PatchMap`, `PatchIntMap`, and `PatchMapWithMove`.
 
-## 0.0.1.0
+## 0.0.1.0 - 2020-01-09
 
 * Support older GHCs with `split-these` flag.
 
 * Additional instances for the `Group` class for basic types.
 
-## 0.0.0.1
+## 0.0.0.1 - 2020-01-08
 
 * Remove unneeded dependencies
 
-## 0.0.0.0
+## 0.0.0.0 - 2020-01-08
 
 * Extract patching functionality from Reflex.

patch.cabal

@@ -1,5 +1,5 @@
 Name: patch
-Version: 0.0.4.0
+Version: 0.0.5.1
 Synopsis: Data structures for describing changes to other data structures.
 Description:
   Data structures for describing changes to other data structures.
@@ -43,6 +43,9 @@ library
                , transformers >= 0.5.6.0 && < 0.6
                , witherable >= 0.3 && < 0.5
 
+  if impl(ghc < 8.6) -- really, if base < 8.12
+    build-depends: base-orphans >= 0.8 && < 0.9
+
   exposed-modules: Data.Functor.Misc
                  , Data.Monoid.DecidablyEmpty
                  , Data.Patch
@@ -54,6 +57,7 @@ library
                  , Data.Patch.MapWithMove
                  , Data.Patch.MapWithPatchingMove
                  , Data.Patch.Patchable
+                 , Data.Semigroup.Additive
 
   ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs
   default-extensions: PolyKinds

src/Data/Functor/Misc.hs

@@ -10,9 +10,14 @@
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE StandaloneDeriving #-}
--- | This module provides types and functions with no particular theme, but
--- which are relevant to the use of 'Functor'-based datastructures like
--- 'Data.Dependent.Map.DMap'.
+
+{- |
+Description: Misc utilities relating to functor.
+
+This module provides types and functions with no particular theme, but which
+are relevant to the use of 'Functor'-based datastructures like
+'Data.Dependent.Map.DMap'.
+-}
 module Data.Functor.Misc
   ( -- * Const2
     Const2 (..)

src/Data/Monoid/DecidablyEmpty.hs

@@ -5,6 +5,9 @@
 {-# LANGUAGE TypeOperators #-}
 
 -- TODO upstream somwhere else?
+{-|
+Description: This module provides a class to decide whether a monoid element is the identity.
+-}
 module Data.Monoid.DecidablyEmpty where
 
 import Data.Functor.Identity

src/Data/Patch.hs

@@ -3,11 +3,11 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
--- |
--- Module:
---   Data.Patch
--- Description:
---   This module defines the 'Patch' class.
+
+{-|
+Description:
+  This module defines the 'Group' class, and reexports the other modules.
+-}
 module Data.Patch
   ( module Data.Patch
   , module X
@@ -23,6 +23,7 @@ import Data.Semigroup (Semigroup (..))
 #endif
 import GHC.Generics
 
+import Data.Semigroup.Additive as X
 import Data.Patch.Class as X
 import Data.Patch.DMap as X hiding (getDeletions)
 import Data.Patch.DMapWithMove as X
@@ -45,9 +46,6 @@ class (Semigroup q, Monoid q) => Group q where
   (~~) :: q -> q -> q
   r ~~ s = r <> negateG s
 
--- | An 'Additive' 'Semigroup' is one where (<>) is commutative
-class Semigroup q => Additive q where
-
 -- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
 newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
 
@@ -58,49 +56,40 @@ instance Additive p => Patch (AdditivePatch p) where
 instance (Ord k, Group q) => Group (MonoidalMap k q) where
   negateG = fmap negateG
 
-instance (Ord k, Additive q) => Additive (MonoidalMap k q)
-
 -- | Trivial group.
 instance Group () where
   negateG _ = ()
   _ ~~ _ = ()
-instance Additive ()
 
 -- | Product group.  A Pair of groups gives rise to a group
 instance (Group a, Group b) => Group (a, b) where
   negateG (a, b) = (negateG a, negateG b)
   (a, b) ~~ (c, d) = (a ~~ c, b ~~ d)
-instance (Additive a, Additive b) => Additive (a, b)
 
 -- See https://gitlab.haskell.org/ghc/ghc/issues/11135#note_111802 for the reason Compose is not also provided.
 -- Base does not define Monoid (Compose f g a) so this is the best we can
 -- really do for functor composition.
 instance Group (f (g a)) => Group ((f :.: g) a) where
   negateG (Comp1 xs) = Comp1 (negateG xs)
   Comp1 xs ~~ Comp1 ys = Comp1 (xs ~~ ys)
-instance Additive (f (g a)) => Additive ((f :.: g) a)
 
 -- | Product of groups, Functor style.
 instance (Group (f a), Group (g a)) => Group ((f :*: g) a) where
   negateG (a :*: b) = negateG a :*: negateG b
   (a :*: b) ~~ (c :*: d) = (a ~~ c) :*: (b ~~ d)
-instance (Additive (f a), Additive (g a)) => Additive ((f :*: g) a)
 
 -- | Trivial group, Functor style
 instance Group (Proxy x) where
   negateG _ = Proxy
   _ ~~ _ = Proxy
-instance Additive (Proxy x)
 
 -- | Const lifts groups into a functor.
 deriving instance Group a => Group (Const a x)
-instance Additive a => Additive (Const a x)
+
 -- | Identity lifts groups pointwise (at only one point)
 deriving instance Group a => Group (Identity a)
-instance Additive a => Additive (Identity a)
 
 -- | Functions lift groups pointwise.
 instance Group b => Group (a -> b) where
   negateG f = negateG . f
   (~~) = liftA2 (~~)
-instance Additive b => Additive (a -> b)

src/Data/Patch/Class.hs

@@ -1,7 +1,12 @@
 {-# LANGUAGE CPP #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
--- | The interface for types which represent changes made to other types
+
+{-|
+Description: The module provides the 'Patch' class.
+
+This is a class for types which represent changes made to other types
+-}
 module Data.Patch.Class where
 
 import Data.Functor.Identity

src/Data/Patch/DMap.hs

@@ -7,7 +7,12 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | 'Patch'es on 'DMap' that consist only of insertions (or overwrites) and deletions.
+{-|
+Description: A basic 'Patch' on 'DMap'
+
+Patches of this type consist only of insertions (including overwrites) and
+deletions.
+-}
 module Data.Patch.DMap where
 
 import Data.Patch.Class

src/Data/Patch/DMapWithMove.hs

@@ -11,8 +11,13 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE UndecidableInstances #-}
 
--- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
--- move values between keys.
+{-|
+Description: A more advanced 'Patch' for 'DMap'.
+
+This Module contains @'PatchDMapWithMove' k v@ and associated functions, which
+represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
+move values between keys.
+-}
 module Data.Patch.DMapWithMove where
 
 import Data.Patch.Class

src/Data/Patch/IntMap.hs

@@ -7,8 +7,11 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | Module containing 'PatchIntMap', a 'Patch' for 'IntMap' which allows for
--- insert/update or delete of associations.
+{-|
+Description: Module containing 'PatchIntMap', a 'Patch' for 'IntMap'.
+
+Patches of this sort allow for insert/update or delete of associations.
+-}
 module Data.Patch.IntMap where
 
 import Control.Lens

src/Data/Patch/Map.hs

@@ -8,8 +8,12 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
--- and deletions
+{-|
+Description: A basic 'Patch' on 'Map'
+
+Patches of this type consist only of insertions (including overwrites) and
+deletions.
+-}
 module Data.Patch.Map where
 
 import Data.Patch.Class