-- WARNING! Do not remove trailing whitespace or tabs, it's part of the test!
{-# OPTIONS_GHC -fno-warn-tabs #-}
{-# LANGUAGE PackageImports #-}
{-# LANGUAGE QuasiQuotes #-}
module QM.Spec (spec) where
import "hspec" Test.Hspec (Spec, describe, it, shouldBe)
-- local imports
import "qm-interpolated-string" Text.InterpolatedString.QM (qm)
newtype TestFoo = TestFoo {testBar :: Int} deriving (Show)
newtype TestFoo2 = TestFoo2 {test1 :: TestFoo} deriving (Show)
testFoo :: TestFoo
testFoo = TestFoo 42
testFoo2 :: TestFoo2
testFoo2 = TestFoo2 testFoo
spec :: Spec
spec = do
describe "Examples from README" $ do
it "First (decorative spacing and escaping space symbol)" $
[qm| hello world,
\ what's going on here? |]
`shouldBe` "hello world, what's going on here?"
it "Second (merging lines without spaces)" $
[qm|
it's actual
ly ignored
|]
`shouldBe` "it's actually ignored"
it "Third (explicit line breaks symbols)" $
[qm| \ You could explicitly escape indentation or\n
line breaks when you really need it! \
|] `shouldBe` " You could explicitly escape indentation or\n\
\line breaks when you really need it! "
it "Fourth (escaping interpolation blocks to show them as text)" $
[qm| {1+2} \{3+4} |] `shouldBe` "3 {3+4}"
it "Empty string" $ [qm| |] `shouldBe` ""
it "Type annotation in interpolation block" $
[qm|{10 :: Float}|] `shouldBe` "10.0"
describe "Escaping" $ do
it "Escaping interpolation symbols inside interpolation block" $ do
[qm|foo {"b{a{r"} baz|] `shouldBe` "foo b{a{r baz"
[qm|foo {"b\}a\}r"} baz|] `shouldBe` "foo b}a}r baz"
it "Escaping backslashes" $ do [qm| foo\bar |] `shouldBe` "foo\\bar"
[qm| foo\\bar |] `shouldBe` "foo\\bar"
[qm| foo\\\bar |] `shouldBe` "foo\\\\bar"
[qm| foo\\\\bar |] `shouldBe` "foo\\\\bar"
it "Escaping space by slash at EOL after space" $
[qm| foo \
bar |] `shouldBe` "foo bar"
it "Escaped spaces at the edges" $ do [qm| foo\ |] `shouldBe` "foo "
[qm|\ foo |] `shouldBe` " foo"
it "Escaping backslash itself when it makes sense" $ do
[qm| foo\nbar |] `shouldBe` "foo\nbar"
[qm| foo\\nbar |] `shouldBe` "foo\\nbar"
[qm| foo\tbar |] `shouldBe` "foo\tbar"
[qm| foo\\tbar |] `shouldBe` "foo\\tbar"
[qm| foo\ bar |] `shouldBe` "foo\tbar"
[qm| foo\\ bar |] `shouldBe` "foo\\\tbar"
[qm| foo\ bar |] `shouldBe` "foo bar"
[qm| foo\\ bar |] `shouldBe` "foo\\ bar"
[qm| foo\
bar |] `shouldBe` "foobar"
[qm| foo\\
bar |] `shouldBe` "foo\\bar"
describe "Escaping inside interpolation blocks" $ do
it "Line-breaks must be interpreted as just haskell code" $ do
[qm| {'\n'} |] `shouldBe` "\n"
[qm| {"foo\nbar"} |] `shouldBe` "foo\nbar"
[qm| {"foo\\nbar"} |] `shouldBe` "foo\\nbar"
[qm| {"foo\\\nbar"} |] `shouldBe` "foo\\\nbar"
[qm| {"foo\\\\nbar"} |] `shouldBe` "foo\\\\nbar"
it "Escaping for multiline strings" $ do
[qm| {"foo\
\bar\
\baz"} |] `shouldBe` "foobarbaz"
[qm| {"foo \
\bar\
\ baz"} |] `shouldBe` "foo bar baz"
[qm| x \
{"foo \
\bar\
\ baz"} \
y |] `shouldBe` "x foo bar baz y"
it "Escaping of close-bracket '}'" $ do
[qm| { testFoo {testBar = 9000\} } |]
`shouldBe` show testFoo {testBar = 9000}
[qm| foo{ testFoo {testBar = 9000\} }bar |]
`shouldBe` "foo" ++ show testFoo {testBar = 9000} ++ "bar"
[qm|foo{testFoo2 {test1 = (test1 testFoo2) {testBar = 9000\}\}}bar|]
`shouldBe` "foo" ++ show testFoo2 {test1 = TestFoo 9000} ++ "bar"
[qm| foo { testFoo2 {
test1 = (test1 testFoo2)
{ testBar = 9000 \}
\}
} bar |]
`shouldBe` "foo " ++ show testFoo2 {test1 = TestFoo 9000} ++ " bar"
[qm| {"\}"} |] `shouldBe` "}"
[qm| {"\\\}"} |] `shouldBe` "\\}"
[qm| {123}} |] `shouldBe` "123}"
it "When interpolation block is escaped\
\ everything must be interpreted as usual" $ do
[qm| \{ foo\nbar\\baz\} } |] `shouldBe` "{ foo\nbar\\baz\\} }"
[qm| \{ foo\
bar } |] `shouldBe` "{ foobar }"
it "Tabs characters in string inside interpolation block" $ do
[qm| {"foo\t\tbar" } |] `shouldBe` "foo\t\tbar"
[qm| {"foo bar" } |] `shouldBe` "foo\t\tbar"
[qm| {"foo\\t\tbar"} |] `shouldBe` "foo\\t\tbar"
describe "Tabs as indentation" $ do
it "Tabs is only indentation at left side" $ do
[qm|
foo bar baz
|] `shouldBe` "foo bar baz"
[qm| foo bar baz|] `shouldBe` "foo bar baz"
it "Tabs also at EOL" $ do
[qm|
foo bar baz
|] `shouldBe` "foo bar baz"
[qm| foo bar baz |] `shouldBe` "foo bar baz"
it "Escaped tabs" $ do
[qm| \tfoo|] `shouldBe` "\tfoo"
[qm| \ foo |] `shouldBe` "\tfoo"
[qm| foo \ |] `shouldBe` "foo\t\t\t"
[qm| foo \ |] `shouldBe` "foo\t\t"
[qm| foo\ |] `shouldBe` "foo\t"
it "Tails" $ do
[qm|
foo
|] `shouldBe` "foo"
[qm|
foo
|] `shouldBe` "foo"
[qm|
foo
|] `shouldBe` "foo"
describe "New README examples" $ do
it "First example" $
[qm| Hello,
world!
Pi is {floor pi}.{floor $ (pi - 3) * 100}… |]
`shouldBe` "Hello,world!Pi is 3.14…"
it "Simple usage example" $ do
let title = "Testing"
text = "Some testing text"
[qm|
<article>
<h1>{title}</h1>
<p>{text}</p>
</article>
|]
`shouldBe`
"<article><h1>Testing</h1><p>Some testing text</p></article>"
it "Can escape spaces" $
[qm| you can escape spaces
\ when you need them |]
`shouldBe`
"you can escape spaces when you need them"
it "Indentation and line breaks are ignored" $
[qm|
indentation and li
ne bre
aks are i
gno
red
|]
`shouldBe` "indentation and line breaks are ignored"
it "Escaping indentation or line breaks" $
[qm| \ You can escape indentation or\n
line breaks when you need them! \ |]
`shouldBe`
" You can escape indentation or\nline breaks when you need them! "
it "Interpolation blocks can be escaped too" $
[qm| Interpolation blocks can be escaped too: {1+2} \{3+4} |]
`shouldBe`
"Interpolation blocks can be escaped too: 3 {3+4}"
it "Interpolation" $ [qm| foo {1+2} |] `shouldBe` "foo 3"
it "Haddock example" $ do
[qm| foo {'b':'a':'r':""}
\ baz |] `shouldBe` "foo bar baz"
[qm| foo
\ {'b':'a':'r':""}
\ baz |] `shouldBe` "foo bar baz"
[qm| foo {'b':'a':'r':""}
baz |] `shouldBe` "foo barbaz"