mu-optics (empty) → 0.2.0.0

raw patch · 3 files changed

+472/−0 lines, 3 filesdep +basedep +containersdep +mu-schema

Dependencies added: base, containers, mu-schema, optics-core, sop-core

Files

• LICENSE +202/−0
• mu-optics.cabal +36/−0
• src/Mu/Schema/Optics.hs +234/−0

@@ -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 © 2019-2020 47 Degrees. <http://47deg.com>++   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,36 @@+name:          mu-optics+version:       0.2.0.0+synopsis:      Optics for @mu-schema@ terms+description:+  With @mu-schema@ you can describe schemas using type-level constructs, and derive serializers from those. This package provides convenient access using @optics@.++license:       Apache-2.0+license-file:  LICENSE+author:        Alejandro Serrano, Flavio Corpa+maintainer:    alejandro.serrano@47deg.com+copyright:     Copyright © 2019-2020 <http://47deg.com 47 Degrees>+category:      Network+build-type:    Simple+cabal-version: >=1.10+homepage:      https://higherkindness.io/mu-haskell/+bug-reports:   https://github.com/higherkindness/mu-haskell/issues++source-repository head+  type:     git+  location: https://github.com/higherkindness/mu-haskell++library+  exposed-modules:  Mu.Schema.Optics++  -- other-modules:+  -- other-extensions:+  build-depends:+      base         >=4.12  && <5+    , containers+    , mu-schema    >=0.2.0+    , optics-core+    , sop-core++  hs-source-dirs:   src+  default-language: Haskell2010+  ghc-options:      -Wall

