Skip to content
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.

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

Organize to standard Daffodil test layout + minor updates #6

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
target
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The current logical structure of the XML schema of TextGrid files is pictured be
<intervalNum>1</intervalNum>
<xMin>0</xMin>
<xMax>2</xMax>
<text />
<text xsi:nil="true" />
</interval>
</intervals>
</item>
Expand All @@ -63,17 +63,21 @@ The example data originates from the [Phonetic Corpus of Estonian Spontaneous Sp

## Creating XML from Praat TextGrid files

The DFDL schema has been developed and tested using the open source tool [Daffodil](https://opensource.ncsa.illinois.edu/confluence/display/DFDL).
The DFDL schema has been developed and tested using the open source tool [Apache Daffodil](https://daffodil.apache.org).

Parsing the example TextGrid file.
```shell
$ ../bin/daffodil parse --schema ./PraatTextGrid.dfdl.xsd ./examples/ekskfk_miski_1.TextGrid
$ daffodil parse -TsuppressSchemaDefinitionWarnings=encodingErrorPolicyError \
--schema src/main/resources/com/github/keeleleek/praattextgrid/PraatTextGrid.dfdl.xsd \
src/test/resources/examples/ekskfk_miski_1.TextGrid
```

## Creating Praat TextGrid files from XML

Un-parsing the parsed example XML infoset back to TextGrid text file.

```shell
$ ../bin/daffodil unparse --schema ./PraatTextGrid.dfdl.xsd ./examples/ekskfk_miski_1.tdml
$ daffodil unparse -TsuppressSchemaDefinitionWarnings=encodingErrorPolicyError \
--schema src/main/resources/com/github/keeleleek/praattextgrid/PraatTextGrid.dfdl.xsd \
src/test/resources/examples/ekskfk_miski_1.TextGrid.xml
```
17 changes: 17 additions & 0 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name := "dfdl-praat-textgrid"

organization := "com.github.keeleleek"

version := "0.0.1-SNAPSHOT"

scalaVersion := "2.12.11"

libraryDependencies ++= Seq(
"org.apache.daffodil" %% "daffodil-tdml-processor" % "2.6.0" % "test",
"com.novocode" % "junit-interface" % "0.11" % "test",
"junit" % "junit" % "4.12" % "test",
)

testOptions += Tests.Argument(TestFrameworks.JUnit, "-v")

crossPaths := false
1 change: 1 addition & 0 deletions project/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sbt.version=1.3.9
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@
xmlns:dfdl="http://www.ogf.org/dfdl/dfdl-1.0/"
xmlns:ex="http://example.com"
targetNamespace="http://example.com"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
elementFormDefault="qualified">

<xs:include schemaLocation="lib/built-in-formats.xsd" />
<xs:include schemaLocation="built-in-formats.xsd" />

<xs:annotation>
<xs:appinfo source="http://www.ogf.org/dfdl/">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
utf16Width="fixed" textStandardDecimalSeparator="."
textStandardGroupingSeparator="," textStandardExponentRep="E"
textStandardZeroRep="0" textStandardInfinityRep="Inf"
textStandardNaNRep="NaN" textNumberPattern="#,##0.###;-#,##0.###"
textStandardNaNRep="NaN" textNumberPattern="#,##0.###############;-#,##0.###############"
textNumberRounding="explicit" textNumberRoundingMode="roundUnnecessary"
textNumberRoundingIncrement="0" decimalSigned="yes"/>
</dfdl:defineFormat>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<ex:praat xmlns:ex="http://example.com">
<ex:praat xmlns:ex="http://example.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ex:fileType>ooTextFile</ex:fileType>
<ex:objectClass>TextGrid</ex:objectClass>
<ex:xMin>0.0</ex:xMin>
Expand Down Expand Up @@ -82,7 +82,7 @@
<ex:intervalNum>2</ex:intervalNum>
<ex:xMin>0.061199346418562</ex:xMin>
<ex:xMax>0.40788261011471</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>3</ex:intervalNum>
Expand Down Expand Up @@ -260,7 +260,7 @@
<ex:intervalNum>2</ex:intervalNum>
<ex:xMin>0.061199346418562</ex:xMin>
<ex:xMax>0.40788261011471</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>3</ex:intervalNum>
Expand Down Expand Up @@ -438,7 +438,7 @@
<ex:intervalNum>2</ex:intervalNum>
<ex:xMin>0.061199346418562</ex:xMin>
<ex:xMax>0.40788261011471</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>3</ex:intervalNum>
Expand Down Expand Up @@ -526,7 +526,7 @@
<ex:intervalNum>2</ex:intervalNum>
<ex:xMin>0.061199346418562</ex:xMin>
<ex:xMax>0.40788261011471</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>3</ex:intervalNum>
Expand Down Expand Up @@ -578,7 +578,7 @@
<ex:intervalNum>2</ex:intervalNum>
<ex:xMin>0.061199346418562</ex:xMin>
<ex:xMax>0.40788261011471</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>3</ex:intervalNum>
Expand Down Expand Up @@ -658,7 +658,7 @@
<ex:intervalNum>1</ex:intervalNum>
<ex:xMin>0.0</ex:xMin>
<ex:xMax>2.0</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
</ex:intervals>
</ex:item>
Expand All @@ -674,7 +674,7 @@
<ex:intervalNum>1</ex:intervalNum>
<ex:xMin>0.0</ex:xMin>
<ex:xMax>0.061199346418562</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
<ex:interval>
<ex:intervalNum>2</ex:intervalNum>
Expand All @@ -686,7 +686,7 @@
<ex:intervalNum>3</ex:intervalNum>
<ex:xMin>0.40788261011471</ex:xMin>
<ex:xMax>2.0</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
</ex:intervals>
</ex:item>
Expand All @@ -702,9 +702,9 @@
<ex:intervalNum>1</ex:intervalNum>
<ex:xMin>0.0</ex:xMin>
<ex:xMax>2.0</ex:xMax>
<ex:text />
<ex:text xsi:nil="true" />
</ex:interval>
</ex:intervals>
</ex:item>
</ex:items>
</ex:praat>
</ex:praat>
30 changes: 30 additions & 0 deletions src/test/resources/textgrid.tdml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>

<tdml:testSuite
xmlns="http://example.com"
xmlns:daf="urn:ogf:dfdl:2013:imp:daffodil.apache.org:2018:ext"
xmlns:dfdl="http://www.ogf.org/dfdl/dfdl-1.0/"
xmlns:ex="http://example.com"
xmlns:tdml="http://www.ibm.com/xmlns/dfdl/testData"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
defaultRoundTrip="onePass"
defaultConfig="cfg_no_warn">

<tdml:defineConfig name="cfg_no_warn">
<daf:tunables>
<daf:suppressSchemaDefinitionWarnings>
encodingErrorPolicyError
</daf:suppressSchemaDefinitionWarnings>
</daf:tunables>
</tdml:defineConfig>

<tdml:parserTestCase name="ekskfk_miski_1" model="com/github/keeleleek/praattextgrid/PraatTextGrid.dfdl.xsd">
<tdml:document>
<tdml:documentPart type="file">examples/ekskfk_miski_1.TextGrid</tdml:documentPart>
</tdml:document>
<tdml:infoset>
<tdml:dfdlInfoset type="file">examples/ekskfk_miski_1.TextGrid.xml</tdml:dfdlInfoset>
</tdml:infoset>
</tdml:parserTestCase>

</tdml:testSuite>
20 changes: 20 additions & 0 deletions src/test/scala/TestPraatTextGrid.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package com.gitub.keeleleek.praattextgrid

import org.apache.daffodil.tdml.Runner
import org.junit.Test
import org.junit.AfterClass

object TestPraatTextGrid {
lazy val runner = new Runner("/", "textgrid.tdml")

@AfterClass def shutDown {
runner.reset
}
}

class TestPraatTextGrid {
import TestPraatTextGrid._

@Test def test_ekskfk_miski_1() { runner.runOneTest("ekskfk_miski_1") }

}