Skip to content

sgf-parsing: Explain all current test cases + Add individual tests of escaping/whitespace behaviour #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2022
Merged

sgf-parsing: Explain all current test cases + Add individual tests of escaping/whitespace behaviour #1025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28bd50a
sgf-parsing: Explain all current test cases
petertseng Nov 28, 2021
654f365
sgf-parsing: Add individual tests of escaping/whitespace behaviour
petertseng Nov 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions exercises/practice/sgf-parsing/.meta/examples/success-standard/src/Sgf.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module Sgf (

import Control.Applicative (many)
import Data.Attoparsec.Text (Parser, anyChar, char, many1, parseOnly, satisfy)
import Data.Char (isUpper, isSpace)
import Data.Char (isUpper)
import Data.Map (Map)
import qualified Data.Map as Map
import Data.Tree (Tree(..))
Expand Down Expand Up @@ -51,7 +51,7 @@ val = char '[' *> worker [] False
']' | not bs -> return . T.pack . reverse $ acc
'\\' | not bs -> worker acc True
'\n' | bs -> worker acc False -- remove soft newline
_ | isSpace c -> worker (' ' : acc) False
'\t' -> worker (' ' : acc) False
_ -> worker (c : acc) False

-- | Create an 'SgfTree' from a list of nodes and subtrees.
Expand Down
34 changes: 33 additions & 1 deletion exercises/practice/sgf-parsing/test/Tests.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,50 @@ specs = describe "parseSgf" $ for_ cases test
assertion = parseSgf input `shouldBe` fmap fromList <$> expected

cases = [ ("" , Nothing )
-- error: tree with no nodes
, ("()" , Nothing )
-- error: node without tree
, (";" , Nothing )
-- error: node without properties
, ("(;)" , Just $ Node [] [] )
-- single-node tree
, ("(;A[B])" , Just $ Node [("A", ["B"])] [] )
-- multiple properties
, ("(;A[b]C[d])" , Just $ Node [("A", ["b"]), ("C", ["d"])] [] )
-- error: properties without value
, ("(;A)" , Nothing )
-- error: lowercase property identifier
, ("(;a[b])" , Nothing )
-- error: mixed-case property identifier
, ("(;Aa[b])" , Nothing )
-- two nodes
, ("(;A[B];B[C])" , Just $ Node [("A", ["B"])] [ Node [("B", ["C"])] [] ] )
-- two child trees
, ("(;A[B](;B[C])(;C[D]))" , Just $ Node [("A", ["B"])] [ Node [("B", ["C"])] []
, Node [("C", ["D"])] [] ] )
-- multiple property values
, ("(;A[b][c][d])" , Just $ Node [("A", ["b", "c", "d" ])] [] )
, ("(;A[\\]b\nc\\\nd\t\te\\\\ \\\n\\]])", Just $ Node [("A", ["]b cd e\\ ]"])] [] ) ]
-- within property values, whitespace characters such as tab are converted to spaces
, ("(;A[hello\t\tworld])" , Just $ Node [("A", ["hello world"])] [] )
-- within property values, newlines remain as newlines
, ("(;A[hello\n\nworld])" , Just $ Node [("A", ["hello\n\nworld"])] [] )
-- escaped closing bracket within property value becomes just a closing bracket
, ("(;A[\\]])" , Just $ Node [("A", ["]"])] [] )
-- escaped backslash in property value becomes just a backslash
, ("(;A[\\\\])" , Just $ Node [("A", ["\\"])] [] )
-- opening bracket within property value doesn't need to be escaped
, ("(;A[x[y\\]z][foo]B[bar];C[baz])" , Just $ Node [("A", ["x[y]z", "foo"]), ("B", ["bar"])] [ Node [("C", ["baz"])] [] ] )
-- semicolon in property value doesn't need to be escaped
, ("(;A[a;b][foo]B[bar];C[baz])" , Just $ Node [("A", ["a;b", "foo"]), ("B", ["bar"])] [ Node [("C", ["baz"])] [] ] )
-- parentheses in property value don't need to be escaped
, ("(;A[x(y)z][foo]B[bar];C[baz])" , Just $ Node [("A", ["x(y)z", "foo"]), ("B", ["bar"])] [ Node [("C", ["baz"])] [] ] )
-- escaped tab in property value is converted to space
, ("(;A[hello\\\tworld])" , Just $ Node [("A", ["hello world"])] [] )
-- escaped newline in property value is converted to nothing at all
, ("(;A[hello\\\nworld])" , Just $ Node [("A", ["helloworld"])] [] )
-- escaped t and n in property value are just letters, not whitespace
, ("(;A[\\t = t and \\n = n])" , Just $ Node [("A", ["t = t and n = n"])] [] )
-- mixing various kinds of whitespace and escaped characters in property value
, ("(;A[\\]b\nc\\\nd\t\te\\\\ \\\n\\]])", Just $ Node [("A", ["]b\ncd e\\ ]"])] [] ) ]

-- b74debc3be24b5c81650189935c9bbfa019b367e