wrapped (empty) → 0.1.0.0

raw patch · 4 files changed

+461/−0 lines, 4 filesdep +base

Dependencies added: base

Files

• CHANGELOG.md +3/−0
• LICENSE +202/−0
• src/Data/Wrapped.hs +213/−0
• wrapped.cabal +43/−0

@@ -0,0 +1,3 @@+# 0.1.0.0++Initial version.

@@ -0,0 +1,202 @@++                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright [yyyy] [name of copyright owner]++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

@@ -0,0 +1,213 @@+-- Copyright 2019-2021 Google LLC+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--      http://www.apache.org/licenses/LICENSE-2.0+--+-- Unless required by applicable law or agreed to in writing, software+-- distributed under the License is distributed on an "AS IS" BASIS,+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+-- See the License for the specific language governing permissions and+-- limitations under the License.++-- | Provides 'Wrapped' and 'Wrapped1' types to hold @DerivingVia@ instances.++{-# LANGUAGE DerivingVia #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE PolyKinds #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE StandaloneDeriving #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE UndecidableInstances #-}++module Data.Wrapped+         ( -- * Derived Instances+           Wrapped(..), Wrapped1(..)+           -- ** Wrapped 'Generic'+           -- $Wrapped_Generic+         , GSemigroup(..), GMonoid(..)+           -- ** Wrapped 'IsList'+           -- $Wrapped_IsList+           -- ** Wrapped 'Foldable'+           -- $Wrapped_Foldable+         ) where++import Control.Applicative (liftA2)+import qualified Data.Foldable as F (toList)+import Data.Function (on)+import Data.Kind (Constraint, Type)+import GHC.Exts (IsList(Item))+import qualified GHC.Exts as Exts (IsList(..))+import GHC.Generics+         ( Generic(..), Generic1(..)+         , M1(..), (:*:)(..), U1(..), K1(..)+         )+import Text.Read (Read(..), readListPrecDefault)++-- | A type holding derived instances for classes of kind @Type -> Constraint@.+--+-- For example, 'Show' or @Pretty@.+--+-- Generally, instances derived from @SomeClass@ should be placed on+-- @'Wrapped' SomeClass@.  This way, they can be grouped into relatively few+-- deriving clauses per type.+newtype Wrapped (c :: Type -> Constraint) a = Wrapped { unWrapped :: a }++-- | A type holding derived instances of kind @(k -> Type) -> Constraint@.+--+-- For example, 'Functor' or 'Traversable'.+--+-- See also 'Wrapped'.+newtype Wrapped1 (c :: (k -> Type) -> Constraint) f (a :: k) =+  Wrapped1 { unWrapped1 :: f a }++-- $Wrapped_Generic+--+-- Instances of @'Wrapped' 'Generic'@ work on 'Rep' types by 'to' and 'from'.+--+-- Typically these implement the "obvious" way to make a sum-of-products type+-- (an algebraic data type) an instance of the given class.  For example, for+-- 'Monoid', it provides field-wise 'mappend' and 'mempty' of types that are+-- products of other 'Monoid's.+--+-- Likewise, @'Wrapped1' 'GHC.Generics.Generic1'@ works on 'GHC.Generics.Rep1'+-- types by 'GHC.Generics.to1' and 'GHC.Generics.from1'.  This is the same+-- concept applied to type constructors with one parameter.++-- | Generic Semigroup.+--+-- Exported just to give Haddock something to link to; use @Wrapped Generic@+-- with @-XDerivingVia@ instead.+class GSemigroup f where+  gsop :: f x -> f x -> f x++instance GSemigroup U1 where+  gsop = const $ const U1++instance GSemigroup a => GSemigroup (M1 i c a) where+  M1 a `gsop` M1 b = M1 $ a `gsop` b++instance (GSemigroup f, GSemigroup g) => GSemigroup (f :*: g) where+  (fa :*: ga) `gsop` (fb :*: gb) = (fa `gsop` fb) :*: (ga `gsop` gb)++instance Semigroup a => GSemigroup (K1 i a) where+  K1 fa `gsop` K1 ga = K1 $ fa <> ga++-- | `<>` by field-wise `<>`.+instance (Generic a, GSemigroup (Rep a)) => Semigroup (Wrapped Generic a) where+  Wrapped a <> Wrapped b = Wrapped . to $ from a `gsop` from b++-- | Generic Monoid.+--+-- Exported just to give Haddock something to link to; use @Wrapped Generic@+-- with @-XDerivingVia@ instead.+class GMonoid f where+  gmempty :: f x++instance GMonoid f => GMonoid (M1 i m f) where+  gmempty = M1 gmempty++instance (GMonoid f, GMonoid g) => GMonoid (f :*: g) where+  gmempty = gmempty :*: gmempty++instance GMonoid U1 where+  gmempty = U1++instance Monoid a => GMonoid (K1 i a) where+  gmempty = K1 mempty++-- | `mappend` by field-wise `<>`, and `mempty` by field-wise `mempty`+--+-- Beware: this determines the entire instance including `mappend`, so do not+-- mix this with a `Semigroup` instance from another source.+instance (Generic a, GSemigroup (Rep a), GMonoid (Rep a))+      => Monoid (Wrapped Generic a) where+  mempty = Wrapped $ to gmempty++-- $Wrapped_IsList+--+-- Instances of @'Wrapped' 'IsList'@ work by conversion to/from list.+--+-- For example, we provide 'Eq', 'Ord', and 'Show' instances that convert both+-- operands to lists and compare them, and a 'Read' instance that parses a list+-- and converts to the desired type.+--+-- Whereas @Wrapped 'Foldable'@ requires that the type is a type constructor+-- whose argument is the list element, this works on any type with an 'IsList'+-- instance.+--+-- On the other hand, 'IsList' requires that the type can be converted /from/ a+-- list, not only /to/ a list, so it can often require unneeded constraints+-- compared to 'Foldable'.+--+-- Generally, if both of these compile, they should be expected to be+-- equivalent.  More specifically, if you implement instances for @Wrapped+-- Foldable@ or @Wrapped IsList@ these types, you should ensure that, as long+-- as the 'Foldable' instance of @f@ and the 'IsList' instance of @f a@ are+-- consistent, the instances are the same; and if you adopt instances from this+-- type, you should ensure that your 'Foldable' and 'IsList' instances agree,+-- and may then assume that 'IsList' and 'Foldable' give the same instances.++-- | Just forwarding the instance; not meant to be used for deriving.+deriving newtype instance IsList a => IsList (Wrapped IsList a)++-- | Equality of the results of 'Exts.toList'.+instance (IsList a, Eq (Item a)) => Eq (Wrapped IsList a) where+  (==) = (==) `on` Exts.toList++-- | Comparison of the results of 'Exts.toList'.+instance (IsList a, Ord (Item a)) => Ord (Wrapped IsList a) where+  compare = compare `on` Exts.toList++-- | Show of the results of 'Exts.toList'.+instance (IsList a, Show (Item a)) => Show (Wrapped IsList a) where+  showsPrec p = showsPrec p . Exts.toList++-- | 'Exts.fromList' of a parsed list.+instance (IsList a, Read (Item a)) => Read (Wrapped IsList a) where+  readPrec = fmap Exts.fromList $ readPrec @[Item a]+  readListPrec = readListPrecDefault++-- $Wrapped_Foldable+--+-- Instances of @'Wrapped' 'Foldable'@ work by folding over the type.+--+-- See above for a description of how this differs from @'Wrapped' 'IsList'@.++-- | Just forwarding the instance; not meant to be used for deriving.+deriving newtype instance Foldable f => Foldable (Wrapped1 Foldable f)++-- | Equality of the results of 'F.toList'.+instance (Foldable f, Eq a) => Eq (Wrapped1 Foldable f a) where+  (==) = (==) `on` F.toList++-- | Comparison of the results of 'F.toList'.+instance (Foldable f, Ord a) => Ord (Wrapped1 Foldable f a) where+  compare = compare `on` F.toList++-- | Show of the results of 'Exts.toList'.+instance (Foldable f, Show a) => Show (Wrapped1 Foldable f a) where+  showsPrec p = showsPrec p . F.toList++-- | Provide ('<>') by 'liftA2' of an underlying ('<>').+instance (Applicative f, Semigroup a)+      => Semigroup (Wrapped1 Applicative f a) where+  (<>) = fmap Wrapped1 . (liftA2 (<>) `on` unWrapped1)++-- | Provide 'mappend' by 'liftA2' and 'mempty' by @'pure' 'mempty'@.+instance (Applicative f, Monoid m) => Monoid (Wrapped1 Applicative f m) where+  mempty = Wrapped1 (pure mempty)++-- | Forwarding instance for 'Functor'.+--+-- If we want @Wrapped1 Generic1 f@ to have instances for things with 'Functor'+-- as a superclass, then it needs to have a 'Functor' instance.  There's not+-- much point in providing a Generics-based one, though because @DeriveFunctor@+-- exists.  So, just forward the underlying type's instance.+deriving newtype instance Functor f => Functor (Wrapped1 Generic1 f)

