andrevandelft / scalaxb-old Goto Github PK

View Code? Open in Web Editor NEW

This project forked from eed3si9n/scalaxb

0.0 2.0 0.0 14.42 MB

scalaxb is an XML data binding tool for Scala.

Home Page: http://scalaxb.org/

License: MIT License

Scala 94.57% Shell 0.27% Java 5.12% HTML 0.03%

scalaxb-old's Introduction

scalaxb

scalaxb is an XML data-binding tool for Scala that supports W3C XML Schema (xsd) and Web Services Description Language (wsdl) as the input file.

From schema documents scalaxb will generate Scala source files containing case classes to represent the data and typeclass instances to turn XML documents into an object, and the object back to XML.

Status

The latest is 1.4.1. Some things may not work. I'd really appreciate if you could run it against your favorite xsd file and let me know the result.

Modules

There are currently four ways of running scalaxb:

command line app scalaxb
sbt plugin sbt-scalaxb
maven plugin mvn-scalaxb
web API scalaxb-heroku hosted on heroku

sbt-scalaxb

To call scalaxb from sbt 0.13.x, put this in your project/scalaxb.sbt:

resolvers += Resolver.sonatypeRepo("public")
addSbtPlugin("org.scalaxb" % "sbt-scalaxb" % "X.X")

and this in scalaxb.sbt:

scalaxbSettings
packageName in scalaxb in Compile := "xxx"
sourceGenerators in Compile <+= scalaxb in Compile
dispatchVersion in scalaxb in Compile := "0.11.3"

command line app scalaxb

See INSTALL.md.

mvn-scalaxb

See mvn-scalaxb.

Documents

Further info is available at scalaxb.org.

Bug Reporting

If you're having problem with scalaxb, please take a moment and read issue reporting guideline.

Licensing

It's the MIT License. See the file called LICENSE.

Contacts

scalaxb-old's People

Contributors

Watchers

scalaxb-old's Issues

Generate Visitor code

To make the generated classes of scalaxb really useful for my OfficeOpenXML-related development project, we need some visitor infrastructure. There are several options:

just make this provision for the generated scalaxb code of OpenOffice
add a command line option to the scalaxb generator, to generate a visitor
do something at run-time with macros

In docx4j, approach 1 was taken; see here. One drawback with this approach is that is limited to the OfficeOpen code. Moreover, there is no guaranty that every node is visited.

For jaxb, there is a better solution of type 2: a plug in to the code generator, that creates visitor code. See jaxb-visitor. We could mimic this as a command line option in scalaxb, rather than a plugin.

I think Tolya could also create macro's that generate the visitors at run time. I would prefer the command line option though since that seems easier to understand for slightly less advanced developers.

Supporting mutable classes for dealing with MS Office schemata

In this issue I log my activities and the encountered problems when adding support for mutable classes, and trying this out on the XML schemata for Microsoft Office.

ConScript usage

I found that the usage of ConScript complicates this project.
First there is the hassle of installing ConScript on OSX.
Thereafter it was hard to work with it.

Fortunately Anatoliy created a deploy script for scalaxb that does not depend on ConScript.

Installing ConScript on OSX

Make sure wget has been installed

brew install wget

Download and run install script

curl https://raw.githubusercontent.com/foundweekends/conscript/master/setup.sh >setup-conscript.sh
chmod u+x setup-conscript.sh
./setup-conscript.sh

Working with Conscript

I wanted to compile scalaxb for Scala 2.10, rather than 2.11 which is standard on my system.
That is because compiling with 2.11 would cause these kinds of errors:

Note: during publish-local it is possible to get errors such as

    ...
    [info]  published ivy to /Users/andrevandelft/.ivy2/local/org.scalaxb/scalaxb_2.11/1.4.1-SNAPSHOT/ivys/ivy.xml
    [error] .../scalaxb/sbt-scalaxb/src/main/scala/sbtscalaxb/Plugin.scala:90: can't expand macros compiled by previous versions of Scala
    [error]     logLevel in scalaxb <<= logLevel?? Level.Info
    [error]                                              ^

Unfortunately ConScript wants to work with 2.11 on my system.
Why exactly is unknown. IMO the help should be clear how to change that, but it is not.

$ cs --local eed3si9n/scalaxb/1.4.1-SNAPSHOT
Getting org.scalaxb scalaxb_2.11 1.4.1-SNAPSHOT ...
        module not found: org.scalaxb#scalaxb_2.11;1.4.1-SNAPSHOT

After struggling with this for a while I gave up.