neat-interpolation 0.3.2.6 → 0.5.1.4
raw patch · 8 files changed
Files
- CHANGELOG.md +11/−0
- Setup.hs +0/−2
- library/NeatInterpolation.hs +47/−31
- library/NeatInterpolation/Parsing.hs +16/−16
- library/NeatInterpolation/Prelude.hs +21/−24
- library/NeatInterpolation/String.hs +20/−28
- neat-interpolation.cabal +121/−36
- test/Main.hs +45/−37
+ CHANGELOG.md view
@@ -0,0 +1,11 @@+## Version 0.5.1.4++- Support GHC 9.8.++## Version 0.5++- Isolated the `trimming` and `untrimming` variations of quasi-quoter.++## Version 0.4++- Changed the behaviour of the quasi-quoter in regards to trailing whitespace. Before it was always adding newline in the end, now it always completely removes all the trailing whitespace.
− Setup.hs
@@ -1,2 +0,0 @@-import Distribution.Simple-main = defaultMain
library/NeatInterpolation.hs view
@@ -14,7 +14,7 @@ -- > -- > f :: Text -> Text -> Text -- > f a b =--- > [text|+-- > [trimming| -- > function(){ -- > function(){ -- > $a@@ -25,7 +25,7 @@ -- -- Executing the following: ----- > main = T.putStrLn $ f "1" "2"+-- > main = Text.putStrLn $ f "1" "2" -- -- will produce this (notice the reduced indentation compared to how it was -- declared):@@ -39,7 +39,7 @@ -- -- Now let's test it with multiline string parameters: ----- > main = T.putStrLn $ f+-- > main = Text.putStrLn $ f -- > "{\n indented line\n indented line\n}" -- > "{\n indented line\n indented line\n}" --@@ -64,7 +64,7 @@ -- If you need to separate variable placeholder from the following text to -- prevent treating the rest of line as variable name, use escaped variable: ----- > f name = [text|this_could_be_${name}_long_identifier|]+-- > f name = [trimming|this_could_be_${name}_long_identifier|] -- -- So --@@ -73,55 +73,71 @@ -- If you want to write something that looks like a variable but should be -- inserted as-is, escape it with another @$@: ----- > f word = [text|$$my ${word} $${string}|]+-- > f word = [trimming|$$my ${word} $${string}|] -- -- results in ----- > f "funny" == "$my funny ${string}|]-module NeatInterpolation (text) where--import NeatInterpolation.Prelude+-- > f "funny" == "$my funny ${string}"+module NeatInterpolation (trimming, untrimming, text) where +import qualified Data.Text as Text import Language.Haskell.TH import Language.Haskell.TH.Quote hiding (quoteExp)+import qualified NeatInterpolation.Parsing as Parsing+import NeatInterpolation.Prelude+import qualified NeatInterpolation.String as String -import NeatInterpolation.String-import NeatInterpolation.Parsing+expQQ :: (String -> Q Exp) -> QuasiQuoter+expQQ quoteExp = QuasiQuoter quoteExp notSupported notSupported notSupported+ where+ notSupported _ = fail "Quotation in this context is not supported" -import Data.Text (Text)-import qualified Data.Text as T+-- |+-- An alias to `trimming` for backward-compatibility.+text :: QuasiQuoter+text = trimming +-- |+-- Trimmed quasiquoter variation.+-- Same as `untrimming`, but also+-- removes the leading and trailing whitespace.+trimming :: QuasiQuoter+trimming = expQQ (quoteExp . String.trim . String.unindent . String.tabsToSpaces) -- |--- The quasiquoter.-text :: QuasiQuoter-text = QuasiQuoter quoteExp notSupported notSupported notSupported where- notSupported _ = fail "Quotation in this context is not supported"+-- Untrimmed quasiquoter variation.+-- Unindents the quoted template and converts tabs to spaces.+untrimming :: QuasiQuoter+untrimming = expQQ (quoteExp . String.unindent . String.tabsToSpaces) indentQQPlaceholder :: Int -> Text -> Text-indentQQPlaceholder indent text = case T.lines text of- head:tail -> T.intercalate (T.singleton '\n') $- head : map (T.replicate indent (T.singleton ' ') <>) tail+indentQQPlaceholder indent text = case Text.lines text of+ head : tail ->+ Text.intercalate (Text.singleton '\n') $+ head : map (Text.replicate indent (Text.singleton ' ') <>) tail [] -> text quoteExp :: String -> Q Exp quoteExp input =- case parseLines $ normalizeQQInput input of+ case Parsing.parseLines input of Left e -> fail $ show e- Right lines -> sigE (appE [|T.unlines|] $ listE $ map lineExp lines)- [t|Text|]+ Right lines ->+ sigE+ (appE [|Text.intercalate (Text.singleton '\n')|] $ listE $ map lineExp lines)+ [t|Text|] -lineExp :: Line -> Q Exp-lineExp (Line indent contents) =+lineExp :: Parsing.Line -> Q Exp+lineExp (Parsing.Line indent contents) = case contents of- [] -> [| T.empty |]+ [] -> [|Text.empty|] [x] -> toExp x- xs -> appE [|T.concat|] $ listE $ map toExp xs- where toExp = contentExp (fromIntegral indent)+ xs -> appE [|Text.concat|] $ listE $ map toExp xs+ where+ toExp = contentExp (fromIntegral indent) -contentExp :: Integer -> LineContent -> Q Exp-contentExp _ (LineContentText text) = appE [|T.pack|] (stringE text)-contentExp indent (LineContentIdentifier name) = do+contentExp :: Integer -> Parsing.LineContent -> Q Exp+contentExp _ (Parsing.LineContentText text) = appE [|Text.pack|] (stringE text)+contentExp indent (Parsing.LineContentIdentifier name) = do valueName <- lookupValueName name case valueName of Just valueName -> do
library/NeatInterpolation/Parsing.hs view
@@ -1,37 +1,37 @@ module NeatInterpolation.Parsing where +import Data.Text (pack) import NeatInterpolation.Prelude hiding (many, some, try, (<|>))-import Data.Text (Text, pack)-import Text.Megaparsec hiding (Line)+import Text.Megaparsec import Text.Megaparsec.Char -data Line =- Line {lineIndent :: Int, lineContents :: [LineContent]}+data Line = Line {lineIndent :: Int, lineContents :: [LineContent]} deriving (Show) -data LineContent =- LineContentText [Char] |- LineContentIdentifier [Char]+data LineContent+ = LineContentText [Char]+ | LineContentIdentifier [Char] deriving (Show) type Parser = Parsec Void String -- | Pretty parse exception for parsing lines. newtype ParseException = ParseException Text- deriving (Show, Eq)+ deriving (Show, Eq) parseLines :: [Char] -> Either ParseException [Line] parseLines input = case parse lines "NeatInterpolation.Parsing.parseLines" input of- Left err -> Left $ ParseException $ pack $ errorBundlePretty err- Right output -> Right output+ Left err -> Left $ ParseException $ pack $ errorBundlePretty err+ Right output -> Right output where lines :: Parser [Line] lines = sepBy line newline <* eof line = Line <$> countIndent <*> many content countIndent = fmap length $ try $ lookAhead $ many $ char ' ' content = try escapedDollar <|> try identifier <|> contentText- identifier = fmap LineContentIdentifier $- char '$' *> (try identifier' <|> between (char '{') (char '}') identifier')+ identifier =+ fmap LineContentIdentifier $+ char '$' *> (try identifier' <|> between (char '{') (char '}') identifier') escapedDollar = fmap LineContentText $ char '$' *> count 1 (char '$') identifier' = some (alphaNumChar <|> char '\'' <|> char '_') contentText = do@@ -41,7 +41,7 @@ else return $ LineContentText $ text where end =- (void $ try $ lookAhead escapedDollar) <|>- (void $ try $ lookAhead identifier) <|>- (void $ try $ lookAhead newline) <|>- eof+ (void $ try $ lookAhead escapedDollar)+ <|> (void $ try $ lookAhead identifier)+ <|> (void $ try $ lookAhead newline)+ <|> eof
library/NeatInterpolation/Prelude.hs view
@@ -1,20 +1,19 @@+{-# LANGUAGE CPP #-}+ module NeatInterpolation.Prelude-( - module Exports,-)+ ( module Exports,+ ) where --- base-------------------------- import Control.Applicative as Exports import Control.Arrow as Exports hiding (first, second) import Control.Category as Exports import Control.Concurrent as Exports import Control.Exception as Exports-import Control.Monad as Exports hiding (fail, mapM_, sequence_, forM_, msum, mapM, sequence, forM)-import Control.Monad.IO.Class as Exports+import Control.Monad as Exports hiding (fail, forM, forM_, mapM, mapM_, msum, sequence, sequence_) import Control.Monad.Fail as Exports import Control.Monad.Fix as Exports hiding (fix)+import Control.Monad.IO.Class as Exports import Control.Monad.ST as Exports import Data.Bifunctor as Exports import Data.Bits as Exports@@ -28,21 +27,25 @@ import Data.Fixed as Exports import Data.Foldable as Exports hiding (toList) import Data.Function as Exports hiding (id, (.))+#if MIN_VERSION_base(4,19,0)+import Data.Functor as Exports hiding (unzip)+#else import Data.Functor as Exports-import Data.Functor.Contravariant as Exports+#endif import Data.Functor.Identity as Exports-import Data.Int as Exports import Data.IORef as Exports+import Data.Int as Exports import Data.Ix as Exports-import Data.List as Exports hiding (sortOn, isSubsequenceOf, uncons, concat, foldr, foldl1, maximum, minimum, product, sum, all, and, any, concatMap, elem, foldl, foldr1, notElem, or, find, maximumBy, minimumBy, mapAccumL, mapAccumR, foldl')+import Data.List as Exports hiding (all, and, any, concat, concatMap, elem, find, foldl, foldl', foldl1, foldr, foldr1, isSubsequenceOf, mapAccumL, mapAccumR, maximum, maximumBy, minimum, minimumBy, notElem, or, product, sortOn, sum, uncons) import Data.Maybe as Exports-import Data.Monoid as Exports hiding (Last(..), First(..), (<>))+import Data.Monoid as Exports hiding (First (..), Last (..), (<>)) import Data.Ord as Exports import Data.Proxy as Exports import Data.Ratio as Exports-import Data.Semigroup as Exports import Data.STRef as Exports+import Data.Semigroup as Exports import Data.String as Exports+import Data.Text as Exports (Text) import Data.Traversable as Exports import Data.Tuple as Exports import Data.Unique as Exports@@ -53,13 +56,12 @@ import Foreign.ForeignPtr as Exports import Foreign.Ptr as Exports import Foreign.StablePtr as Exports-import Foreign.Storable as Exports hiding (sizeOf, alignment)-import GHC.Conc as Exports hiding (withMVar, threadWaitWriteSTM, threadWaitWrite, threadWaitReadSTM, threadWaitRead)-import GHC.Exts as Exports (lazy, inline, sortWith, groupWith, IsList(..))+import Foreign.Storable as Exports hiding (alignment, sizeOf)+import GHC.Conc as Exports hiding (threadWaitRead, threadWaitReadSTM, threadWaitWrite, threadWaitWriteSTM, withMVar)+import GHC.Exts as Exports (IsList (..), groupWith, inline, lazy, sortWith) import GHC.Generics as Exports (Generic, Generic1) import GHC.IO.Exception as Exports import Numeric as Exports-import Prelude as Exports hiding (fail, concat, foldr, mapM_, sequence_, foldl1, maximum, minimum, product, sum, all, and, any, concatMap, elem, foldl, foldr1, notElem, or, mapM, sequence, id, (.)) import System.Environment as Exports import System.Exit as Exports import System.IO as Exports@@ -68,12 +70,7 @@ import System.Mem as Exports import System.Mem.StableName as Exports import System.Timeout as Exports-import Text.ParserCombinators.ReadP as Exports (ReadP, ReadS, readP_to_S, readS_to_P)-import Text.ParserCombinators.ReadPrec as Exports (ReadPrec, readPrec_to_P, readP_to_Prec, readPrec_to_S, readS_to_Prec)-import Text.Printf as Exports (printf, hPrintf)-import Text.Read as Exports (Read(..), readMaybe, readEither)+import Text.Printf as Exports (hPrintf, printf)+import Text.Read as Exports (Read (..), readEither, readMaybe) import Unsafe.Coerce as Exports---- text---------------------------import Data.Text as Exports (Text)+import Prelude as Exports hiding (all, and, any, concat, concatMap, elem, fail, foldl, foldl1, foldr, foldr1, id, mapM, mapM_, maximum, minimum, notElem, or, product, sequence, sequence_, sum, (.))
library/NeatInterpolation/String.hs view
@@ -2,44 +2,36 @@ import NeatInterpolation.Prelude --normalizeQQInput :: [Char] -> [Char]-normalizeQQInput = trim . unindent' . tabsToSpaces- where- unindent' :: [Char] -> [Char]- unindent' s =- case lines s of- head:tail -> - let - unindentedHead = dropWhile (== ' ') head - minimumTailIndent = minimumIndent . unlines $ tail- unindentedTail = case minimumTailIndent of- Just indent -> map (drop indent) tail- Nothing -> tail- in unlines $ unindentedHead : unindentedTail- [] -> []+unindent :: [Char] -> [Char]+unindent s =+ case lines s of+ head : tail ->+ let unindentedHead = dropWhile (== ' ') head+ minimumTailIndent = minimumIndent . unlines $ tail+ unindentedTail = case minimumTailIndent of+ Just indent -> map (drop indent) tail+ Nothing -> tail+ in unlines $ unindentedHead : unindentedTail+ [] -> [] trim :: [Char] -> [Char] trim = dropWhileRev isSpace . dropWhile isSpace dropWhileRev :: (a -> Bool) -> [a] -> [a]-dropWhileRev p = foldr (\x xs -> if p x && null xs then [] else x:xs) []--unindent :: [Char] -> [Char]-unindent s =- case minimumIndent s of- Just indent -> unlines . map (drop indent) . lines $ s- Nothing -> s+dropWhileRev p = foldr (\x xs -> if p x && null xs then [] else x : xs) [] tabsToSpaces :: [Char] -> [Char]-tabsToSpaces ('\t':tail) = " " ++ tabsToSpaces tail-tabsToSpaces (head:tail) = head : tabsToSpaces tail+tabsToSpaces ('\t' : tail) = " " ++ tabsToSpaces tail+tabsToSpaces (head : tail) = head : tabsToSpaces tail tabsToSpaces [] = [] minimumIndent :: [Char] -> Maybe Int-minimumIndent = - listToMaybe . sort . map lineIndent - . filter (not . null . dropWhile isSpace) . lines+minimumIndent =+ listToMaybe+ . sort+ . map lineIndent+ . filter (not . null . dropWhile isSpace)+ . lines -- | Amount of preceding spaces on first line lineIndent :: [Char] -> Int
neat-interpolation.cabal view
@@ -1,53 +1,138 @@-name: neat-interpolation-version: 0.3.2.6-synopsis: A quasiquoter for neat and simple multiline text interpolation+cabal-version: 3.0+name: neat-interpolation+version: 0.5.1.4+synopsis:+ Quasiquoter for neat and simple multiline text interpolation+ description:- A quasiquoter for producing Text values with support for+ Quasiquoter for producing Text values with support for a simple interpolation of input values. It removes the excessive indentation from the input and accurately manages the indentation of all lines of the interpolated variables.-category: String, QuasiQuotes-license: MIT-license-file: LICENSE-copyright: (c) 2013, Nikita Volkov-author: Nikita Volkov <nikita.y.volkov@mail.ru>-maintainer: Nikita Volkov <nikita.y.volkov@mail.ru>-homepage: https://github.com/nikita-volkov/neat-interpolation-bug-reports: https://github.com/nikita-volkov/neat-interpolation/issues-build-type: Simple-cabal-version: >=1.10 +category: String, QuasiQuotes+license: MIT+license-file: LICENSE+copyright: (c) 2013, Nikita Volkov+author: Nikita Volkov <nikita.y.volkov@mail.ru>+maintainer: Nikita Volkov <nikita.y.volkov@mail.ru>+homepage: https://github.com/nikita-volkov/neat-interpolation+bug-reports: https://github.com/nikita-volkov/neat-interpolation/issues+build-type: Simple+extra-source-files: CHANGELOG.md+ source-repository head- type: git+ type: git location: git://github.com/nikita-volkov/neat-interpolation.git library- hs-source-dirs: library- default-extensions: BangPatterns, BinaryLiterals, BlockArguments, ConstraintKinds, DataKinds, DefaultSignatures, DeriveDataTypeable, DeriveFoldable, DeriveFunctor, DeriveGeneric, DeriveTraversable, DuplicateRecordFields, EmptyDataDecls, FlexibleContexts, FlexibleInstances, FunctionalDependencies, GADTs, GeneralizedNewtypeDeriving, HexFloatLiterals, LambdaCase, LiberalTypeSynonyms, MagicHash, MultiParamTypeClasses, MultiWayIf, NoImplicitPrelude, NoMonomorphismRestriction, NumericUnderscores, OverloadedLists, OverloadedStrings, PatternGuards, PatternSynonyms, ParallelListComp, QuasiQuotes, RankNTypes, RecordWildCards, ScopedTypeVariables, StandaloneDeriving, StrictData, TemplateHaskell, TupleSections, TypeApplications, TypeFamilies, TypeOperators, UnboxedTuples- default-language: Haskell2010- exposed-modules:- NeatInterpolation+ hs-source-dirs: library+ default-extensions:+ NoImplicitPrelude+ NoMonomorphismRestriction+ BangPatterns+ BinaryLiterals+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveDataTypeable+ DeriveFoldable+ DeriveFunctor+ DeriveGeneric+ DeriveTraversable+ DuplicateRecordFields+ EmptyDataDecls+ FlexibleContexts+ FlexibleInstances+ FunctionalDependencies+ GADTs+ GeneralizedNewtypeDeriving+ LambdaCase+ LiberalTypeSynonyms+ MagicHash+ MultiParamTypeClasses+ MultiWayIf+ OverloadedLists+ OverloadedStrings+ ParallelListComp+ PatternGuards+ PatternSynonyms+ QuasiQuotes+ RankNTypes+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ StrictData+ TemplateHaskell+ TupleSections+ TypeApplications+ TypeFamilies+ TypeOperators+ UnboxedTuples++ default-language: Haskell2010+ exposed-modules: NeatInterpolation other-modules: NeatInterpolation.Parsing NeatInterpolation.Prelude NeatInterpolation.String+ build-depends:- base >=4.9 && <5,- megaparsec >=7 && <9,- template-haskell >=2.8 && <3,- text ==1.*+ , base >=4.9 && <5+ , megaparsec >=7 && <10+ , template-haskell >=2.8 && <3+ , text >=1 && <3 test-suite test- type: exitcode-stdio-1.0- hs-source-dirs: test- default-extensions: BangPatterns, BinaryLiterals, BlockArguments, ConstraintKinds, DataKinds, DefaultSignatures, DeriveDataTypeable, DeriveFoldable, DeriveFunctor, DeriveGeneric, DeriveTraversable, DuplicateRecordFields, EmptyDataDecls, FlexibleContexts, FlexibleInstances, FunctionalDependencies, GADTs, GeneralizedNewtypeDeriving, HexFloatLiterals, LambdaCase, LiberalTypeSynonyms, MagicHash, MultiParamTypeClasses, MultiWayIf, NoImplicitPrelude, NoMonomorphismRestriction, NumericUnderscores, OverloadedLists, OverloadedStrings, PatternGuards, PatternSynonyms, ParallelListComp, QuasiQuotes, RankNTypes, RecordWildCards, ScopedTypeVariables, StandaloneDeriving, StrictData, TemplateHaskell, TupleSections, TypeApplications, TypeFamilies, TypeOperators, UnboxedTuples- default-language: Haskell2010- main-is: Main.hs+ type: exitcode-stdio-1.0+ hs-source-dirs: test+ default-extensions:+ NoImplicitPrelude+ NoMonomorphismRestriction+ BangPatterns+ BinaryLiterals+ ConstraintKinds+ DataKinds+ DefaultSignatures+ DeriveDataTypeable+ DeriveFoldable+ DeriveFunctor+ DeriveGeneric+ DeriveTraversable+ DuplicateRecordFields+ EmptyDataDecls+ FlexibleContexts+ FlexibleInstances+ FunctionalDependencies+ GADTs+ GeneralizedNewtypeDeriving+ LambdaCase+ LiberalTypeSynonyms+ MagicHash+ MultiParamTypeClasses+ MultiWayIf+ OverloadedLists+ OverloadedStrings+ ParallelListComp+ PatternGuards+ PatternSynonyms+ QuasiQuotes+ RankNTypes+ RecordWildCards+ ScopedTypeVariables+ StandaloneDeriving+ StrictData+ TemplateHaskell+ TupleSections+ TypeApplications+ TypeFamilies+ TypeOperators+ UnboxedTuples++ default-language: Haskell2010+ main-is: Main.hs build-depends:- neat-interpolation,- QuickCheck >=2.13 && <3,- quickcheck-instances >=0.3.22 && <0.4,- rerebase <2,- tasty >=1.2.3 && <2,- tasty-hunit >=0.10.0.2 && <0.11,- tasty-quickcheck >=0.10.1 && <0.11+ , neat-interpolation+ , rerebase <2+ , tasty >=1.2.3 && <2+ , tasty-hunit >=0.10.0.2 && <0.11
test/Main.hs view
@@ -1,21 +1,17 @@ module Main where -import Prelude hiding (choose)-import Test.QuickCheck.Instances+import NeatInterpolation import Test.Tasty-import Test.Tasty.Runners import Test.Tasty.HUnit-import Test.Tasty.QuickCheck-import NeatInterpolation-import qualified Test.QuickCheck as QuickCheck-import qualified Test.QuickCheck.Property as QuickCheck-+import Prelude hiding (choose) -main = defaultMain $ testGroup "" $- [- testCase "Demo" $ let- template a b = - [text|+main :: IO ()+main =+ defaultMain $+ testGroup "" $+ [ testCase "Demo" $+ let template a b =+ [trimming| function(){ function(){ $a@@ -23,20 +19,20 @@ return $b } |]- a = "{\n indented line\n indented line\n}"- in assertEqual ""- "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return {\n indented line\n indented line\n }\n}\n"- (template a a)- ,- testCase "Isolation" $ let- isolated name = [text|this_could_be_${name}_long_identifier|]- in assertEqual ""- "this_could_be_one_long_identifier\n"- (isolated "one")- ,- testCase "Escaping" $ let- template a b = - [text|+ a = "{\n indented line\n indented line\n}"+ in assertEqual+ ""+ "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return {\n indented line\n indented line\n }\n}"+ (template a a),+ testCase "Isolation" $+ let isolated name = [trimming|this_could_be_${name}_long_identifier|]+ in assertEqual+ ""+ "this_could_be_one_long_identifier"+ (isolated "one"),+ testCase "Escaping 1" $+ let template a b =+ [trimming| function(){ function(){ $a@@ -44,13 +40,25 @@ return "$$b" } |]- escaped name = [text|this_could_be_$$${name}$$_long_identifier|]- a = "{\n indented line\n indented line\n}"- in do- assertEqual ""- "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return \"$b\"\n}\n"- (template a a)- assertEqual ""- "this_could_be_$one$_long_identifier\n"- (escaped "one")- ]+ a = "{\n indented line\n indented line\n}"+ in assertEqual+ ""+ "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return \"$b\"\n}"+ (template a a),+ testCase "Escaping 2" $+ let escaped name = [trimming|this_could_be_$$${name}$$_long_identifier|]+ in assertEqual+ ""+ "this_could_be_$one$_long_identifier"+ (escaped "one"),+ testCase "Deindentation" $+ let template fieldName className =+ [trimming|+ * @param $fieldName value of the {@code $fieldName} property of+ the {@code $className} case+ |]+ in assertEqual+ ""+ "* @param a value of the {@code a} property of\n the {@code b} case"+ (template "a" "b")+ ]