diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,374 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. + diff --git a/Records/EDSL/Declare.hs b/Records/EDSL/Declare.hs new file mode 100644 --- /dev/null +++ b/Records/EDSL/Declare.hs @@ -0,0 +1,56 @@ +{- HLINT ignore "Use camelCase" -} + +module Records.EDSL.Declare ( + declareSchemaRecords, + declareSchemaRecordsFromFile, +) +where + +import Data.Maybe +import Language.Haskell.TH qualified as TH +import Language.Haskell.TH.Syntax qualified as TH +import Records.EDSL.Deriving.Type +import Records.EDSL.Description +import Relude hiding (lines) +import Text.Megaparsec as M + +-- | Declare records. Recommendation: use @ -XMultilineStrings @ +declareSchemaRecords :: Deriver -> Text -> TH.DecsQ +declareSchemaRecords derivers text = do + recs <- + M.runParserT parseRecordDescs "" text >>= \case + Left e -> error (toText (M.errorBundlePretty e)) + Right a -> pure a + decss <- forM recs (schemaRecordType derivers) + pure (concat decss) + +-- | Declare records from a file +declareSchemaRecordsFromFile :: Deriver -> FilePath -> TH.DecsQ +declareSchemaRecordsFromFile derivers fp = do + TH.qAddDependentFile fp + text <- TH.runIO (decodeUtf8 <$> readFileBS fp) + declareSchemaRecords derivers text + +-------------------------------------------------------------------------------- + +schemaRecordType :: Deriver -> RecordDesc Text -> TH.DecsQ +schemaRecordType derivers rdesc = do + self@RecordDesc {typeName, constrName, fields} <- traverse (TH.newName . toString) (addFieldPrefixes rdesc) + let + fieldCount = length fields + asNewtype = fieldCount == 1 + qRecord = + TH.RecC + constrName + [ ( name + , TH.Bang TH.NoSourceUnpackedness (if asNewtype then TH.NoSourceStrictness else TH.SourceStrict) + , type_.hask.type_ + ) + | FieldDesc {name, type_} <- fields + ] + qDataDecl <- + if asNewtype + then TH.newtypeD (pure []) typeName [] Nothing (pure qRecord) [] + else TH.dataD (pure []) typeName [] Nothing [pure qRecord] [] + derivations <- runDeriver derivers self + pure (qDataDecl : derivations) diff --git a/Records/EDSL/Deriving/HasField.hs b/Records/EDSL/Deriving/HasField.hs new file mode 100644 --- /dev/null +++ b/Records/EDSL/Deriving/HasField.hs @@ -0,0 +1,22 @@ +module Records.EDSL.Deriving.HasField where + +import Data.Proxy +import GHC.Records qualified as GHC +import Language.Haskell.TH qualified as TH +import Records.EDSL.Deriving.Type +import Records.EDSL.Description +import Relude + +deriveHasFields :: Deriver +deriveHasFields = deriver #ghc_HasField \RecordDesc {typeName, fields} -> + concat <$> forM fields \FieldDesc {name, nameText, type_} -> + if toText (TH.nameBase name) == nameText + then pure [] + else + [d| + instance GHC.HasField $(TH.litT (TH.strTyLit (toString nameText))) $(TH.conT typeName) $(pure type_.hask.type_) where + getField = getFieldP (Proxy :: Proxy $(TH.litT (TH.strTyLit (TH.nameBase name)))) + where + getFieldP :: forall x r a. (GHC.HasField x r a) => Proxy x -> r -> a + getFieldP _ = GHC.getField @x + |] diff --git a/Records/EDSL/Deriving/Stock.hs b/Records/EDSL/Deriving/Stock.hs new file mode 100644 --- /dev/null +++ b/Records/EDSL/Deriving/Stock.hs @@ -0,0 +1,22 @@ +module Records.EDSL.Deriving.Stock where + +import Language.Haskell.TH qualified as TH +import Records.EDSL.Deriving.Type +import Records.EDSL.Description +import Relude + +deriveEq :: Deriver +deriveEq = deriver #stock_Eq \RecordDesc {typeName} -> + [d|deriving stock instance Eq $(TH.conT typeName)|] + +deriveOrd :: Deriver +deriveOrd = deriver #stock_Ord \RecordDesc {typeName} -> + [d|deriving stock instance Ord $(TH.conT typeName)|] + +deriveShow :: Deriver +deriveShow = deriver #stock_Show \RecordDesc {typeName} -> + [d|deriving stock instance Show $(TH.conT typeName)|] + +deriveGeneric :: Deriver +deriveGeneric = deriver #stock_Generic \RecordDesc {typeName} -> + [d|deriving stock instance Generic $(TH.conT typeName)|] diff --git a/Records/EDSL/Deriving/Type.hs b/Records/EDSL/Deriving/Type.hs new file mode 100644 --- /dev/null +++ b/Records/EDSL/Deriving/Type.hs @@ -0,0 +1,52 @@ +module Records.EDSL.Deriving.Type ( + Deriver (..), + DeriverFn, + runDeriver, + deriver, + Id, +) +where + +import Data.Map.Strict qualified as Map +import GHC.TypeLits +import Language.Haskell.TH qualified as TH +import Optics +import Records.EDSL.Description +import Relude + +-- | Unique 'Id' for a deriver +-- +-- (Not actually checked for uniqueness on construction or anything) +newtype Id = Id Text deriving stock (Eq, Ord, Show) + +instance (KnownSymbol k) => IsLabel k Id where + fromLabel = Id (toText (symbolVal (Proxy @k))) + +-- | Derivers by their unique 'Id' +newtype Deriver = Deriver + { derivations :: Map Id DeriverFn + } + deriving stock (Generic) + deriving anyclass (GenericLabelOptics) + +type DeriverFn = RecordDesc TH.Name -> TH.DecsQ + +runDeriver :: Deriver -> DeriverFn +runDeriver Deriver {derivations} self = foldMap ($ self) derivations + +instance Monoid Deriver where + mempty = Deriver Map.empty + +instance Semigroup Deriver where + Deriver a <> Deriver b = Deriver (a <> b) + +type instance Index Deriver = Id +type instance IxValue Deriver = DeriverFn +instance Ixed Deriver +instance At Deriver where at k = #derivations % at k + +-- | Make a single 'Deriver' +-- +-- See "Records.EDSL.Deriving.Stock" for easy-to-understand examples +deriver :: Id -> DeriverFn -> Deriver +deriver p d = Deriver (Map.singleton p d) diff --git a/Records/EDSL/Description.hs b/Records/EDSL/Description.hs new file mode 100644 --- /dev/null +++ b/Records/EDSL/Description.hs @@ -0,0 +1,215 @@ +{- HLINT ignore "Use camelCase" -} +module Records.EDSL.Description where + +import Data.Char (toLower, toUpper) +import Data.Maybe +import Data.Text qualified as Text +import Language.Haskell.Meta.Parse qualified as Meta +import Language.Haskell.TH qualified as TH +import Optics +import Relude hiding (lines) +import Text.Megaparsec as M +import Text.Megaparsec.Char qualified as M +import Text.Megaparsec.Char.Lexer qualified as L +import Witch + +data RecordDesc n = RecordDesc + { opts :: RecordOpts + , typeNameText :: Text + , typeName :: n + , constrName :: n + , description :: Maybe Description + , fields :: [FieldDesc n] + } + deriving stock (Show, Generic, Functor, Foldable, Traversable) + deriving anyclass (GenericLabelOptics) + +newtype RecordOpts = RecordOpts + { customPrefix :: Maybe Text + } + deriving stock (Show, Generic) + deriving anyclass (GenericLabelOptics) + +data TypeDesc = TypeDesc + { type_ :: TH.Type + , text :: Text + } + deriving stock (Show, Eq, Generic) + deriving anyclass (GenericLabelOptics) + +data FieldDesc n = FieldDesc + { name :: n + , nameText :: Text + , description :: Maybe Description + , type_ :: FieldType + , isOptional :: Bool + } + deriving stock (Show, Generic, Functor, Foldable, Traversable) + deriving anyclass (GenericLabelOptics) + +data FieldType + = FieldTypeAs {hask :: TypeDesc} + | FieldTypeFrom {hask, json :: TypeDesc} + | FieldTypeTryFrom {hask, json :: TypeDesc} + deriving stock (Show, Generic) + deriving anyclass (GenericLabelOptics) + +data Description = Description {isExtra :: Bool, text :: Text} + deriving stock (Show, Generic) + deriving anyclass (GenericLabelOptics) + +qFieldToExternalFormat :: FieldType -> TH.ExpQ +qFieldToExternalFormat = \case + FieldTypeAs {} -> [|identity|] + FieldTypeFrom {hask = a, json = b} + | isMaybeType a.type_ && isMaybeType b.type_ -> [|(fmap from :: $(pure a.type_) -> $(pure b.type_))|] + | otherwise -> [|(from :: $(pure a.type_) -> $(pure b.type_))|] + FieldTypeTryFrom {hask = a, json = b} + | isMaybeType a.type_ && isMaybeType b.type_ -> [|(fmap from :: $(pure a.type_) -> $(pure b.type_))|] + | otherwise -> [|(from :: $(pure a.type_) -> $(pure b.type_))|] + +qFieldFromExternalFormat :: FieldType -> TH.ExpQ +qFieldFromExternalFormat = \case + FieldTypeAs {} -> [|pure|] + FieldTypeFrom {hask = b, json = a} + | isMaybeType a.type_ && isMaybeType b.type_ -> [|(pure . (fmap from :: $(pure a.type_) -> $(pure b.type_)))|] + | otherwise -> [|(pure . (from :: $(pure a.type_) -> $(pure b.type_)))|] + FieldTypeTryFrom {hask = TypeDesc {type_ = b}, json = TypeDesc {type_ = a}} + | isMaybeType a && isMaybeType b -> + [| + maybe + (pure Nothing) + (either (fail . show) pure . (tryFrom @($(pure a)) @($(pure b)))) + |] + | otherwise -> + [|either (fail . show) pure . (tryFrom @($(pure a)) @($(pure b)))|] + +addFieldPrefixes :: RecordDesc Text -> RecordDesc Text +addFieldPrefixes r@RecordDesc {typeName, opts = RecordOpts {customPrefix}} = + r + & #fields + % mapped + % mapped + %~ \fld -> + case customPrefix of + Nothing -> (typeName & ix 0 %~ toLower) <> (fld & ix 0 %~ toUpper) + Just pfix + | Text.null pfix -> fld + | otherwise -> pfix <> (fld & ix 0 %~ toUpper) + +isMaybeType :: TH.Type -> Bool +isMaybeType = \case + TH.ConT m -> TH.nameBase m == "Maybe" + TH.AppT a _ -> isMaybeType a + TH.ParensT a -> isMaybeType a + _ -> False + +-------------------------------------------------------------------------------- +-- Parsing +-- +-- + +type P = ParsecT Void Text TH.Q + +symbol :: Text -> P () +symbol = void . L.symbol M.space + +lexeme :: P a -> P a +lexeme = L.lexeme (M.space1 <|> void (M.lookAhead (M.oneOf ("()[]{},.:" :: [Char])))) + +braces, brackets :: P a -> P a +braces = between (symbol "{") (symbol "}") +brackets = between (symbol "[") (symbol "]") + +parseName :: P Text +parseName = lexeme (toText <$> M.some M.alphaNumChar) + +newtype RecordOpt + = RO_CustomPrefix Text + +parseRecordOpts :: P RecordOpts +parseRecordOpts = + M.many parseOpt + <&> foldl' addOpt RecordOpts {customPrefix = Nothing} + where + parseOpt = + choice + [ do + symbol "--no-field-prefix" + pure (RO_CustomPrefix "") + , do + symbol "--field-prefix=" + RO_CustomPrefix <$> parseName + ] + addOpt z = \case + RO_CustomPrefix p -> z {customPrefix = Just p} + +parseRecordDescs :: P [RecordDesc Text] +parseRecordDescs = + M.some + ( M.space >> do + description <- parseDescription + symbol "record" + name <- parseName + opts <- parseRecordOpts + fields <- braces (M.sepEndBy1 (parseField <* M.space) (symbol ",")) + pure + RecordDesc + { opts + , typeNameText = name + , typeName = name + , constrName = name + , description + , fields + } + ) + +parseDescription :: P (Maybe Description) +parseDescription = M.try $ M.optional do + _ <- commentMarker + _isExtra <- isJust <$> M.try (M.optional (M.chunk "+ ")) + line1 <- M.takeWhileP Nothing (/= '\n') <* M.newline + lines <- M.many $ try do + M.hspace + commentMarker + M.takeWhileP Nothing (/= '\n') <* M.newline + let text = unlines (line1 : lines) + pure Description {isExtra = True, text} + where + commentMarker :: P () + commentMarker = void (M.chunk "--") + +parseField :: P (FieldDesc Text) +parseField = do + fdesc <- parseDescription <* M.space + fname <- parseName + symbol "::" + type_ <- do + let + parseEndOfDecl = M.chunk ",\n" <|> M.chunk "\n" + parseDelim = M.chunk " via? " <|> M.chunk " via " <|> M.lookAhead parseEndOfDecl + parseUntilEndOfDecl = M.manyTill M.anySingle (M.lookAhead parseEndOfDecl) + hask <- parseTypeDesc =<< M.manyTill M.anySingle (M.lookAhead parseDelim) + delim <- parseDelim + case delim of + " via? " -> (\json -> FieldTypeTryFrom {hask, json}) <$> (parseTypeDesc =<< parseUntilEndOfDecl) + " via " -> (\json -> FieldTypeFrom {hask, json}) <$> (parseTypeDesc =<< parseUntilEndOfDecl) + _ -> pure FieldTypeAs {hask} + pure + FieldDesc + { name = fname + , nameText = fname + , description = fdesc + , type_ + , isOptional = isMaybeType (qFieldJSONTypeDesc type_).type_ + } + where + parseTypeDesc text = case Meta.parseType text of + Right type_ -> pure TypeDesc {type_, text = Text.pack text} + Left err -> fail err + +qFieldJSONTypeDesc :: FieldType -> TypeDesc +qFieldJSONTypeDesc = \case + FieldTypeAs {hask} -> hask + FieldTypeFrom {json} -> json + FieldTypeTryFrom {json} -> json diff --git a/records-edsl-core.cabal b/records-edsl-core.cabal new file mode 100644 --- /dev/null +++ b/records-edsl-core.cabal @@ -0,0 +1,72 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.38.3. +-- +-- see: https://github.com/sol/hpack + +name: records-edsl-core +version: 0.1.0 +synopsis: Write less record boilerplate: core package +description: See https://hackage.haskell.org/packages/records-edsl +category: Records +author: Mike Ledger +maintainer: Mike Ledger +license: MPL-2.0 +license-file: LICENSE +build-type: Simple + +source-repository head + type: git + location: https://gitlab.com/combobulate.systems/records-edsl.git + +library + exposed-modules: + Records.EDSL.Declare + Records.EDSL.Deriving.HasField + Records.EDSL.Deriving.Stock + Records.EDSL.Deriving.Type + Records.EDSL.Description + hs-source-dirs: + ./ + default-extensions: + AllowAmbiguousTypes + BangPatterns + BlockArguments + DataKinds + DeriveAnyClass + DerivingStrategies + DerivingVia + DuplicateRecordFields + ExplicitForAll + GADTs + ImportQualifiedPost + LambdaCase + MultiWayIf + MultilineStrings + NamedFieldPuns + NoImplicitPrelude + NoStarIsType + OverloadedLabels + OverloadedRecordDot + OverloadedStrings + PartialTypeSignatures + PatternSynonyms + PolyKinds + RequiredTypeArguments + ScopedTypeVariables + StrictData + TemplateHaskell + TemplateHaskellQuotes + TypeApplications + TypeFamilies + ViewPatterns + build-depends: + base <5 + , haskell-src-meta <0.9 + , megaparsec <9.8 + , optics + , relude + , template-haskell <2.24 + , text + , witch + default-language: GHC2024