Magnolia Tech

いつもコードのことばかり考えている人のために。

ScalateのScala 2.13.0非互換への対応を考える

スキルアップのためには、知らないこと、分からないことへチャレンジした方がいいですね。例えば、すぐに答えられそうか分からない質問をわざと受ける、というのも1つの方法です。

ということをツイートしていたら…

質問…というよりガチな依頼が来ましたので、これはこれで対応するしましょう(笑)。OSSへの貢献は、ソフトウェア開発を学ぶ上で必要な要素がたくさん詰まっていますからね。

対象のコードは何か?

元々のコードの意図を探る

  • ScalateではテンプレートをScalaのコードとしてコンパイルする方法を採用
  • コンパイルの際に発生したエラーや警告をConsoleReporterを継承したLoggingReporterを使って独自にエラーを蓄積
  • 最終的にエラーが有ればCompilerExceptionを送出
  • エラーの蓄積のために、printMessageというメソッドをオーバーライド

    (loggerという割にはログ出力は行っていないのは謎ですが…)

クラス構造の変更点を把握する

  • Scala 2.13.0-M5よりConsoleReporterが大幅にリファクタリング
  • クラス構造も変わり、ConsoleReporterに加えて、DisplayReporterというクラスが追加
  • ConsoleReporterとDisplayReporterは、PrintReporterというtraitをmix-in
  • PrintReporterがprintMessageを持つ構成となっているが、privateメソッド化されている
  • printMessageはdisplayメソッドから呼び出される点は変わらず

変更案

  • printMessageではなく、displayメソッドを継承
  • printMessageの中で行っているメッセージ文字列の組み立てをログ出力用にコピペ
  • 最後にエラーの件数を出力するためのprintSummaryメソッドが無くなったので、同等の機能を提供するfinishへの置き換え

github.com

printMessageの中で行っているメッセージ文字列の組み立てをコピペしているのでdryではないので、別の方法が有れば採用したいところですが、一旦素案レベルではできました。

ただし、まだScala 2.13.0-M5に対応したScalatestがリリースされていない関係で、この先のコンパイルでエラーが出るし、テストもできない状態なので、ここで一旦検討は終了です。

ここまで記録を残しておけば、scalatestが動くようになってから検討を再開できるかな。ちょっと面倒ですが、1つ1つ調べたこと、考えたことを記録しておかないとすぐ忘れちゃいますね。

終わりに

今回、お題を頂いた瀬良さんが執筆に参加されたScalaの入門本「 実践Scala入門」が発売されるそうです。これを読んでみんなもScalaOSS開発に参加しよう!!

実践Scala入門

実践Scala入門

「ドメイン駆動設計」を読んだ〜第1章 知識をかみ砕く〜

引き続き「ドメイン駆動設計」を読み進めました。

「第1章 知識をかみ砕く」には、ドメインエキスパートと、開発者の会話を通じてモデルを作り上げていく様子から始まります。

  • モデルを書いて可視化すること
  • 繰り返し相互のフィードバックでモデルを成長させること
  • モデルと実装(プロトタイプ)を結びつけて、早期のフィードバックを得ることの重要性
  • 新しい概念を新しいモデルの要素として、抽出・分離すること

といったことが書かれています。

モデル化そのもののテクニックの詳細は書かれていませんが、最初から全ての要素を全て揃えて完全なモデルを書くのではなく、その時点で関心を持っていること(つまり、ドメイン)に集中してモデル化し、(画面等も無いミニマムな)プロトタイピングによりその本質を捉えていることの検証とフィードバックを繰り返しているところが特徴です。

途中、ウォーターフォールにはフィードバックが欠けているために上手くいかないと記載されていますが、上手く行っているウォーターフォールも当然世の中には有るはずで、きっとそのようなプロジェクトでは意識的か、無意識かは別として段階的なモデル化とフィードバックが行われていて、反対に上手く行っていないプロジェクトではプロジェクトルールで規定された成果物を揃えることが目的になっているのではないでしょうか。

最初からすべてをあまねくモデル化しようとしても検証もできないですし、よりよいモデルのためにフィードバックを反映する余地が有りません。

開発者が考える拡張性や保守性は未来を向いていますが、ドメインエキスパートが考える拡張性は過去との連続性に主眼が置かれていて、それらはソフトウェアを作り上げる、という意味では本来相互に補完する関係にあるのではないでしょうか。

