README.md

cats-parse-xml

A simple cats-parse based XML parser.

• ast.scala defines the model:
  • a top-level XmlDoc object, which captures an optional header string (<?xml ... >), and a XmlNode possibly surrounded by comments.
  • XmlNode has a name, a set of attributes, and a list of child segments.
  • There are four kinds of segments: Node(XmlNode), Text(String), Comment(String), and CData(String).
• parser.scala defines the top-level parser xmlDoc (which generates XmlDoc), and various supporting parsers.
• some.test.scala defines various tests.
• main.scala defines a simple command-line program that parses a given file or all xml files under a given directory.

tests

scala-cli test .

XmlParserTests:
xmlHeader
- should succeed
xmlNode - simple
- should succeed with no attributes
- should succeed with attributes
andBody
- should succeed with correct closing tag
- should fail with incorrect closing tag
xmlNode
- should succeed with empty body
- should succeed with body
- should succeed with multiple-level body
- should succeed with text segments
- should succeed with namespace declarations
xmlDoc
- should succeed with no file header
- should succeed with file header
Run completed in 372 milliseconds.
Total number of tests run: 12
Suites: completed 1, aborted 0
Tests: succeeded 12, failed 0, canceled 0, ignored 0, pending 0
All tests passed.

program

scala-cli run . -- --file example.xml --showAst

XmlDoc(
  header = None,
  preComments = List(),
  xmlNode = XmlNode(
    tagName = "Foo",
    attributes = Map("a" -> "A"),
    segments = List(
      Text(
        text = """
  """
      ),
      Node(
        node = XmlNode(
          tagName = "Baz",
          attributes = Map(),
          segments = List(
            Text(
              text = """
    """
            ),
            Comment(comment = " hi "),
            Text(
              text = """
  """
            )
          )
        )
      ),
      Text(
        text = """
  """
      ),
      CData(text = "x<y> z"),
      Text(
        text = """
"""
      )
    )
  ),
  postComments = List()
)

scala-cli run . -- --dir .

Successes: 1
 Failures: 0