Mu.Schema.Lens package

This commit is contained in:
Andre Marianiello 2020-09-04 11:47:21 -04:00
parent 7148ab3c29
commit c92dfeb199
6 changed files with 605 additions and 0 deletions

View File

@ -4,6 +4,7 @@ packages: compendium-client/
core/schema/
core/rpc/
core/optics/
core/lens/
adapter/avro/
adapter/protobuf/
adapter/persistent/

202
core/lens/LICENSE Normal file
View File

@ -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.

1
core/lens/hie.yaml Normal file
View File

@ -0,0 +1 @@
cradle: { stack: { component: "mu-lens:lib" } }

36
core/lens/mu-lens.cabal Normal file
View File

@ -0,0 +1,36 @@
name: mu-lens
version: 0.3.0.0
synopsis: Lenses 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 @lens@es.
license: Apache-2.0
license-file: LICENSE
author: Andre Marianiello
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.Lens
build-depends:
base
, containers
, lens
, generic-lens
, mu-schema
, mu-rpc
, sop-core
, text
hs-source-dirs: src
default-language: Haskell2010
ghc-options: -Wall

View File

@ -0,0 +1,364 @@
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE FunctionalDependencies #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE InstanceSigs #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedLabels #-}
{-# LANGUAGE PartialTypeSignatures #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE QuantifiedConstraints #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE UndecidableInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
module Mu.Schema.Lens where
import Control.Lens
import Data.Kind
import Data.Map
import Data.SOP
import qualified Data.Text as T
import GHC.OverloadedLabels
import GHC.TypeLits hiding (Nat) -- we need Nats with a constructor to represent non-zero
import Mu.Schema
data Nat = Zero | Succ Nat
record :: BuildRecord sch args r => r -> Term sch ('DRecord name args)
record = TRecord . buildR
class BuildRecord (sch :: Schema Symbol Symbol) (args :: [FieldDef Symbol Symbol]) (r :: Type) where
buildR :: r -> NP (Field sch) args
instance
{-# OVERLAPPABLE #-}
(Uninterpret r ~ fieldType, UninterpretField sch r) =>
BuildRecord
sch
'[ 'FieldDef fieldName fieldType
]
r
where
buildR val = Field (toFieldValue val) :* Nil
instance
( Uninterpret v1 ~ fieldType1,
Uninterpret v2 ~ fieldType2,
UninterpretField sch v1,
UninterpretField sch v2
) =>
BuildRecord
sch
'[ 'FieldDef fieldName1 fieldType1,
'FieldDef fieldName2 fieldType2
]
(v1, v2)
where
buildR (v1, v2) = Field (toFieldValue v1) :* Field (toFieldValue v2) :* Nil
instance
( Uninterpret v1 ~ fieldType1,
Uninterpret v2 ~ fieldType2,
Uninterpret v3 ~ fieldType3,
UninterpretField sch v1,
UninterpretField sch v2,
UninterpretField sch v3
) =>
BuildRecord
sch
'[ 'FieldDef fieldName1 fieldType1,
'FieldDef fieldName2 fieldType2,
'FieldDef fieldName3 fieldType3
]
(v1, v2, v3)
where
buildR (v1, v2, v3) =
Field (toFieldValue v1)
:* Field (toFieldValue v2)
:* Field (toFieldValue v3)
:* Nil
instance
( Functor f,
HasFieldIx (IndexOf fieldName fields) fields fields' fieldType fieldType',
Interpret sch fieldType ~ fieldValue,
Interpret sch fieldType' ~ fieldValue',
Uninterpret fieldValue ~ fieldType,
Uninterpret fieldValue' ~ fieldType',
UninterpretField sch fieldValue'
) =>
IsLabel
fieldName
( (fieldValue -> f fieldValue') ->
(Term sch ('DRecord name fields) -> f (Term sch ('DRecord name fields')))
)
where
fromLabel = field @fieldName
instance
forall choiceName p f sch name choiceDefs choiceDefs' choiceType choiceType'.
( Choice p,
Applicative f,
HasChoiceIx (ChoiceIndexOf choiceName choiceDefs) choiceDefs choiceDefs' choiceType choiceType'
) =>
IsLabel
choiceName
( p choiceType (f choiceType') ->
p (Term sch ('DEnum name choiceDefs)) (f (Term sch ('DEnum name choiceDefs')))
)
where
fromLabel = choose @choiceName
choose ::
forall (choiceName :: Symbol) sch name choiceDefs choiceDefs' choiceType choiceType'.
(HasChoiceIx (ChoiceIndexOf choiceName choiceDefs) choiceDefs choiceDefs' choiceType choiceType') =>
Prism
(Term sch ('DEnum name choiceDefs))
(Term sch ('DEnum name choiceDefs'))
choiceType
choiceType'
choose = chooseIx @(ChoiceIndexOf choiceName choiceDefs)
class
HasChoiceIx
(choiceIndex :: Nat)
(choiceDefs :: [ChoiceDef Symbol])
(choiceDefs' :: [ChoiceDef Symbol])
choiceType
choiceType'
| choiceIndex choiceDefs -> choiceType,
choiceIndex choiceDefs' -> choiceType',
choiceIndex choiceDefs choiceType' -> choiceDefs',
choiceIndex choiceDefs' choiceType -> choiceDefs where
chooseIx ::
Prism
(Term sch ('DEnum name choiceDefs))
(Term sch ('DEnum name' choiceDefs'))
choiceType
choiceType'
instance
HasChoiceIx
'Zero
('ChoiceDef choiceName ': choiceDefs)
('ChoiceDef choiceName ': choiceDefs)
()
()
where
chooseIx f = dimap project (either pure (fmap inject)) (right' f)
where
inject :: () -> Term sch ('DEnum name ('ChoiceDef choiceName ': choiceDefs))
inject () = TEnum (Z (Proxy @('ChoiceDef choiceName)))
project ::
Term sch ('DEnum name ('ChoiceDef choiceName ': choiceDefs)) ->
Either (Term sch ('DEnum name' ('ChoiceDef choiceName' ': choiceDefs))) ()
project term = case term of
TEnum (Z Proxy) -> Right ()
_ -> Left (TEnum (Z Proxy))
instance
(HasChoiceIx choiceIndex choiceDefs choiceDefs' choiceType choiceType') =>
HasChoiceIx
('Succ choiceIndex)
(choiceDef ': choiceDefs)
(choiceDef ': choiceDefs')
choiceType
choiceType'
where
chooseIx f =
dimap
project
inject
(right' (chooseIx @choiceIndex @choiceDefs @choiceDefs' f))
where
project ::
Term sch ('DEnum name (choiceDef ': choiceDefs)) ->
Either () (Term sch ('DEnum name choiceDefs))
project (TEnum (Z Proxy)) = Left ()
project (TEnum (S inner)) = Right (TEnum inner)
inject ::
Applicative f =>
Either () (f (Term sch ('DEnum name choiceDefs'))) ->
f (Term sch ('DEnum name (choiceDef ': choiceDefs')))
inject (Left ()) = pure (TEnum (Z Proxy))
inject (Right inner) = fmap wrap inner
wrap :: Term sch ('DEnum name choiceDefs') -> Term sch ('DEnum name (choiceDef ': choiceDefs'))
wrap (TEnum choices) = TEnum (S choices)
field ::
forall fieldName sch name fieldDefs fieldDefs' fieldType fieldType' fieldValue fieldValue'.
(HasFieldIx (IndexOf fieldName fieldDefs) fieldDefs fieldDefs' fieldType fieldType') =>
( HasFieldIx (IndexOf fieldName fieldDefs) fieldDefs fieldDefs' fieldType fieldType',
Interpret sch fieldType ~ fieldValue,
Interpret sch fieldType' ~ fieldValue',
Uninterpret fieldValue ~ fieldType,
Uninterpret fieldValue' ~ fieldType',
UninterpretField sch fieldValue'
) =>
Lens
(Term sch ('DRecord name fieldDefs))
(Term sch ('DRecord name fieldDefs'))
fieldValue
fieldValue'
field = fieldValueName @fieldName . interpretIso
fieldValueName ::
forall fieldName sch name fieldDefs fieldDefs' fieldType fieldType'.
(HasFieldIx (IndexOf fieldName fieldDefs) fieldDefs fieldDefs' fieldType fieldType') =>
Lens
(Term sch ('DRecord name fieldDefs))
(Term sch ('DRecord name fieldDefs'))
(FieldValue sch fieldType)
(FieldValue sch fieldType')
fieldValueName = fieldValueIx @(IndexOf fieldName fieldDefs)
type family IndexOf (fieldName :: fieldNameKind) (fieldDefs :: [FieldDefB builtin fieldNameKind typeNameKind]) :: Nat where
IndexOf fieldName ('FieldDef fieldName _ ': _) = 'Zero
IndexOf fieldName (_ ': fieldDefs) = 'Succ (IndexOf fieldName fieldDefs)
IndexOf fieldName '[] = TypeError ('Text "does not contain field name " ':<>: 'ShowType fieldName)
type family
ChoiceIndexOf
(choiceName :: choiceNameKind)
(choiceDefs :: [ChoiceDef choiceNameKind]) ::
Nat where
ChoiceIndexOf choiceName ('ChoiceDef choiceName : _) = 'Zero
ChoiceIndexOf choiceName (_ ': choiceDefs) = 'Succ (ChoiceIndexOf choiceName choiceDefs)
class
HasFieldIx
(fieldIndex :: Nat)
(fieldDefs :: [FieldDef Symbol Symbol])
(fieldDefs' :: [FieldDef Symbol Symbol])
(fieldType :: FieldType Symbol)
(fieldType' :: FieldType Symbol)
| fieldIndex fieldDefs -> fieldType,
fieldIndex fieldDefs' -> fieldType',
fieldIndex fieldDefs fieldType' -> fieldDefs',
fieldIndex fieldDefs' fieldType -> fieldDefs where
fieldValueIx ::
Lens
(Term sch ('DRecord name fieldDefs))
(Term sch ('DRecord name' fieldDefs'))
(FieldValue sch fieldType)
(FieldValue sch fieldType')
instance
HasFieldIx
'Zero
('FieldDef fieldName fieldType ': fieldDefs)
('FieldDef fieldName fieldType' ': fieldDefs)
fieldType
fieldType'
where
fieldValueIx f (TRecord (Field fieldValue :* fields)) = TRecord . (:* fields) . Field <$> f fieldValue
instance
( HasFieldIx
fieldIndex
fieldDefs
fieldDefs'
fieldType
fieldType'
) =>
HasFieldIx ('Succ fieldIndex) (fieldDef ': fieldDefs) (fieldDef ': fieldDefs') fieldType fieldType'
where
fieldValueIx f (TRecord (firstField :* restOfFields)) =
wrap <$> fieldValueIx @fieldIndex f (TRecord restOfFields)
where
wrap (TRecord fields) = TRecord (firstField :* fields)
interpretIso ::
( Uninterpret (Interpret sch fieldType') ~ fieldType',
UninterpretField sch (Interpret sch fieldType')
) =>
Iso (FieldValue sch fieldType) (FieldValue sch fieldType') (Interpret sch fieldType) (Interpret sch fieldType')
interpretIso = dimap fromFieldValue (fmap toFieldValue)
type family Interpret (sch :: Schema typeName fieldName) (fieldType :: FieldType typeName) :: Type where
Interpret _ 'TNull = ()
Interpret _ ('TPrimitive builtin) = builtin
Interpret sch ('TSchematic typeName) = Term sch (sch :/: typeName)
Interpret sch ('TOption innerType) = Maybe (Interpret sch innerType)
Interpret sch ('TList innerType) = [Interpret sch innerType]
Interpret sch ('TMap keyType valueType) = Map (Interpret sch keyType) (Interpret sch valueType)
Interpret sch ('TUnion choiceTypes) = NS Identity (InterpretList sch choiceTypes)
type family InterpretList sch (fieldTypes :: [FieldType typeName]) :: [Type] where
InterpretList _ '[] = '[]
InterpretList sch (t ': ts) = (Interpret sch t ': InterpretList sch ts)
fromFieldValue :: FieldValue sch fieldType -> Interpret sch fieldType
fromFieldValue = \case
FNull -> ()
(FPrimitive val) -> val
(FSchematic term) -> term
(FOption maybeFieldValue) -> fromFieldValue <$> maybeFieldValue
(FList listFieldValues) -> fromFieldValue <$> listFieldValues
(FMap mapFieldValues) -> mapKeysMonotonic fromFieldValue (fromFieldValue <$> mapFieldValues)
(FUnion (Z val)) -> Z (Identity (fromFieldValue val))
(FUnion (S val)) -> S (fromFieldValue (FUnion val))
class UninterpretField sch a where
type Uninterpret a :: FieldType typeName
toFieldValue :: a -> FieldValue sch (Uninterpret a)
instance UninterpretField sch () where
type Uninterpret () = 'TNull
toFieldValue () = FNull
instance UninterpretField sch Int where
type Uninterpret Int = 'TPrimitive Int
toFieldValue = FPrimitive
instance UninterpretField sch T.Text where
type Uninterpret T.Text = 'TPrimitive T.Text
toFieldValue = FPrimitive
instance
((sch :/: recordName) ~ 'DRecord recordName fieldDefs) =>
UninterpretField sch (Term sch ('DRecord recordName fieldDefs))
where
type Uninterpret (Term sch ('DRecord recordName fieldDefs)) = 'TSchematic recordName
toFieldValue = FSchematic
instance (UninterpretField sch a) => UninterpretField sch (Maybe a) where
type Uninterpret (Maybe a) = 'TOption (Uninterpret a)
toFieldValue = FOption . fmap toFieldValue
instance (UninterpretField sch a) => UninterpretField sch [a] where
type Uninterpret [a] = 'TList (Uninterpret a)
toFieldValue = FList . fmap toFieldValue
instance
(Ord (FieldValue sch (Uninterpret k)), UninterpretField sch k, UninterpretField sch v) =>
UninterpretField sch (Map k v)
where
type Uninterpret (Map k v) = 'TMap (Uninterpret k) (Uninterpret v)
toFieldValue = FMap . mapKeysMonotonic toFieldValue . fmap toFieldValue
instance
(All (UninterpretField sch) choiceTypes) =>
UninterpretField sch (NS Identity (choiceTypes :: [Type]))
where
type Uninterpret (NS Identity choiceTypes) = 'TUnion (UninterpretList choiceTypes)
toFieldValue = FUnion . nsToFieldValues
nsToFieldValues :: (All (UninterpretField sch) choiceTypes) => NS Identity choiceTypes -> NS (FieldValue sch) (UninterpretList choiceTypes)
nsToFieldValues = \case
(Z val) -> Z . toFieldValue . runIdentity $ val
(S val) -> S (nsToFieldValues val)
type family Tail (l :: [k]) where
Tail (t ': ts) = ts
type family UninterpretList (as :: [Type]) :: [FieldType typeName] where
UninterpretList '[] = '[]
UninterpretList (t ': ts) = Uninterpret t ': UninterpretList ts

View File

@ -5,6 +5,7 @@ packages:
- core/schema
- core/rpc
- core/optics
- core/lens
- adapter/avro
- adapter/protobuf
- adapter/persistent