本書では詳細は触れられていませんが、フィードバックできる粒度を維持するためにも、実はドメイン駆動設計で最も大事なスキルは「今やらないこと・着目しないことを決める」では?と感じました。

エリック・エヴァンスのドメイン駆動設計

エリック・エヴァンスのドメイン駆動設計

実践ドメイン駆動設計 (Object Oriented SELECTION)

実践ドメイン駆動設計 (Object Oriented SELECTION)

「ドメイン駆動設計」を読んだ〜第一部 ドメインモデルを機能させる〜

ドメイン」を辞書で調べると以下のような意味が書かれています。

(活動・関心・知識などの)分野, 領域, 範囲.

ドメイン駆動設計」の冒頭、「第一部 ドメインモデルを機能させる」を読んで以下のように理解しました。

  • ドメインは、関心の領域

  • モデルは、自分の関心領域を抽象化することにより、集中すべきところに集中するために作成する

  • ドメインモデルは、特定の図を示すものではなく、考え方を示すもの

  • ドメイン駆動設計では、モデルと実装の連続性を重要視している

  • 現代的なソフトウェアは複雑であり、その複雑さを適切にコントロールするためには、何らかの構造を作り出す必要が有る

  • 1つの考え方として、ドメイン駆動設計がある

抽象化により関心量を適切に配分し、全体としての複雑さをコントロールするっていうことなので、いかに「今、関心を持つべきではないこと」に関心を置かないか?そのためにはどうするか?というところも合意を図っておかないといけないな、と感じました。

人によって、いきなり実装詳細だけにに関心を持ちすぎたり、実装時の複雑さを無視した「絵に描いた餅」になってしまう危険性について常に留意する必要がありますね。

その辺のアンチパターンもまとまっていると良いなと思いました。

エリック・エヴァンスのドメイン駆動設計

エリック・エヴァンスのドメイン駆動設計

実践ドメイン駆動設計 (Object Oriented SELECTION)

実践ドメイン駆動設計 (Object Oriented SELECTION)

RT-AC86Uを買った

特にゲーミングルータが必要なシビアな使い方をしているわけじゃないけど、アクセスポイントを増やす時にメッシュネットワークが組める、ということでこの機種を選定。

www.asus.com

セットアップ時に一時的に利用するアクセスポイントを用意して、セットアップが完了したら(SSIDとパスワード)、そのアクセスポイントが無効になる、という仕組みが良かった。

面倒くさがってデフォルトのSSIDをそのまま使うと、住宅街だとアクセスポイントがたくさん表示されてどれがどれだか分からなくなっちゃうことも有るので、最初から自分で設定する方がいいですね。

反面、ネットワーク名は近所に筒抜けなので、変な名前をつけないようにしないと。

特に色々なセキュリティ機能は試していないけど、電波の届く範囲も割と広めで、通常使う分には全然OKですね。

アクセスポイントを増やす時には、これを買う予定。

ScalaのmapValuesの挙動が2.13.0から変わっているので実装を調べてみた

scalaのmapValuesは、Mapのvalueだけにmapを適用したい時に使用するメソッドです(Mapとmapでちょっと分かりづらいですが)。

Scala 2.12.6で実行すると、以下のような結果になります。

scala> val characters = Map("Gandalf" -> "wizard", "Aragorn" -> "ranger")
characters: scala.collection.immutable.Map[String,String] = Map(Gandalf -> wizard, Aragorn -> ranger)

scala> val upper = characters.mapValues( x => x.toUpperCase )
upper: scala.collection.immutable.Map[String,String] = Map(Gandalf -> WIZARD, Aragorn -> RANGER)

まだ正式リリースされていないScala 2.13.0ですが、先日リリースされた2.13.0-M5という開発途中のバージョンで実行すると、以下のような結果になりました。

scala> val characters = Map("Gandalf" -> "wizard", "Aragorn" -> "ranger")
characters: scala.collection.immutable.Map[String,String] = Map(Gandalf -> wizard, Aragorn -> ranger)

scala> val upper = characters.mapValues( x => x.toUpperCase )
warning: there was one deprecation warning (since 2.13.0); for details, enable `:setting -deprecation' or `:replay -deprecation'
upper: scala.collection.MapView[String,String] = <function1>

何か明らかに挙動が変わっています。

何が変わったのか?

ふとこの挙動の変化についてツイートしたところ、@xuwei_kさんに丁寧に教えていただきました。