@@ -0,0 +1,234 @@+{-# language AllowAmbiguousTypes    #-}+{-# language DataKinds              #-}+{-# language FlexibleInstances      #-}+{-# language FunctionalDependencies #-}+{-# language GADTs                  #-}+{-# language LambdaCase             #-}+{-# language PolyKinds              #-}+{-# language ScopedTypeVariables    #-}+{-# language TypeApplications       #-}+{-# language TypeOperators          #-}+{-# language UndecidableInstances   #-}+{-# OPTIONS_GHC -fno-warn-orphans #-}+{-|+Description : Optics-based interface for @mu-schema@ terms++This module provides instances of 'LabelOptic' to be+used in conjunction with the @optics@ package.+In particular, there are two kind of optics to access+different parts of a 'Term':++* With @#field@ you obtain the lens (that is, a getter+  and a setter) for the corresponding field in a record.+* With @#choice@ you obtain the prism for the+  desired choice in an enumeration. You can use then+  'review' to construct a term with the value.++In addition, we provide a utility function 'record' to+build a record out of the inner values. We intend the+interface to be very simple, so this function is overloaded+to take tuples of different size, with as many components+as values in the schema type.+-}+module Mu.Schema.Optics (+  -- * Build a term+  record, record1, enum+, _U0, _Next, _U1, _U2, _U3+  -- * Re-exported for convenience.+, module Optics.Core+) where++import           Data.Functor.Identity+import           Data.Kind+import           Data.Map+import           Data.Proxy+import           GHC.TypeLits+import           Optics.Core++import           Mu.Schema++instance {-# OVERLAPS #-}+         (FieldLabel Identity sch args fieldName r)+         => LabelOptic fieldName A_Lens+                       (Term Identity sch ('DRecord name args))+                       (Term Identity sch ('DRecord name args))+                       r r where+  labelOptic = lens (\(TRecord r) -> runIdentity $ fieldLensGet (Proxy @fieldName) r)+                    (\(TRecord r) x -> TRecord $ fieldLensSet (Proxy @fieldName) r (Identity x))++instance {-# OVERLAPPABLE #-}+         (FieldLabel w sch args fieldName r, t ~ w r)+         => LabelOptic fieldName A_Lens+                       (Term w sch ('DRecord name args))+                       (Term w sch ('DRecord name args))+                       t t where+  labelOptic = lens (\(TRecord r) -> fieldLensGet (Proxy @fieldName) r)+                    (\(TRecord r) x -> TRecord $ fieldLensSet (Proxy @fieldName) r x)++record :: BuildRecord w sch args r => r -> Term w sch ('DRecord name args)+record values = TRecord $ buildR values++record1 :: BuildRecord1 w sch arg r => r -> Term w sch ('DRecord name '[arg])+record1 value = TRecord $ buildR1 value++class BuildRecord1 (w :: Type -> Type)+                   (sch :: Schema Symbol Symbol)+                   (arg :: FieldDef Symbol Symbol)+                   (r :: Type) | w sch arg -> r where+  buildR1 :: r -> NP (Field w sch) '[arg]++instance {-# OVERLAPPABLE #-} (Functor w, TypeLabel w sch t1 r1)+         => BuildRecord1 w sch ('FieldDef x1 t1) (w r1) where+  buildR1 v = Field (typeLensSet <$> v) :* Nil++instance {-# OVERLAPS #-} (TypeLabel Identity sch t1 r1)+         => BuildRecord1 Identity sch ('FieldDef x1 t1) r1 where+  buildR1 v = Field (typeLensSet <$> Identity v) :* Nil++class BuildRecord (w :: Type -> Type)+                  (sch :: Schema Symbol Symbol)+                  (args :: [FieldDef Symbol Symbol])+                  (r :: Type) | w sch args -> r where+  buildR :: r -> NP (Field w sch) args++instance BuildRecord w sch '[] () where+  buildR _ = Nil++instance {-# OVERLAPPABLE #-} (Functor w, TypeLabel w sch t1 r1, TypeLabel w sch t2 r2)+         => BuildRecord w sch '[ 'FieldDef x1 t1, 'FieldDef x2 t2 ] (w r1, w r2) where+  buildR (v1, v2) = Field (typeLensSet <$> v1)+                  :* Field (typeLensSet <$> v2) :* Nil++instance {-# OVERLAPS #-} (TypeLabel Identity sch t1 r1, TypeLabel Identity sch t2 r2)+         => BuildRecord Identity sch '[ 'FieldDef x1 t1, 'FieldDef x2 t2 ] (r1, r2) where+  buildR (v1, v2) = Field (typeLensSet <$> Identity v1)+                  :* Field (typeLensSet <$> Identity v2) :* Nil++instance {-# OVERLAPPABLE #-} (Functor w, TypeLabel w sch t1 r1, TypeLabel w sch t2 r2, TypeLabel w sch t3 r3)+         => BuildRecord w sch+                        '[ 'FieldDef x1 t1, 'FieldDef x2 t2, 'FieldDef x3 t3 ]+                        (w r1, w r2, w r3) where+  buildR (v1, v2, v3) = Field (typeLensSet <$> v1)+                      :* Field (typeLensSet <$> v2)+                      :* Field (typeLensSet <$> v3) :* Nil++instance {-# OVERLAPS #-} (TypeLabel Identity sch t1 r1, TypeLabel Identity sch t2 r2, TypeLabel Identity sch t3 r3)+         => BuildRecord Identity sch+                        '[ 'FieldDef x1 t1, 'FieldDef x2 t2, 'FieldDef x3 t3 ] (r1, r2, r3) where+  buildR (v1, v2, v3) = Field (typeLensSet <$> Identity v1)+                      :* Field (typeLensSet <$> Identity v2)+                      :* Field (typeLensSet <$> Identity v3) :* Nil++class FieldLabel (w :: Type -> Type)+                 (sch :: Schema Symbol Symbol)+                 (args :: [FieldDef Symbol Symbol])+                 (fieldName :: Symbol) (r :: Type)+                 | w sch args fieldName -> r where+  fieldLensGet :: Proxy fieldName -> NP (Field w sch) args -> w r+  fieldLensSet :: Proxy fieldName -> NP (Field w sch) args -> w r -> NP (Field w sch) args++{- Removed due to FunDeps+instance TypeError ('Text "cannot find field " ':<>: 'ShowType f)+         => FieldLabel w sch '[] f t where+  fieldLensGet = error "this should never be run"+  fieldLensSet = error "this should never be run"+-}+instance {-# OVERLAPS #-} (Functor w, TypeLabel w sch t r)+         => FieldLabel w sch ('FieldDef f t ': rest) f r where+  fieldLensGet _ (Field x :* _) = typeLensGet <$> x+  fieldLensSet _ (_ :* r) new = Field (typeLensSet <$> new) :* r+instance {-# OVERLAPPABLE #-} FieldLabel w sch rest g t+         => FieldLabel w sch (f ': rest) g t where+  fieldLensGet p (_ :* r) = fieldLensGet p r+  fieldLensSet p (x :* r) new = x :* fieldLensSet p r new++class TypeLabel w (sch :: Schema Symbol Symbol) (t :: FieldType Symbol) (r :: Type)+      | w sch t -> r where+  typeLensGet :: FieldValue w sch t -> r+  typeLensSet :: r -> FieldValue w sch t++instance TypeLabel w sch ('TPrimitive t) t where+  typeLensGet (FPrimitive x) = x+  typeLensSet = FPrimitive++instance (r ~ (sch :/: t)) => TypeLabel w sch ('TSchematic t) (Term w sch r) where+  typeLensGet (FSchematic x) = x+  typeLensSet = FSchematic++instance (TypeLabel w sch o r', r ~ Maybe r')+         => TypeLabel w sch ('TOption o) r where+  typeLensGet (FOption x) = typeLensGet <$> x+  typeLensSet new = FOption (typeLensSet <$> new)++instance (TypeLabel w sch o r', r ~ [r'])+         => TypeLabel w sch ('TList o) r where+  typeLensGet (FList x) = typeLensGet <$> x+  typeLensSet new = FList (typeLensSet <$> new)++instance ( TypeLabel w sch k k', TypeLabel w sch v v'+         , r ~ Map k' v', Ord k', Ord (FieldValue w sch k) )+         => TypeLabel w sch ('TMap k v) r where+  typeLensGet (FMap x) = mapKeys typeLensGet (typeLensGet <$> x)+  typeLensSet new = FMap (mapKeys typeLensSet (typeLensSet <$> new))++instance (r ~ NS (FieldValue w sch) choices)+         => TypeLabel w sch ('TUnion choices) r where+  typeLensGet (FUnion x) = x+  typeLensSet = FUnion++enum :: forall (choiceName :: Symbol) choices w sch name.+        EnumLabel choices choiceName+     => Term w sch ('DEnum name choices)+enum = TEnum $ enumPrismBuild (Proxy @choiceName)++instance (EnumLabel choices choiceName, r ~ ())+         => LabelOptic choiceName A_Prism+                       (Term w sch ('DEnum name choices))+                       (Term w sch ('DEnum name choices))+                       r r where+  labelOptic = prism' (\_ -> TEnum $ enumPrismBuild (Proxy @choiceName))+                     (\(TEnum r) -> enumPrismMatch (Proxy @choiceName) r)++class EnumLabel (choices :: [ChoiceDef Symbol])+                (choiceName :: Symbol) where+  enumPrismBuild :: Proxy choiceName -> NS Proxy choices+  enumPrismMatch :: Proxy choiceName -> NS Proxy choices -> Maybe ()++instance TypeError ('Text "cannot find choice " ':<>: 'ShowType c)+         => EnumLabel '[] c where+  enumPrismBuild = error "this should never be run"+  enumPrismMatch = error "this should never be run"+instance {-# OVERLAPS #-} EnumLabel ('ChoiceDef c ': rest) c where+  enumPrismBuild _ = Z Proxy+  enumPrismMatch _ (Z _) = Just ()+  enumPrismMatch _ _     = Nothing+instance {-# OVERLAPPABLE #-} EnumLabel rest c+         => EnumLabel (d ': rest) c where+  enumPrismBuild p = S (enumPrismBuild p)+  enumPrismMatch _ (Z _) = Nothing+  enumPrismMatch p (S x) = enumPrismMatch p x++_U0 :: forall w (sch :: Schema') x xs r. TypeLabel w sch x r+    => Prism' (NS (FieldValue w sch) (x ': xs)) r+_U0 = prism' (Z . typeLensSet)+             (\case (Z x) -> Just $ typeLensGet x+                    (S _) -> Nothing)++_Next :: forall w (sch :: Schema') x xs.+         Prism' (NS (FieldValue w sch) (x ': xs))+                (NS (FieldValue w sch) xs)+_Next = prism' S+               (\case (Z _) -> Nothing+                      (S x) -> Just x)++_U1 :: forall w (sch :: Schema') a b xs r. TypeLabel w sch b r+    => Prism' (NS (FieldValue w sch) (a ': b ': xs)) r+_U1 = _Next % _U0++_U2 :: forall w (sch :: Schema') a b c xs r. TypeLabel w sch c r+    => Prism' (NS (FieldValue w sch) (a ': b ': c ': xs)) r+_U2 = _Next % _U1++_U3 :: forall w (sch :: Schema') a b c d xs r. TypeLabel w sch d r+    => Prism' (NS (FieldValue w sch) (a ': b ': c ': d ': xs)) r+_U3 = _Next % _U2