hschema-prettyprinter (empty) → 0.0.1.0

raw patch · 6 files changed

+364/−0 lines, 6 filesdep +basedep +contravariantdep +freesetup-changed

Dependencies added: base, contravariant, free, hschema, lens, mtl, natural-transformation, prettyprinter, prettyprinter-ansi-terminal, text, unordered-containers, vector

Files

• ChangeLog.md +3/−0
• LICENSE +165/−0
• README.md +4/−0
• Setup.hs +2/−0
• hschema-prettyprinter.cabal +50/−0
• src/Data/Schema/PrettyPrint.hs +140/−0

@@ -0,0 +1,3 @@+# Changelog for hexomorph++## Unreleased changes

@@ -0,0 +1,165 @@+                   GNU LESSER GENERAL PUBLIC LICENSE+                       Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.+++  This version of the GNU Lesser General Public License incorporates+the terms and conditions of version 3 of the GNU General Public+License, supplemented by the additional permissions listed below.++  0. Additional Definitions.++  As used herein, "this License" refers to version 3 of the GNU Lesser+General Public License, and the "GNU GPL" refers to version 3 of the GNU+General Public License.++  "The Library" refers to a covered work governed by this License,+other than an Application or a Combined Work as defined below.++  An "Application" is any work that makes use of an interface provided+by the Library, but which is not otherwise based on the Library.+Defining a subclass of a class defined by the Library is deemed a mode+of using an interface provided by the Library.++  A "Combined Work" is a work produced by combining or linking an+Application with the Library.  The particular version of the Library+with which the Combined Work was made is also called the "Linked+Version".++  The "Minimal Corresponding Source" for a Combined Work means the+Corresponding Source for the Combined Work, excluding any source code+for portions of the Combined Work that, considered in isolation, are+based on the Application, and not on the Linked Version.++  The "Corresponding Application Code" for a Combined Work means the+object code and/or source code for the Application, including any data+and utility programs needed for reproducing the Combined Work from the+Application, but excluding the System Libraries of the Combined Work.++  1. Exception to Section 3 of the GNU GPL.++  You may convey a covered work under sections 3 and 4 of this License+without being bound by section 3 of the GNU GPL.++  2. Conveying Modified Versions.++  If you modify a copy of the Library, and, in your modifications, a+facility refers to a function or data to be supplied by an Application+that uses the facility (other than as an argument passed when the+facility is invoked), then you may convey a copy of the modified+version:++   a) under this License, provided that you make a good faith effort to+   ensure that, in the event an Application does not supply the+   function or data, the facility still operates, and performs+   whatever part of its purpose remains meaningful, or++   b) under the GNU GPL, with none of the additional permissions of+   this License applicable to that copy.++  3. Object Code Incorporating Material from Library Header Files.++  The object code form of an Application may incorporate material from+a header file that is part of the Library.  You may convey such object+code under terms of your choice, provided that, if the incorporated+material is not limited to numerical parameters, data structure+layouts and accessors, or small macros, inline functions and templates+(ten or fewer lines in length), you do both of the following:++   a) Give prominent notice with each copy of the object code that the+   Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the object code with a copy of the GNU GPL and this license+   document.++  4. Combined Works.++  You may convey a Combined Work under terms of your choice that,+taken together, effectively do not restrict modification of the+portions of the Library contained in the Combined Work and reverse+engineering for debugging such modifications, if you also do each of+the following:++   a) Give prominent notice with each copy of the Combined Work that+   the Library is used in it and that the Library and its use are+   covered by this License.++   b) Accompany the Combined Work with a copy of the GNU GPL and this license+   document.++   c) For a Combined Work that displays copyright notices during+   execution, include the copyright notice for the Library among+   these notices, as well as a reference directing the user to the+   copies of the GNU GPL and this license document.++   d) Do one of the following:++       0) Convey the Minimal Corresponding Source under the terms of this+       License, and the Corresponding Application Code in a form+       suitable for, and under terms that permit, the user to+       recombine or relink the Application with a modified version of+       the Linked Version to produce a modified Combined Work, in the+       manner specified by section 6 of the GNU GPL for conveying+       Corresponding Source.++       1) Use a suitable shared library mechanism for linking with the+       Library.  A suitable mechanism is one that (a) uses at run time+       a copy of the Library already present on the user's computer+       system, and (b) will operate properly with a modified version+       of the Library that is interface-compatible with the Linked+       Version.++   e) Provide Installation Information, but only if you would otherwise+   be required to provide such information under section 6 of the+   GNU GPL, and only to the extent that such information is+   necessary to install and execute a modified version of the+   Combined Work produced by recombining or relinking the+   Application with a modified version of the Linked Version. (If+   you use option 4d0, the Installation Information must accompany+   the Minimal Corresponding Source and Corresponding Application+   Code. If you use option 4d1, you must provide the Installation+   Information in the manner specified by section 6 of the GNU GPL+   for conveying Corresponding Source.)++  5. Combined Libraries.++  You may place library facilities that are a work based on the+Library side by side in a single library together with other library+facilities that are not Applications and are not covered by this+License, and convey such a combined library under terms of your+choice, if you do both of the following:++   a) Accompany the combined library with a copy of the same work based+   on the Library, uncombined with any other library facilities,+   conveyed under the terms of this License.++   b) Give prominent notice with the combined library that part of it+   is a work based on the Library, and explaining where to find the+   accompanying uncombined form of the same work.++  6. Revised Versions of the GNU Lesser General Public License.++  The Free Software Foundation may publish revised and/or new versions+of the GNU Lesser General Public License from time to time. Such new+versions will be similar in spirit to the present version, but may+differ in detail to address new problems or concerns.++  Each version is given a distinguishing version number. If the+Library as you received it specifies that a certain numbered version+of the GNU Lesser General Public License "or any later version"+applies to it, you have the option of following the terms and+conditions either of that published version or of any later version+published by the Free Software Foundation. If the Library as you+received it does not specify a version number of the GNU Lesser+General Public License, you may choose any version of the GNU Lesser+General Public License ever published by the Free Software Foundation.++  If the Library as you received it specifies that a proxy can decide+whether future versions of the GNU Lesser General Public License shall+apply, that proxy's public statement of acceptance of any version is+permanent authorization for you to choose that version for the+Library.