Scala 2.12.6における実装は以下の箇所の場所です(これも教えてもらった…ありがとうございます)。

github.com

mapValuesはMapを返すように定義されていますが、実態はMappedValuesという型のインスタンスを返しています。この時点ではインスタンスが作られるだけで実はmapが実行されていません。valuesを取り出すまで(getが実行されるまで)mapValuesの引数に渡された変換関数は実行されていない、つまり遅延評価されるということです。

この挙動が型から分からない、ということが課題になった、ということですね。確かにscaladocにも書かれていないし、型は普通のMapだし、全然分からないですね。

Scala 2.13.0-M5での実装

github.com

MapView.MapValuesという型のインスタンスを返しています。

MapViewの実装は以下の通りになっています。

github.com

先ほどの結果にキーを渡すと、変換されたvalueが得られました。

scala> upper("Gandalf")
res4: String = WIZARD

この変更はmapValuesだけでなく、filterにも適用されています。filterなんかはよく使われていると思うので、けっこう影響が大きいかもしれないですね。Scala 2.13.0へのアップデートの時には気をつけましょう。

Scala 2.13.0へアップグレードするとき

先ほどのmapValuesの件以外にも、網羅的にまとまっているマイグレーションガイドが有りますので、来たるべきScala 2.13.0リリースに向けて、こちらを見ておくと良いでしょう。

https://confadmin.trifork.com/dl/2018/GOTO_Berlin/Migrating_to_Scala_2.13.pdf

小さなPRを書いてOSS開発に貢献する

OSS開発に参加してみたいですよね!(断定)

でもどこから手をつけて良いか分からないことも多いですね。

そこでScalaのjson4sというライブラリをベースに、小さなPRを書いて、送るまでの流れを書いてみました。

参考にしてみて下さい。

今回は非推奨になったメソッドの置き換えを3カ所(3行)に対して行いました。とても短いPRですが、これで確実にJson4sをコンパイルする度に出ていた非推奨メソッドの警告メッセージが出なくなり、また今後のメンテナンス性も向上しました(非推奨になったメソッドはいつ削除されるか分からないので)。

GitHubからソースコードをcloneする

まずは(あとでPRを送るため)GitHub上で元のリポジトリをForkします。

GitHubの画面の右上にあるForkボタンを押してみてください。

自分のリポジトリにForkできたら、今度はそこから手元のローカル環境にcloneします。自分のアカウント(magnolia-k)では、以下のようになります。自分のアカウントに合わせて書き換えてください。

$ git clone git@github.com:magnolia-k/json4s.git

compileを実行する

sbtを起動して、compileを実行します。

(詳しいScalaでの開発方法は割愛します。その辺りは、Scalaの入門書などを参照して下さい)

すると、以下のようなメッセージが表示されました(のちほど出てくるPRがマージされると…残念ながらもう出なくなりますが)。

[warn] /home/xxx/json4s/jackson/src/main/scala/org/json4s/jackson/JValueDeserializer.scala:50:28: method mappingException in class DeserializationContext is deprecated: see corresponding Javadoc for more information.
[warn]       case _ => throw ctxt.mappingException(classOf[JValue])
[warn]                            ^
[warn] /home/xxx/json4s/jackson/src/main/scala/org/json4s/jackson/JValueDeserializer.scala:53:61: method mappingException in class DeserializationContext is deprecated: see corresponding Javadoc for more information.
[warn]     if (!klass.isAssignableFrom(value.getClass)) throw ctxt.mappingException(klass)
[warn]                                                             ^
[warn] /home/xxx/json4s/jackson/src/main/scala/org/json4s/jackson/JsonMethods.scala:20:25: method reader in class ObjectMapper is deprecated: see corresponding Javadoc for more information.
[warn]     var reader = mapper.reader(classOf[JValue])
[warn]                         ^
[warn] three warnings found
[info] Done compiling.

警告メッセージの意味を理解する

では実際に出た警告メッセージの理解し、対処方法を探って行きましょう。

順番が前後しますが、まずは下記のメッセージから…

method reader in class ObjectMapper is deprecated: see corresponding Javadoc for more information.

「see corresponding Javadoc for more information.」って書かれていて、具体的な場所を示してくれよ!って一瞬思いますが、そんな気持ちをぐっと堪えて、javadocを探します。

ObjectMapperJson4sが利用しているJackson-databindというJsonライブラリが持つclassです。

