互換性の無い変更点

sbt プラグイン間の名前空間の衝突を避けたり、一貫性を高めるために sbt plugins best practices が作られた。以下の変更点はその勧告にならったものだ:

キーは ScalaxbKeys オブジェクト以下に移動した

sbt-scalaxb によって提供されるキーは ScalaxbKeys オブジェクト下に移動した。build.sbt の先頭に以下を書く:

import ScalaxbKeys._

(packageName など) キーの Scala 識別子は今まで同様だが、シェルからの呼び出しには scalaxb-と頭に付ける必要がある (例: scalaxb-package-name)。

設定値は scalaxb タスク下にスコーピングされる

scalaxb 専用の設定値は scalaxb タスクの下にスコーピングされる。デフォルトの設定値である scalaxbSettings はさらに、Compile コンフィギュレーション以下にスコーピングされる（Scalaxb コンフィギュレーションは廃止）。

seq(scalaxbSettings: _*)

packageName in scalaxb in Compile := "ipo"

sourceGenerators in Compile <+= scalaxb in Compile

これにより、プロジェクト内で scalaxb を複数回使いたい場合は、build.scala 内にカスタムのコンフィギュレーションを作ることで可能となった:

val Xsd = config("xsd") extend(Compile)
val Wsdl = config("wsdl") extend(Compile)
lazy val appSettings = buildSettings ++
  inConfig(Xsd)(baseScalaxbSettings ++ inTask(scalaxb)(customScalaxbSettings("xmlschema"))) ++
  inConfig(Wsdl)(baseScalaxbSettings ++ inTask(scalaxb)(customScalaxbSettings("wsdl11")))

def customScalaxbSettings(base: String): Seq[Project.Setting[_]] = Seq(
  sources <<= xsdSource map { xsd => Seq(xsd / (base + ".xsd")) },
  packageName := base,
)

バグフィクスおよび細かな機能改善点

• 名前空間バインディングの衝突を修正した。#84 reported and fixed by jxstanford
• wsdl の anyType のサポートを修正した。#88 reported by radirk
• wsdl の SOAPAction ヘッダを修正した。
• wsdl の Fault の処理を修正した。
• 内部のログに Logback を使うようにした。

バグフィクスおよび細かな機能改善点

• sbt-scalaxb を修正した。#83
• QName のパースするときに URI を解決するように修正した。#82

バグフィクスおよび細かな機能改善点

• xs:gMonthDay のサポートを修正した。#74
• 代替グループのパーシングを修正した。#79 reported by @jxstanford
• SOAP 1.2 の Content-Type HTTP ヘッダを修正した。#80
• RPCスタイルの SOAP メッセージのサポートを加えた。#77
• デフォルトのプロトコルファイル名を xmlprotocol.scala に変更した。
• --protocol-file と --protocol-package オプションを加えた。#76
• 重複した型を無視するように変更した。#78 requested by @timperrett

sbt-scalaxb for sbt 0.10.1

sbt 0.10.1 から scalaxb を呼び出すには、以下を project/plugins/build.sbt に加え:

libraryDependencies <+= (sbtVersion) { sv => "org.scalaxb" %% "sbt-scalaxb" % ("sbt" + sv + "_0.6.2") }

以下を build.sbt に加える:

seq(sbtscalaxb.Plugin.scalaxbSettings: _*)

sourceGenerators in Compile <+= scalaxb.identity

バグフィクスおよび細かな機能改善点