@@ -0,0 +1,4 @@+# Haskell Schema Pretty Printer++This a companion package for the `hschema` package providing utilities to pretty print schemas or to layout data+according to a given schema. Find more information on how to use this in the `hschema` package.

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,50 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.31.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: 518e7bb74f203a661d7e0caef3211a490932bee80e49c33cfec085d6af34bf65++name:           hschema-prettyprinter+version:        0.0.1.0+synopsis:       Describe schemas for your Haskell data types.+description:    Please see the README on GitHub at <https://github.com/alonsodomin/haskell-schema#readme>+category:       Data,Schema,Text+homepage:       https://github.com/alonsodomin/haskell-schema#readme+bug-reports:    https://github.com/alonsodomin/haskell-schema/issues+author:         Antonio Alonso Dominguez+maintainer:     alonso.domin@gmail.com+copyright:      2018 Antonio Alonso Dominguez+license:        LGPL-3+license-file:   LICENSE+build-type:     Simple+extra-source-files:+    README.md+    ChangeLog.md++source-repository head+  type: git+  location: https://github.com/alonsodomin/haskell-schema++library+  exposed-modules:+      Data.Schema.PrettyPrint+  other-modules:+      Paths_hschema_prettyprinter+  hs-source-dirs:+      src+  build-depends:+      base >=4.7 && <5+    , contravariant+    , free+    , hschema >=0.0.1.0 && <0.0.2.0+    , lens+    , mtl+    , natural-transformation+    , prettyprinter+    , prettyprinter-ansi-terminal+    , text+    , unordered-containers+    , vector+  default-language: Haskell2010

