scala-sbt.g8

Scala界ではプロジェクトの雛形生成器?としてgiter8が有名で、Typesafe Stack 2.0でも使われています。

Installing the Typesafe Stack 2.0.2にはscalaプロジェクトの雛形も多数用意されていますが、プレインなsbtプロジェクトとしてはscala-sbtが用意されています。

以下のようにするとsbtプロジェクトの雛形を簡単に構築できます。

$ g8 typesafehub/scala-sbt

オレ様scala-sbt

実際に自分プロジェクトで使うとプレインバニラな雛形は物足りなくなるので、各所でオレ様scala-sbtが多数作られていると思います。

ボクも自分用に作ってみたので紹介します。自分用にカスタマイズしたポイントは以下になります。(注意：個人向けなので、普通に使って便利なのかは保証の限りではありません。(笑))

プラグインの設定

sbtプラグインとして以下のものの設定を行いました。

• ensime
• eclipse plugin
• conscript
• onejar

プログラムの雛形

生成するプログラムの雛形として以下の機能を盛り込みました。ちょっとした開発ツールを作る時の土台にすることを想定しています。

• scalaz
• scalax.io
• オプションのハンドリング
• コマンドの切り分け
• エラー処理
• Scalatest

mainのソースコードは以下のようになります。

view plainprint?

1. package com.example.command  
2.   
3. import scala.util.control.Exception.{catching, allCatch}  
4. import scalaz.{Resource => _, _}, Scalaz._  
5. import scalax.io._  
6. import scalax.file._  
7.   
8. class Command(val args: Array[String]) {  
9.   var verbose: Boolean = false  
10.   var directory: Option[String] = None  
11.   
12.   def run() {  
13.     catching(classOf[java.io.IOException]).withApply {  
14.       e => _error(e.getMessage)  
15.     } apply {  
16.       _run()  
17.     }  
18.   }  
19.   
20.   private def _run() {  
21.     _parse_options(args.toList) match {  
22.       case "ls" :: Nil => _ls()  
23.       case "cat" :: file :: Nil => _cat(file)  
24.       case _ => _usage  
25.     }  
26.   }  
27.   
28.   private def _error(msg: String) {  
29.     Console.err.println(msg)  
30.   }  
31.   
32.   private def _parse_options(args: List[String]): List[String] = {  
33.     _parse_options(args, Nil)  
34.   }  
35.   
36.   private def _parse_options(in: List[String], out: List[String]): List[String] = {  
37.     in match {  
38.       case Nil => out  
39.       case "-verbose" :: rest => {  
40.         verbose = true  
41.         _parse_options(rest, out)  
42.       }  
43.       case "-dir" :: arg :: rest => {  
44.         directory = arg.some  
45.         _parse_options(rest, out)  
46.       }  
47.       case arg :: rest => _parse_options(rest, out :+ arg)  
48.     }  
49.   }  
50.   
51.   private def _usage {  
52.     println("usage: sample command args")  
53.   }  
54.   
55.   private def _ls() {  
56.     for (path <- Path(directory | ".").children("[^.]*", nil)) {  
57.       println(path.name)  
58.     }  
59.   }  
60.   
61.   private def _cat(file: String) {  
62.     println(Resource.fromFile(file).string)  
63.   }  
64. }  

package com.example.command

import scala.util.control.Exception.{catching, allCatch}
import scalaz.{Resource => _, _}, Scalaz._
import scalax.io._
import scalax.file._

class Command(val args: Array[String]) {
  var verbose: Boolean = false
  var directory: Option[String] = None

  def run() {
    catching(classOf[java.io.IOException]).withApply {
      e => _error(e.getMessage)
    } apply {
      _run()
    }
  }

  private def _run() {
    _parse_options(args.toList) match {
      case "ls" :: Nil => _ls()
      case "cat" :: file :: Nil => _cat(file)
      case _ => _usage
    }
  }

  private def _error(msg: String) {
    Console.err.println(msg)
  }

  private def _parse_options(args: List[String]): List[String] = {
    _parse_options(args, Nil)
  }

  private def _parse_options(in: List[String], out: List[String]): List[String] = {
    in match {
      case Nil => out
      case "-verbose" :: rest => {
        verbose = true
        _parse_options(rest, out)
      }
      case "-dir" :: arg :: rest => {
        directory = arg.some
        _parse_options(rest, out)
      }
      case arg :: rest => _parse_options(rest, out :+ arg)
    }
  }

  private def _usage {
    println("usage: sample command args")
  }

  private def _ls() {
    for (path <- Path(directory | ".").children("[^.]*", nil)) {
      println(path.name)
    }
  }

  private def _cat(file: String) {
    println(Resource.fromFile(file).string)
  }
}

Scalatestによるテストケースは以下のようになります。

view plainprint?

1. package com.example.command  
2.   
3. import org.scalatest.WordSpec  
4. import org.scalatest.matchers.ShouldMatchers  
5. import org.scalatest.junit.JUnitRunner  
6. import org.junit.runner.RunWith  
7.   
8. @RunWith(classOf[JUnitRunner])  
9. class CommandSpec extends WordSpec with ShouldMatchers {  
10.   "Command" should {  
11.     "execute" that {  
12.       "empty arguments" in {  
13.         val app = new Command(Array())  
14.         app.run()  
15.       }  
16.       "one argument" in {  
17.         val app = new Command(Array("ls"))  
18.         app.run()  
19.       }  
20.     }  
21.   }  
22. }  

package com.example.command

import org.scalatest.WordSpec
import org.scalatest.matchers.ShouldMatchers
import org.scalatest.junit.JUnitRunner
import org.junit.runner.RunWith

@RunWith(classOf[JUnitRunner])
class CommandSpec extends WordSpec with ShouldMatchers {
  "Command" should {
    "execute" that {
      "empty arguments" in {
        val app = new Command(Array())
        app.run()
      }
      "one argument" in {
        val app = new Command(Array("ls"))
        app.run()
      }
    }
  }
}

使い方

giter8

giter8のインストール方法はトップページにありますが、ここには載っていないMacPortsでもインストールできます。ボクはMacPortsでインストールしました。

$ sudo port install giter8

scala-sbtの雛形生成

オレ様版scala-sbtの雛形生成は以下になります。

$ g8 asami/scala-sbt

以下のようにパラメタを聞いてくるので入力すると雛形が生成されます。

organization [com.example]: 

package [com.example.command]: 

name [command]: 

scala_version [2.9.2]: 

version [0.1-SNAPSHOT]: 

コンパイル＆テスト

雛形が生成されるので、コンパイル＆テストしてみます。

$ cd command
$ sbt test

最後に以下のようなメッセージが出て正常終了するはずです。

[info] CommandSpec:
[info] Command 
[info]   should execute that 
[info]   - empty arguments
[info]   - one argument
[info] Passed: : Total 2, Failed 0, Errors 0, Passed 2, Skipped 0
[success] Total time: 13 s ...

ensime

ensimeの環境設定は以下になります。

$ sbt "ensime generate"

eclipse

Eclipseの環境設定は以下になります。

$ sbt eclipse

これで開発はEmacs&ensime、デバッグはEclipseの最強の組合せでScalaプログラミングできる環境を簡単に整えることができます！(笑)