case classはScalaプログラミングにおける最重要機能の一つです。
case classはいろいろな便利機能が言語機能としてビルトインされているのに加えて、OOP的にはValue Object、関数型プログラミングとしては代数的データ構造として利用することができます。
case classはそのままシンプルに使っても便利ですが、case classを作る時に基本対応しておくとよさそうな各種機能があるので、その辺りの最新事情を取り込んだ2015年版case classについて考えてみます。
対応機能
2015年版case classでは以下の機能に対応することにします。
- Monoid
- Argonaut
- ScalaCheck
Monoid
「Scala Tips / Monoid - 新規作成」は2012年6月の記事なので、かれこれ3年になりますがMonoidの重要性は変わる所がありません。Monoidを使うためだけにScalazを導入してもお釣りがくるぐらいです。
case classを作る時は常にMonoidを意識しておいて、可能であればMonoid化しておくのがよいでしょう。
MonoidはScalazで実装します。
2012年版の「Scala Tips / Monoid - 新規作成」ではScalaz 6でしたが、今回はScalaz 7でMonoidの定義の仕方も変更されています。
Argonaut
Finagleなどを使ってRESTベースのmicroservicesアーキテクチャを取る場合、case classをJSONで送受信するニーズが大きくなります。
case classをできるだけ簡単にJSON化する方法としてArgonautが有力なので使ってみました。
ScalaCheck
case classがMonoidである場合は、必ず二項演算があるので、この二項演算のテストコードが必要になります。
Scalaプログラミングでは、こういった演算はScalaCheckでプロパティベーステストを行うのがお約束になっています。
プログラム
build.sbt
build.sbtは特に難しい所はありません。必要なライブラリを登録しているだけです。
- scalaVersion := "2.11.6"
- val scalazVersion = "7.1.0"
- libraryDependencies ++= Seq(
- "org.scalaz" %% "scalaz-core" % scalazVersion,
- "io.argonaut" %% "argonaut" % "6.1-M4",
- "org.scalatest" %% "scalatest" % "2.2.4" % "test",
- "org.scalacheck" %% "scalacheck" % "1.12.2" % "test",
- "junit" % "junit" % "4.12" % "test"
- )
Average.scala
Monoid化とArgonaut化したcase class Averageは以下になります。
- package sample
- import scalaz._, Scalaz._
- import argonaut._, Argonaut._
- case class Average(count: Int, total: Int) {
- import Average.Implicits._
- def value: Float = total / count.toFloat
- def +(rhs: Average): Average = {
- Average(count + rhs.count, total + rhs.total)
- }
- def marshall: String = this.asJson.nospaces
- }
- object Average {
- import Implicits._
- val empty = Average(0, 0)
- def unmarshall(s: String): Validation[String, Average] = s.decodeValidation[Average]
- object Implicits {
- implicit object AverageMonoid extends Monoid[Average] {
- def append(lhs: Average, rhs: => Average) = lhs + rhs
- def zero = Average.empty
- }
- implicit def decodeAverageJson: DecodeJson[Average] =
- casecodec2(Average.apply, Average.unapply)("count", "total")
- implicit def encodeAverageJson: EncodeJson[Average] =
- jencode2L((d: Average) => (d.count, d.total))("count", "total")
- }
- }
case classの定義に難しいところはないと思います。
以下ではMonoidとArgonautの定義について説明します。
Monoid
Monoidは、Scalazの型クラスMonoidの型クラスインスタンスを作成して暗黙オブジェクトとして定義します。
- implicit object AverageMonoid extends Monoid[Average] {
- def append(lhs: Average, rhs: => Average) = lhs + rhs
- def zero = Average.empty
- }
型クラスMonoidの型クラスインスタンスのappendメソッドとzeroメソッドを実装します。
appendメソッドはMonoid対象の二項演算を定義します。通常、Monoid対象となるcase classで「+」メソッドを提供しているはずなのでこれを呼び出す形になります。
zeroメソッドは空の値を返すようにします。通常、case classの空値はコンパニオン／オブジェクトの変数emptyに定義するのが普通なので、これをzeroメソッドの値として返す形になります。
Argonaut
まずArgonautの基本定義として、ScalaオブジェクトとJSON間の相互変換をする暗黙関数を2つ用意します。
ここも自動化できればよいのですが、マクロを使う形になるはずなので、マクロの仕様がフィックスしていない現状だとやや時期尚早かもしれません。
- implicit def decodeAverageJson: DecodeJson[Average] =
- casecodec2(Average.apply, Average.unapply)("count", "total")
- implicit def encodeAverageJson: EncodeJson[Average] =
- jencode2L((d: Average) => (d.count, d.total))("count", "total")
次に、マーシャル関数(Scala→JSON)とアンマーシャル関数(JSON→Scala)を定義します。
まず、マーシャル関数はcase class Averageのメソッドとして定義しました。
- def marshall: String = this.asJson.nospaces
アンマーシャル関数はAverageのコンパニオンオブジェクトに定義しました。
- def unmarshall(s: String): Validation[String, Average] = s.decodeValidation[Average]
AverageSpec.scala
case class Averageのテストコードとして、ScalaCheckによるプロパティベーステストを行うAverageSpecを作りました。
- package sample
- import org.junit.runner.RunWith
- import org.scalatest.junit.JUnitRunner
- import org.scalatest._
- import org.scalatest.prop.GeneratorDrivenPropertyChecks
- @RunWith(classOf[JUnitRunner])
- class AverageSpec extends WordSpec with Matchers with GivenWhenThen with GeneratorDrivenPropertyChecks {
- "Average" should {
- "value" in {
- forAll ("ns") { (ns: List[Int]) =>
- val ns1 = ns.filter(_ >= 0)
- if (ns1.nonEmpty) {
- val x = Average(ns1.length, ns1.sum)
- x.value should be (toAverageValue(ns1))
- }
- }
- }
- "value gen" in {
- forAll ((Gen.nonEmptyListOf(Gen.posNum[Int]), "ns")) { ns =>
- val x = Average(ns.length, ns.sum)
- x.value should be (toAverageValue(ns))
- }
- }
- "+" in {
- forAll ("ns") { (ns: List[Int]) =>
- val ns1 = ns.filter(_ >= 0)
- if (ns1.nonEmpty) {
- val xs = toAverages(ns1)
- val r = xs.foldLeft(Average.empty)((z, x) => z + x)
- r.value should be (toAverageValue(ns1))
- }
- }
- }
- "monoid concatenate" in {
- import scalaz._, Scalaz._
- import Average.Implicits.AverageMonoid
- forAll ("ns") { (ns: List[Int]) =>
- val ns1 = ns.filter(_ >= 0)
- if (ns1.nonEmpty) {
- val xs = toAverages(ns1)
- val r = xs.concatenate
- r.value should be (toAverageValue(ns1))
- }
- }
- }
- def toAverages(ns: List[Int]): List[Average] = {
- ns.map(Average(1, _))
- }
- def toAverageValue(ns: List[Int]): Float = {
- ns.sum.toFloat / ns.length
- }
- }
- }
ScalaCheckのプロパティベーステストを行う方法はいくつかありますが、ここではScalaTestのGeneratorDrivenPropertyChecksを使ってみました。
GeneratorDrivenPropertyChecksを使うと「forAll」を使って、指定された型の値をワンセット自動生成してくれるので、この値を用いてテストを行うことができます。
forAllの内部定義として個々のテストを書いていきますが、これは通常のテストコードと同様です。
- "value" in {
- forAll ("ns") { (ns: List[Int]) =>
- val ns1 = ns.filter(_ >= 0)
- if (ns1.nonEmpty) {
- val x = Average(ns1.length, ns1.sum)
- x.value should be (toAverageValue(ns1))
- }
- }
- }
一つポイントとなるのは、テスト用データの自動生成は指定された型(ここでは List[Int])の任意の値を取る可能性があるので、これをテストコード側で排除する必要がある点です。
この問題への対処方法として、テスト用データ生成器(org.scalacheck.Gen)で値域を指定する方法があります。
org.scalacheck.Genを使って値域を指定するテスト"value gen"は以下になります。org.scalacheck.Genを使うとクロージャの引数の型(List[Int])も省略できます。
- "value gen" in {
- forAll ((Gen.nonEmptyListOf(Gen.posNum[Int]), "ns")) { ns =>
- val x = Average(ns.length, ns.sum)
- x.value should be (toAverageValue(ns))
- }
- }
いずれの方法を取るにしても、テストプログラムを書く時に、テストデータを準備する必要はないのは大変便利です。
また、テストプログラムが、テストをする手続きというより、より仕様定義に近いものになるのもよい感触です。
実行
Sbtのtestでテストプログラムを実行することができます。
$ sbt test ...略... [info] AverageSpec: [info] Average [info] - should value [info] - should value gen [info] - should + [info] - should monoid concatenate [info] ScalaTest [info] 36mRun completed in 1 second, 870 milliseconds.0m [info] 36mTotal number of tests run: 40m [info] 36mSuites: completed 1, aborted 00m [info] 36mTests: succeeded 4, failed 0, canceled 0, ignored 0, pending 00m [info] 32mAll tests passed.0m [info] Passed: Total 4, Failed 0, Errors 0, Passed 4 [success] Total time: 5 s, completed 2015/05/15 16:31:57
まとめ
case classを作る時に意識しておきたい基本形を考えてみました。
プログラミング時には、この基本形を念頭に置いて、不要な機能は削除、必要な機能を追加という形でcase classを組み立てていくことをイメージしています。
なお、Monoidに対するテストに関してはScalazのSpecLiteを使うともっと強力なテストができますが、この話題は別途取り上げたいと思います。
諸元
- Scala 2.11.6
- Scalaz 7.1.0
- Argonaut 6.1-M4
- ScalaTest 2.2.4
- ScalaCheck 1.12.2
投稿
0 件のコメント:
コメントを投稿