• 長いシーケンスを制限するための --contents-limit オプションを加えた。
• 子要素が生成するクラス名に親要素名を前置するための --prepend-family オプションを加えた。(#69 reported by @devinus)
• soap 1.1 サポートを加えた。 (#66 reported by @s_m_stewart and @meglio)
• 全モジュールのビルドを sbt 0.10.1 に切り替えた。

sbaz から conscript へ

scalaxb をインストールするのに、sbaz には今までお世話になりましたが、scala のバージョンに依存してたり、REPL のクラスパスを汚染したりなど問題も多いものだった。
0.6.1 より scalaxb は sbaz のサポートを打ち切り、全ユーザに conscript に移行して scalaxb をインストールすることを推奨する。

$ sudo sbaz remove scalaxb
$ cs eed3si9n/scalaxb

無Array化

• xs:base64Binary は Array[Byte] ではなく、scalaxb.Base64Binary にマッピングするようにした。
• scalaxb.HexBinary と scalaxb.Base64Binary の両方とも内部では Vector[Byte] を使う。
• 他の組み込み型で以前に Array[String] にマッピングされていたものは Seq[String] マッピングするようにした。

mvn-scalaxb

@martiell氏により scalaxb plugin for Maven が提供された。

sbt-scalaxb for sbt 0.10

sbt 0.10 から scalaxb を呼び出すには、以下を project/plugins/build.sbt に加え:

libraryDependencies += "org.scalaxb" %% "sbt-scalaxb" % "0.6.1"

以下を build.sbt に加える:

sourceGenerators in Compile <+= scalaxb.identity

バグフィクスおよび細かな機能改善点

• リストの派生型を修正した。 (#54 reported by @ikwzm)
• 空のシーケンスの処理を修正した。(#55)
• 名前と構造が一致するローカル要素の命名を修正した。(#56)
• @implicitNotFound 属性を fromXML その他に加えた。
• scalaxb.scala の生成を省くための --no-runtime オプションを加えた。(#45 requested by @martiell)
• wdl オペレーション名のキャメルケース化を実装した。 (#52 requested by @timperrett)
• wsdl より生成されるメッセージ case class に付けていた X プレフィックスを取り除いた。(#51 requested by @timperrett)
• 200+ パラメータを処理するために --chunk-size オプションを加えた。(#58 reported by @ecin)

ドットコムブームのさなか猫も杓子も WSDL で記述されたSOAP サービスの一つや二つは書いていたのではないか。この WSDL ドキュメントを詳しくみてみると、実はメッセージのレイアウトを記述した XML Schema ドキュメントが埋めこまれており、それが結構な部分を占めいていることが分かる。残りは些細なものだ。scalaxb は XML Schema 部分は処理できるため、WSDL をサポートし始めるのは、時間の問題だったと言えるだろう。

使用例

1. wsdl ドキュメントをローカル環境にダウンロードする。
2. sbt-scalaxb を使っている場合はそれを src/main/wsdl に置く。

サンプルの設定例はこんな感じ:

import ScalaxbKeys._
 
val scalaXml = "org.scala-lang.modules" %% "scala-xml" % "1.0.2"
val scalaParser = "org.scala-lang.modules" %% "scala-parser-combinators" % "1.0.1"

John Stanford 氏が Salat を使って scalaxb の case class を MongoDB に永続化してますという話:
- Using Salat with scalaxb generated classes

新しく作った scalaxb Google Group でも氏が一番乗りでした。参加してアイディアを contribute して下さい。

新機能

• 実験的 wsdl 1.1 サポート。

バグフィクスおよび細かな機能改善点

• XML バインディングを foo_xmlprotocol.scala に生成するようにした。
• Scala 2.9.0-1。
• Web API を Unfiltered 0.3.3 にアップグレードした。
• xs:anyAttribute にデフォルトの引数を加えた。
• xs:anySimpleType のサポートを加えた。(#34 reported by @psnively)
• xs:any の命名を修正した。(#35 reported by @psnively)
• DataRecord の型クラスインスタンスを追加した。(#40 reported by @psnively)
• DataRecord のラウンドトリップを修正した。(#43)
• xs:anyType を含む xs:choice のマッピングを変更した。(#44 reported by @psnively)

• @max4f による sbt-scalaxb プラグインを追加した。
• パッケージディレクトリ構造を生成する --package-dir 追加した。
• conscript に対応した: cs eed3si9n/scalaxb.
• パッケージをまたぐ choice が生成するコードを修正した (GH-33)。

sbt のための scalaxb プラグインを書いてもらい、さらに快くそれをプロジェクトに取り込まさせてくれた Max 氏 (@max4f) に謝意を表したい。ところで、皆さんは sbt 使ってますね?

sbt から compile-xsd タスクを使うための手順を説明する。

step 1. Plugins.scala

以下を project/plugins/Plugins.scala に追加する。

import sbt._
 
class Plugins(info: ProjectInfo) extends PluginDefinition(info) {
  val scalaxb = "org.scalaxb" % "sbt-scalaxb" % "0.6.0"
 
  val scalaToolsNexusSnapshots = "Scala Tools Nexus Snapshots" at "http://nexus.scala-tools.org/content/repositories/snapshots/"
  val scalaToolsNexusReleases  = "Scala Tools Nexus Releases" at "http://nexus.scala-tools.org/content/repositories/releases/"
}