不要な箇所を削除しているので、完全に同じソースコードでは有りませんが…mapper.reader(classOf[JValue])readerメソッドの呼び出し箇所で警告が出ていて、そのreaderメソッドがObjectMapperというclassのメソッドであることが分かるでしょう(mapperの中身が_defaultMapperメソッドの中で生成されたObjectMapper)。

import com.fasterxml.jackson.databind._

trait JsonMethods extends org.json4s.JsonMethods[JValue] {

  private[this] lazy val _defaultMapper = {
    val m = new ObjectMapper()
    m.registerModule(new Json4sScalaModule)

    m
  }
  def mapper = _defaultMapper

  def parse(in: JsonInput, useBigDecimalForDouble: Boolean = false, useBigIntForLong: Boolean = true): JValue = {
    var reader = mapper.reader(classOf[JValue])

readerメソッドのjavadocは下記のURLで参照できます。

ObjectMapper (jackson-databind 2.9.0 API)

javadocには以下のように書かれています。

ObjectReader reader(Class<?> type)
Deprecated. 
Since 2.5, use readerFor(Class) instead

つまり、readerForというメソッドに置き換えれば良いことが分かります。

ちなみに今回は、結果的にreaderForで単純に置き換えれば良かったのですが、そもそも「なぜdeprecatedになったのか?」という理由を探すことができませんでした。急にdeprecatedになったので書き換えろ、と言われても…という気持ちになったので、READMEやChangesに書いておいて欲しいな、と思いました。

そもそも設計思想が変わった場合は当然単純な置き換えではいけないので…

次は同じメッセージが2つ出ている警告の方に取りかかります。

method mappingException in class DeserializationContext is deprecated: see corresponding Javadoc for more information.

こちらも

DeserializationContext (jackson-databind 2.9.0 API)

以下のように書かれているので、handleUnexpectedTokenで置き換えれば良いことが分かります。

@Deprecated
public JsonMappingException mappingException(Class<?> targetClass)
Deprecated. Since 2.8 use handleUnexpectedToken(Class, JsonParser) instead
Helper method for constructing generic mapping exception for specified type

しかし、よく見ると元のメソッドと戻りの型が違います。handleUnexpectedTokenObject型を返すのに対して、元のmappingExceptionJsonMappingException型を返しています。当然そのまま置き換えるとコンパイルエラーになります。

handleUnexpectedTokenメソッドのソースを追いかけてみましょう。

public Object handleUnexpectedToken(Class<?> instClass, JsonParser p)
        throws IOException
{
    return handleUnexpectedToken(instClass, p.currentToken(), p, null);
}

public Object handleUnexpectedToken(Class<?> instClass, JsonToken t,
            JsonParser p, String msg, Object... msgArgs)
        throws IOException
{
...
reportInputMismatch(instClass, msg);
return null; // never gets here
}

public <T> T reportInputMismatch(Class<?> targetType,
        String msg, Object... msgArgs) throws JsonMappingException
{
...
    msg = _format(msg, msgArgs);
    throw MismatchedInputException.from(getParser(), targetType, msg);
}

どうやら最終的に例外を送出するコードにしか到達せず、Object型の返り値は便宜的に付けられていることが分かりました。つまり元のコードの呼び出し方法を変えれば良さそうなことが分かります。

元々は例外オブジェクトを返り値で受けて、それをthrowしていました。

case _ => throw ctxt.mappingException(classOf[JValue])

handleUnexpectedTokenメソッドの中でthrowしているので、呼び出し時のthrowを削除します。

case _ => ctxt.handleUnexpectedToken(classOf[JValue], jp)

コミットする

コミットメッセージは、gitのお作法に従って、変更理由を書きましょう。

この記事なんか参考になると思います。

qiita.com

でもtypoの修正とかなら、「fixed typo」だけでも充分です。

PRを送る

修正ができたらPRを送ります。

github.com

終わりに

如何でしたでしょうか?1行のコード修正と言っても、ドキュメントや関連するソースを追いかける必要が有り、サクっと終わるわけではないですが、解決方法が分かると成長した感を実感できますね。

ほかにもドキュメントのtypoを直す、チュートリアルが最新バージョンと合っていない所を直す、サンプルコードを直す・追加する等、貢献できるところは色々と有るので、ぜひチャレンジして見て下さい。

その途中で調べることや試行錯誤することがたくさん出てきて、周辺知識がどんどん身についていくと、単純な修正だけでも得られることがたくさん有ることを実感できるのではないでしょうか。

「Scala関数型デザイン&プログラミング」のexerciseを解き進めるための環境準備

吉祥寺.pmのブログに掲載していた「Scala関数型デザイン&プログラミング」のexerciseを解く時の環境構築について、少し修正してこちらに載せ直しました。イベントブログにだけ載っているのも、もったいないな、と思って再掲。


環境構築

JDK(Java Development Kit)のインストール

Scalaはご存じの通り、JVM(Java Virtual Machine)上で実行される言語です。そのため、Scalaを使うためにはJDK(Java Development Kit)をインストールする必要が有ります。

Oracleのサイトからダウンロード

JDKのインストール方法はいろいろな所で解説されていますので、ここでは詳細は割愛しますが、自分の環境に合わせてOracleのサイトからインストーラをダウンロードしてインストールしてください。

Java SE - Downloads

Homebrewによるインストール

macOSではbrew caskコマンドでインストールできます。以下の1行で最新版がインストールされます。

$ brew cask install java

OpenJDKのインストール

Linuxの場合は、パッケージマネージャーから簡単にインストールできるOpenJDKを使った方が良いでしょう。

OpenJDK

yumや、aptといったパッケージマネージャーからインストールしてください。

Gitのインストール

Scala関数型デザイン&プログラミング」に記載されているコード例や、例題(exercise)のヒント、解答などはすべてGitHub上のリポジトリに置かれています。そのため、サンプルコードをダウンロードするためには、Gitをインストールする必要があります。

Gitのインストール方法もいろいろな所で解説されているので割愛しますが、公式サイトのドキュメントに詳しく書かれていますので、そちらを参考にしてみてください。

Gitのインストール

macOSではbrewコマンドでインストールします。

$ brew install git

サンプルコードのダウンロード

任意のディレクトリに、サンプルコードのリポジトリをクローンします。

$ git clone https://github.com/fpinscala/fpinscala.git

これで準備完了です。

特にScalaコンパイラをインストールしていませんが、そのあたりの仕組みは次の「sbtの実行」で解説します。

コードの実行準備

sbtの実行

ダウンロードしたサンプルコードのディレクトリに、sbt(Windows用はsbt.cmd)というコマンドが含まれていますので、まずはこれを実行します。

macOSや、Linuxの場合、sbtを起動します。

$ cd fpinscala
$ ./sbt

Windowsの場合は、sbt.cmdを起動します。

$ cd fpinscala
$ .\sbt.cmd

sbtは、Simple Build Toolという身も蓋もないくらい普通の名前が付けられたScala用のビルドツールです。

sbt Reference Manual — 始める sbt

sbt自体がScalaコンパイラ一式をダウンロードしてくれるので、Scala自体を手動でインストールする必要はありません。

sbtを起動して特にエラーが表示されなければ、準備はOKです。

sbtはひじょうに高機能なビルドツールですが、のちほど説明するprojectcompileconsoleruntestの5つのコマンドを覚えれば、以降のexerciseのコードを実装する上では十分です。

  • project

sbtでは一つのリポジトリで複数のプロジェクトを管理できます。そのプロジェクトを切り替えるためのコマンドです。どのようなプロジェクトが含まれているかは、projectsコマンドで確認します。

  • compile

ターゲットのプロジェクトに含まれるすべてのソースコードコンパイルします。

  • console

    sbtからScalaのREPL(Read - Eval - Print - Loop)を起動します。

  • run

ScalaJavaと同様にプログラムの実行は、main関数から始まります。runは、main関数を実行します。

もし、プロジェクト内に複数のmain関数が含まれる場合は、どのパッケージに属するmain関数を実行するか、選択するためのリストが表示されます。

  • test

Javaや、Scalaでは、テストコードはsrc/test/*ディレクトリに格納されますが、testは、testディレクトリに格納されたテストコードを実行します。

PermSizeの削除

macOSや、Linux環境で実行する際には、sbtコマンドを使いますが、Java8以降では不要なパラメータ(PermSize)が書かれており、実行のたびに警告メッセージが出てしまうので、Java8以降のJDKをインストールしている場合は、下記の通り書き換えることをお勧めします。

sbtは単なるシェルスクリプトで、実態はsbt-launch.jarにパラメータを与えて起動しているだけです(Windows用のsbt.cmdには最初から記述は有りません)。

変更前

SBT_OPTS="-Xms512M -Xmx1536M -Xss1M -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=256M"

変更後

SBT_OPTS="-Xms512M -Xmx1536M -Xss1M -XX:+CMSClassUnloadingEnabled"

brachの作成

以降、コードの実装を始めますが、サンプルコードのリポジトリは今でも日々コミットが続いています。自分が書いたコードを区別するためにも、gitのbranchを作成しておきましょう。

$ git checkout -b myexecirse

コードの実装

サンプルコードのディレクトリ構成は大きく分けて、以下の3つに分かれています。

exerciseと、answerが対になっているので、テキストエディタを上下分けて、それぞれ表示しながら進めるのがおすすめです。

exercise

書籍に掲載されているサンプルコードと、exerciseで書かれている関数のひな形(関数名と、引数、返値だけが書かれている)が掲載されています。例えば最初のリストの実装であれば、以下のファイルを書き換えていく形になります。

https://github.com/fpinscala/fpinscala/blob/master/exercises/src/main/scala/fpinscala/datastructures/List.scala

関数のひな形が掲載されているものはコードの本体が「sys.error("todo")」となっていて、実行するとエラーになるようになっています。まずはこの「sys.error("todo")」という部分を削除して実装を始めることになります。

def tail[A](l: List[A]): List[A] = sys.error("todo")

def tail[A](l: List[A]): List[A] = l match { ... }

なぜか関数のひな形が書かれていないものや、本誌に書かれたひな形と引数名が違ったりするものも有りますが、後述のanswerに書かれている回答の関数名と、引数、返値を見ながら進めると良いでしょう。

answer

exerciseの回答と、その解説が書かれています。

先ほどのListの回答は、以下のファイルに書かれています。

https://github.com/fpinscala/fpinscala/blob/master/answers/src/main/scala/fpinscala/datastructures/List.scala

answerkey

exerciseの回答がファイル別に置かれています。また、回答ごとに、ヒントも置かれているので、まずはこのヒントを見ながら実装していくと良いでしょう。

コンパイルと、実行

exerciseのディレクトリ配下に置かれているファイルを書き換えながら進めていくので、exerciseのディレクトリだけがコンパイルされるようにsbt上のプロジェクトを切り替えておきます。

また、compileコマンドでエラーが無いことを確認したら、consoleコマンドScalaのREPL(Read-eval-print loop)が起動するので、そのまま実装したパッケージ(Listでいえば、fpinscala.datastructures)をロードすることで、実装の確認ができます。

$ ./sbt
> project exercise
> compile
> console
scala> import fpinscala.datastructures._
scala> val x = List.Cons(1, Cons(2, Nil))
...

エラーが出たり、挙動が正しく無いときは、実装の正しさを、answerか、answerkeyを参照して確認します。

あとはひたすら繰り返しです。頑張りましょう。

runコマンド

なお、例題によってはmain関数を起動するものも有ります(第2章gettingstartedなど)。それらのmain関数を起動するときはsbtからrunコマンドを実行します。

プロジェクトの中には、複数のmain関数が有るので、どれを起動するか選択するリストが表示されます。パッケージ名を確認して、該当する番号を入力して、エンターキーを押下してください。

> run
...
Multiple main classes detected, select one to run:

 [1] fpinscala.streamingio.ProcessTest
 [2] fpinscala.gettingstarted.MyModule
 [3] fpinscala.gettingstarted.FormatAbsAndFactorial
 [4] fpinscala.gettingstarted.TestFib
 [5] fpinscala.gettingstarted.AnonymousFunctions
 [6] fpinscala.iomonad.IO2aTests
 [7] fpinscala.iomonad.IO2bTests

Enter number:

実装の記録(tips)

exerciseのファイルには、関数のひな形は書かれていても、対象のexerciseの番号が書かれていません。あとで振り返ったときに分かりづらいので、コメントでexerciseの番号を書いておくと便利です(「// exercise 3.3」のような形式で書いておきます)。

また、いろいろと自分で気がついたところも都度コメントで残しておくと、あとで振り返ったときに便利です。

章ごとに実装が終わったら、gitでコミットしておくとよいでしょう。

また、急激に難易度が上がるところや、最初から「難問」と書かれているような例題も有りますが、そうゆうときはさっさとanswerのコードを写経して、挙動や実装の背景を理解するようにシフトした方が良いでしょう。そのときに気がついたことをひたすらコメントで残しておく方が理解が早いでしょう。

テストコードの追加

sbtconsoleを使って実行結果を確認しても良いですが、いまどき実行結果はテストコードを書いて、テスト結果で確認すべきです。

以下に、exerciseで書いたコードをテストコードで確認する方法を紹介します。

Scalaのテスティングフレームワークとしては、ScalaTestか、Specs2がよく使われていますが、ここではScalaTestを使うことにします。

ScalaTest

依存ライブラリの追加

Build.scalaのoptsに、ScalaTestへの依存を追加します。

resolversの最後にカンマを追加するのを忘れないように。

val opts = Project.defaultSettings ++ Seq(
  scalaVersion := "2.11.7",
  resolvers += "Typesafe Repository" at "http://repo.typesafe.com/typesafe/releases/",
  libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.0" % "test"
)

テストコードの追加

exercises/src/test/scala/fpinscala/datastructures/ListTest.scalaというテストコードのファイルを用意します。パスの3番目がtestになっていることに注意して下さい。Javaではおなじみですが、テストコードはtestディレクトリに保存します。

例えば、3章で出てくるtailメソッドのテストコードは以下のように書けます。

ScalaTestではいくつかのテストスタイルが使えますが、ここでは一番シンプルに書けるFunSuiteを使っています。

最後のshould equalで期待する値との比較をしています。

import org.scalatest._

import fpinscala.datastructures._

class ListSuite extends FunSuite with Matchers {
  test("tailメソッドは先頭の要素を削除する") {
    val listInt = List(1, 2, 3)
    val listDouble = List(1.0, 2.0, 3.0)
    val listString = List("one", "two", "three")

    List.tail(listInt) should equal (List(2, 3))
    List.tail(listDouble) should equal (List(2.0, 3.0))
    List.tail(listString) should equal (List("two", "three"))
  }
}

テストはsbtから実行します。

$ ./sbt
> test
...
[info] ListSuite:
[info] - tailメソッドは先頭の要素を削除する
...
[success]...

最後に[success]が出力されればテスト全体が成功したことになります。テストが一つでも失敗すると[error]が表示されます。

どうように3章に出てくるsetHeadメソッドのテストを追加します。

import org.scalatest._

import fpinscala.datastructures._

class ListSuite extends FunSuite with Matchers {
  val listInt = List(1, 2, 3)
  val listDouble = List(1.0, 2.0, 3.0)
  val listString = List("one", "two", "three")

  test("tailメソッドは先頭の要素を削除する") {
    List.tail(listInt) should equal (List(2, 3))
    List.tail(listDouble) should equal (List(2.0, 3.0))
    List.tail(listString) should equal (List("two", "three"))
  }

  test("setHeadメソッドは先頭の要素を置き換える") {
    List.setHead(listInt, 4) should equal (List(4, 2, 3))
    List.setHead(listDouble, 4) should equal (List(4.0, 2.0, 3.0))
    List.setHead(listString, "four") should equal (List("four", "two", "three"))
  }
}

Chapter Note

すべて英語で書かれていますが、本書に載っていないChapter NotesがGitHubWikiに有りますので、時間に余裕があればこちらも読んでおくと参考になります。

Home · fpinscala/fpinscala Wiki · GitHub

おわりに

Scala関数型デザイン&プログラミング」は非常に噛み応えが有るというか、じっくり取り組む必要が有るし、exerciseのコードを書いてみても、書いたことの意味をきちんと解説してくれる人が近くにいないと、挫折し易いというか、本当にストロングスタイルな本ですが、最後まで進めると確実に実力がつく良本ですね。

Scala関数型デザイン&プログラミング」はScalaの入門書ではないので、Scalaの入門書としては元祖Scalaの解説本である「Scalaスケーラブルプログラミング」の方がおすすめです。つい先日最新の第3版が邦訳されました。

Scalaスケーラブルプログラミング第3版

Scalaスケーラブルプログラミング第3版

なお、技術書と言えば定番のO'Reillyからも何冊かScala本がリリースされていますが、邦訳がなかなかリリースされないですね。

Programming Scala: Scalability = Functional Programming + Objects

Programming Scala: Scalability = Functional Programming + Objects

Learning Scala: Practical Functional Programming for the JVM

Learning Scala: Practical Functional Programming for the JVM

Scala Cookbook: Recipes for Object-Oriented and Functional Programming

Scala Cookbook: Recipes for Object-Oriented and Functional Programming