@@ -0,0 +1,43 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.33.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: e0afcb2bfa2caf82798dcda573c47f1043922eedabf3601cddf74ddf9e49e42e++name:           wrapped+version:        0.1.0.0+synopsis:       Provides a single standardized place to hang DerivingVia instances.+description:    This exports the newtypes 'Wrapped' and 'Wrapped1', which are meant to hold+                typeclass implementations derived from other classes (most frequently,+                'Generic' and 'Generic1').  If you implement a general instance of a class,+                add it as an instance for 'Wrapped' or 'Wrapped1', and users will be able to+                derive it uniformly as @deriving TheClass via Wrapped TheType@.+category:       Generics+homepage:       https://github.com/google/hs-wrapped#readme+bug-reports:    https://github.com/google/hs-wrapped/issues+author:         Andrew Pritchard <awpr@google.com>+maintainer:     Andrew Pritchard <awpr@google.com>+copyright:      2019-2021 Google LLC+license:        Apache-2.0+license-file:   LICENSE+build-type:     Simple+extra-source-files:+  CHANGELOG.md++source-repository head+  type: git+  location: https://github.com/google/hs-wrapped+  subdir: wrapped++library+  exposed-modules:+    Data.Wrapped+  other-modules:+    Paths_wrapped+  hs-source-dirs:+    src+  build-depends:+    base >=4.12 && <4.16+  default-language: Haskell2010