@@ -0,0 +1,140 @@+{-# LANGUAGE DeriveFunctor        #-}+{-# LANGUAGE FlexibleInstances    #-}+{-# LANGUAGE GADTs                #-}+{-# LANGUAGE LambdaCase           #-}+{-# LANGUAGE RankNTypes           #-}+{-# LANGUAGE ScopedTypeVariables  #-}+{-# LANGUAGE TypeOperators        #-}+{-# LANGUAGE TypeSynonymInstances #-}++module Data.Schema.PrettyPrint+     ( SchemaDoc (..)+     , ToSchemaDoc (..)+     , putSchema+     , SchemaLayout (..)+     , ToSchemaLayout (..)+     , prettyPrinter+     ) where++import           Control.Applicative.Free+import           Control.Functor.HigherOrder+import           Control.Lens                              hiding (iso)+import           Control.Monad.State                       (State)+import qualified Control.Monad.State                       as ST+import           Control.Natural+import           Data.Functor.Contravariant+import           Data.Functor.Contravariant.Divisible+import           Data.Functor.Sum+import qualified Data.HashMap.Strict                       as Map+import           Data.List.NonEmpty                        (NonEmpty)+import qualified Data.List.NonEmpty                        as NEL+import           Data.Maybe+import           Data.Schema.Internal.Types+import           Data.Text.Prettyprint.Doc                 ((<+>), (<>))+import qualified Data.Text.Prettyprint.Doc                 as PP+import qualified Data.Text.Prettyprint.Doc.Render.Terminal as PP+import qualified Data.Vector                               as Vector++type AnsiDoc = PP.Doc PP.AnsiStyle++indentAmount :: Int+indentAmount = 2++doubleColon :: AnsiDoc+doubleColon = PP.colon <> PP.colon++layoutFields :: forall o s. (forall v. FieldDef o s v -> AnsiDoc) -> Fields s o -> AnsiDoc+layoutFields f fields = renderFields $ ST.execState (runAp fieldDoc $ unwrapField fields) []+  where fieldDoc :: FieldDef o s v -> State [AnsiDoc] v+        fieldDoc fld = do+          fieldDesc <- pure $ PP.pretty "*" <+> (PP.pretty $ fieldName fld) <+> (f fld)+          ST.modify $ \xs -> fieldDesc:xs+          return undefined++        renderFields :: [AnsiDoc] -> AnsiDoc+        renderFields [] = PP.emptyDoc+        renderFields xs = PP.nest indentAmount $ PP.line <> PP.vsep xs++layoutAlts :: forall s o. (AltDef s o -> Maybe AnsiDoc) -> NonEmpty (AltDef s o) -> [AnsiDoc]+layoutAlts f alts = catMaybes . NEL.toList $ altDoc <$> alts+  where altDoc :: AltDef s o -> Maybe AnsiDoc+        altDoc a = (\x -> PP.indent indentAmount $ PP.pretty "-" <+> (PP.pretty $ altName a) <> x) <$> (f a)++newtype SchemaDoc a = SchemaDoc { getDoc :: AnsiDoc } deriving Functor++instance Applicative SchemaDoc where+  pure _ = SchemaDoc $ PP.emptyDoc+  (SchemaDoc l) <*> (SchemaDoc r) = SchemaDoc $ l <> r++class ToSchemaDoc s where+  toSchemaDoc :: s ~> SchemaDoc++instance (ToSchemaDoc p, ToSchemaDoc q) => ToSchemaDoc (Sum p q) where+  toSchemaDoc (InL l) = toSchemaDoc l+  toSchemaDoc (InR r) = toSchemaDoc r++toSchemaDocAlg :: ToSchemaDoc s => HAlgebra (SchemaF s) SchemaDoc+toSchemaDocAlg = wrapNT $ \case+  PrimitiveSchema p   -> SchemaDoc $ doubleColon <+> (getDoc $ toSchemaDoc p)+  RecordSchema fields -> SchemaDoc $ layoutFields fieldDoc' fields+    where fieldDoc' :: FieldDef o SchemaDoc v -> AnsiDoc+          fieldDoc' (RequiredField _ schemaDoc _) = getDoc schemaDoc+          fieldDoc' (OptionalField _ schemaDoc _) = PP.pretty "?" <> (getDoc schemaDoc)+  UnionSchema alts -> SchemaDoc $ PP.vsep $ layoutAlts altDoc' alts+    where altDoc' :: AltDef SchemaDoc a -> Maybe AnsiDoc+          altDoc' (AltDef _ (SchemaDoc doc) _) = Just doc+  AliasSchema baseDoc _ -> SchemaDoc $ getDoc baseDoc++instance ToSchemaDoc s => ToSchemaDoc (Schema s) where+  toSchemaDoc schema = (cataNT toSchemaDocAlg) (unwrapSchema schema)++-- | Renders the given schema to the standard out+putSchema :: ToSchemaDoc s => s a -> IO ()+putSchema schema = do+  PP.putDoc . getDoc $ toSchemaDoc schema+  putStrLn ""++newtype SchemaLayout a = SchemaLayout { runSchemaLayout :: a -> AnsiDoc }++instance Contravariant SchemaLayout where+  contramap f (SchemaLayout g) = SchemaLayout $ g . f++instance Divisible SchemaLayout where+  conquer = SchemaLayout $ const PP.emptyDoc+  divide split leftLayout rightLayout = SchemaLayout $ \x ->+    let (left, right) = split x+        leftDoc       = runSchemaLayout leftLayout left+        rightDoc      = runSchemaLayout rightLayout right+    in leftDoc <+> PP.pretty "," <+> rightDoc++class ToSchemaLayout s where+  toSchemaLayout :: s ~> SchemaLayout++instance (ToSchemaLayout p, ToSchemaLayout q) => ToSchemaLayout (Sum p q) where+  toSchemaLayout (InL l) = toSchemaLayout l+  toSchemaLayout (InR r) = toSchemaLayout r++toSchemaLayoutAlg :: ToSchemaLayout s => HAlgebra (SchemaF s) SchemaLayout+toSchemaLayoutAlg = wrapNT $ \case+  PrimitiveSchema p   -> SchemaLayout $ \x   -> PP.colon <+> runSchemaLayout (toSchemaLayout p) x+  RecordSchema fields -> SchemaLayout $ \rc  -> layoutFields (fieldDocOf rc) fields+    where fieldDocOf :: o -> FieldDef o SchemaLayout v -> AnsiDoc+          fieldDocOf obj (RequiredField _ (SchemaLayout layout) getter) =+            let el = view getter obj+            in layout el+          fieldDocOf obj (OptionalField _ (SchemaLayout layout) getter) =+            let el = view getter obj+            in maybe (PP.pretty "Nothing") layout el+  UnionSchema alts -> SchemaLayout $ \value -> head $ layoutAlts (layoutAlt' value) alts+    where layoutAlt' :: o -> AltDef SchemaLayout o -> Maybe AnsiDoc+          layoutAlt' obj (AltDef _ (SchemaLayout layout) getter) = layout <$> obj ^? getter+  AliasSchema (SchemaLayout baseLayout) getter -> SchemaLayout $ \value -> baseLayout (view (re getter) value)++instance ToSchemaLayout s => ToSchemaLayout (Schema s) where+  toSchemaLayout schema = (cataNT toSchemaLayoutAlg) (unwrapSchema schema)++-- | Generates a renderer of data types based on the given schema+prettyPrinter :: ToSchemaLayout s => s a -> (a -> IO ())+prettyPrinter schema = \x -> do+  PP.putDoc $ runSchemaLayout (toSchemaLayout schema) x+  putStrLn ""