clojure.specを開発やテストで活用する

clojure.specは大きく3つの使い方がある

ドキュメントの内容を補完する

開発やテストのときにspecによるチェックを行う

ひとつ目は特に意識しなくてもいいんだけど、ふたつ目とみっつ目は意識して行わない限り使うことができない。ひとつずつ簡単に説明していくことにします。

ドキュメントの内容を補完する

code:clojure

(ns demo.core

(defn wrap-keyword-params

(wrap-keyword-params handler nil))

(let [k (if (and (regex? exclude-regex)

(re-matches exclude-regex k))

k

(keyword k))]

(assoc m k v)))

{}

params))]

(handler (update req :params f))))))

code:clojure

dev> (require 'demo.core)

;;=> nil

dev> (doc demo.core/wrap-keyword-params)

-------------------------

demo.core/wrap-keyword-params

;;=> nil

これに以下のようなspecを書いてあげる。

code:clojure

(instance? java.util.regex.Pattern x))

;; sはclojure.spec.alphaのエイリアス

(s/fdef wrap-keyword-params

:args (s/cat :handler fn? :regex (s/? regex?))

:ret fn?)

こうするとドキュメントの表示が以下のようにspecを考慮したものとなる。

code:clojure

dev> (doc demo.core/wrap-keyword-params)

-------------------------

demo.core/wrap-keyword-params

Spec

args: (cat :handler fn? :regex (? regex?))

ret: fn?

;;=> nil

開発やテストのときにspecによるチェックを行う

code:clojure

;; instrument実行前

dev> (demo.core/wrap-keyword-params identity "")

;; instrument実行後

dev> (require 'clojure.spec.test.alpha)

;;=> nil

dev> (clojure.spec.test.alpha/instrument)

dev> (demo.core/wrap-keyword-params identity "")

clojure.core/ex-info (core.clj:4739)

で、これをどうやって実行すると良いのかという話。いくつかの選択肢があるので、パッと書き出してみる。

code:clojure

(ns dev

(stest/instrument)

プロパティベーステスト