sweet-delights / delightful-edifact   0.0.1

delightful-edifact is a data-binding code generator and library for EDIFACT messages, written in Scala . It is inspired by the excellent scalaxb tool. The parsing itself is implemented with scala-parser-combinators.

delightful-edifact is built for Scala 2.12 and 2.13. The plugin is tested against SBT 1.3.13.

Step 1 - in build.sbt, add:

libraryDependencies += "org.sweet-delights" %% "delightful-edifact" % "0.0.1"

Step 2 - in project/plugins.sbt, add:

addSbtPlugin("org.sweet-delights" % "sbt-delightful-edifact" % "0.0.1")

Step 3 - in src/main/resources/edifact/, add EDIFACT grammar files

The SBT plugin generates the code in target/scala-${scalaVersion}/src_managed/main/sbt-delightful-edifact/

<dependency>
  <groupId>org.sweet-delights</groupId>
  <artifactId>delightful-edifact_2.12</artifactId>
  <version>0.0.1</version>
</dependency>

All files in delightful-edifact are under the GNU Lesser General Public License version 3. Please read files COPYING and COPYING.LESSER for details.

EDIFACT is an electronic data interchange (EDI) format developed for the United Nations and approved and published by the UNECE. For more information, please check the UNECE site or wikipedia page.

EDIFACT data-binding is the process of mapping and filling objects representing the structure of an EDIFACT message. In the special case of delightful-edifact, the objects are Scala case classes and objects.

Firstly, delightful-edifact defines a XML Schema Definition (XSD) for describing EDIFACT grammars. Once such a grammar is available, delightful-edifact is able to generate the data-binding case classes and parsers to read EDIFACT messages. The parsers are based on scala-parser-combinators.

As of now, delightful-edifact does not write data-binding case classes back to EDIFACT. But contributions are welcome to add this feature!

Suppose we want to parse the following EDIFACT message (taken from wikipedia):

UNB+IATB:1+6XPPC:ZZ+LHPPC:ZZ+940101:0950+1'
UNH+1+PAORES:93:1:IA'
MSG+1:45'
IFT+3+XYZCOMPANY AVAILABILITY'
ERC+A7V:1:AMD'
IFT+3+NO MORE FLIGHTS'
ODI'
TVL+240493:1000::1220+FRA+JFK+DL+400+C'
PDI++C:3+Y::3+F::1'
APD+74C:0:::6++++++6X'
TVL+240493:1740::2030+JFK+MIA+DL+081+C'
PDI++C:4'
APD+EM2:0:1630::6+++++++DA'
UNT+13+1'
UNZ+1+1'

The structure of this message (aka "the grammar") is described in a XML file. Example: PAORES_IA_93_1.xml. The XSD for this file is available here.

delightful-edifact takes care of generating the case classes and parser combinators from the grammar file.

Here is a code sample on how to parse the example above:

import hello.world.EdifactParser // package containing the generated EdifactParser object
                                 // is customizable

val binary: Array[Byte] = ... // the EDIFACT message to be decoded, in binary format

val paoresOpt = EdifactParser.parse_PAORES_IA_93_1(binary) match {
  case EdifactParser.Success(paores, _) => Some(paores)
  case EdifactParser.Failure(_, _) => None
  case EdifactParser.Error(_, _) => None
}

// extract some information
val itinerary = for {
  paores <- paoresOpt.toList
  singleCityPairInfo <- poares.singleCityPairInfo
  flightInfo <- singleCityPairInfo.flightInfo
  boardPoint = flightInfo.basicFlightInfo.boardPointDetails.trueLocationId
  offPoint = flightInfo.basicFlightInfo.offPointDetails.trueLocationId
} yield (boardPoint, offPoint)

println(itinerary) // List((FRA, JFK), (JFK, MIA))

This project follows the Typelevel Code of Conduct, available here.

To contribute, please feel free to open an issue and submit pull requests.

• the scalaxb tool for inspiration and example for SBT plugin code
• the scala-parser-combinators library
• the monocle library