如果我的规范位于单独的命名空间中,我如何将它们用于预期目的?
How can I use my specs for their intended purposes if they are in a separate namespace?
clojure.spec
Guide 中的示例之一是一个简单的选项解析规范:
(require '[clojure.spec :as s])
(s/def ::config
(s/* (s/cat :prop string?
:val (s/alt :s string? :b boolean?))))
(s/conform ::config ["-server" "foo" "-verbose" true "-user" "joe"])
;;=> [{:prop "-server", :val [:s "foo"]}
;; {:prop "-verbose", :val [:b true]}
;; {:prop "-user", :val [:s "joe"]}]
稍后,在 validation section, a function is defined that internally conform
中使用此规范输入:
(defn- set-config [prop val]
(println "set" prop val))
(defn configure [input]
(let [parsed (s/conform ::config input)]
(if (= parsed ::s/invalid)
(throw (ex-info "Invalid input" (s/explain-data ::config input)))
(doseq [{prop :prop [_ val] :val} parsed]
(set-config (subs prop 1) val)))))
(configure ["-server" "foo" "-verbose" true "-user" "joe"])
;; set server foo
;; set verbose true
;; set user joe
;;=> nil
由于本指南旨在易于从 REPL 中遵循,因此所有这些代码都在同一命名空间中进行评估。不过,在 this answer 中,@levand 建议将规范放在单独的命名空间中:
I usually put specs in their own namespace, alongside the namespace that they are describing.
这会破坏上面 ::config
的用法,但可以解决该问题:
It is preferable for spec key names to be in the namespace of the code, however, not the namespace of the spec. This is still easy to do by using a namespace alias on the keyword:
(ns my.app.foo.specs
(:require [my.app.foo :as f]))
(s/def ::f/name string?)
他接着解释说,规范和实现 可以 放在同一个命名空间中,但这并不理想:
While I certainly could put them right alongside the spec'd code in the same file, that hurts readability IMO.
但是,我无法理解这如何与 destructuring. As an example, I put together a little Boot 项目一起使用,其中上述代码已转换为多个命名空间。
boot.properties
:
BOOT_CLOJURE_VERSION=1.9.0-alpha7
src/example/core.clj
:
(ns example.core
(:require [clojure.spec :as s]))
(defn- set-config [prop val]
(println "set" prop val))
(defn configure [input]
(let [parsed (s/conform ::config input)]
(if (= parsed ::s/invalid)
(throw (ex-info "Invalid input" (s/explain-data ::config input)))
(doseq [{prop :prop [_ val] :val} parsed]
(set-config (subs prop 1) val)))))
src/example/spec.clj
:
(ns example.spec
(:require [clojure.spec :as s]
[example.core :as core]))
(s/def ::core/config
(s/* (s/cat :prop string?
:val (s/alt :s string? :b boolean?))))
build.boot
:
(set-env! :source-paths #{"src"})
(require '[example.core :as core])
(deftask run []
(with-pass-thru _
(core/configure ["-server" "foo" "-verbose" true "-user" "joe"])))
但是当然,当我实际 运行 这个时,我得到一个错误:
$ boot run
clojure.lang.ExceptionInfo: Unable to resolve spec: :example.core/config
我可以通过将 (require 'example.spec)
添加到 build.boot
来解决这个问题,但这很丑陋且容易出错,并且只会随着我的规范命名空间数量的增加而变得更糟。由于多种原因,我不能 require
来自实现命名空间的规范命名空间。这是一个使用 fdef
.
的示例
boot.properties
:
BOOT_CLOJURE_VERSION=1.9.0-alpha7
src/example/spec.clj
:
(ns example.spec
(:require [clojure.spec :as s]))
(alias 'core 'example.core)
(s/fdef core/divisible?
:args (s/cat :x integer? :y (s/and integer? (complement zero?)))
:ret boolean?)
(s/fdef core/prime?
:args (s/cat :x integer?)
:ret boolean?)
(s/fdef core/factor
:args (s/cat :x (s/and integer? pos?))
:ret (s/map-of (s/and integer? core/prime?) (s/and integer? pos?))
:fn #(== (-> % :args :x) (apply * (for [[a b] (:ret %)] (Math/pow a b)))))
src/example/core.clj
:
(ns example.core
(:require [example.spec]))
(defn divisible? [x y]
(zero? (rem x y)))
(defn prime? [x]
(and (< 1 x)
(not-any? (partial divisible? x)
(range 2 (inc (Math/floor (Math/sqrt x)))))))
(defn factor [x]
(loop [x x y 2 factors {}]
(let [add #(update factors % (fnil inc 0))]
(cond
(< x 2) factors
(< x (* y y)) (add x)
(divisible? x y) (recur (/ x y) y (add y))
:else (recur x (inc y) factors)))))
build.boot
:
(set-env!
:source-paths #{"src"}
:dependencies '[[org.clojure/test.check "0.9.0" :scope "test"]])
(require '[clojure.spec.test :as stest]
'[example.core :as core])
(deftask run []
(with-pass-thru _
(prn (stest/run-all-tests))))
第一个问题最明显:
$ boot run
clojure.lang.ExceptionInfo: No such var: core/prime?
data: {:file "example/spec.clj", :line 16}
java.lang.RuntimeException: No such var: core/prime?
在我的 factor
规范中,我想使用我的 prime?
谓词来验证返回的因子。 factor
规范的妙处在于,假设 prime?
是正确的,它既完整地记录了 factor
函数,又消除了我为该函数编写任何其他测试的需要。但如果你觉得这太酷了,你可以用 pos?
或其他东西代替它。
不出所料,再次尝试 boot run
时仍然会出现错误,这次是抱怨 :args
规范对 #'example.core/divisible?
或 #'example.core/prime?
或缺少 #'example.core/factor
(以先尝试的为准)。这是因为,无论您 alias
是否是命名空间,fdef
都不会 使用 那个别名,除非您给它的符号命名一个 var 已经存在。如果 var 不存在,则符号不会展开。 (为了更有趣,从 build.boot
中删除 :as core
,看看会发生什么。)
如果您想保留该别名,您需要从 example.core
中删除 (:require [example.spec])
,并在 build.boot
中添加一个 (require 'example.spec)
。当然,require
需要 在 example.core
之后,否则它不会起作用。到那时,为什么不直接将 require
放入 example.spec
?
所有这些问题都可以通过将规范与实现放在同一个文件中来解决。那么,我真的应该将规范与实现放在不同的命名空间中吗?如果是这样,我上面详述的问题如何解决?
这个问题展示了在应用程序中使用的规范和用于测试应用程序的规范之间的重要区别。
应用程序中用于符合或验证输入的规范(如此处的 :example.core/config
)是应用程序代码的一部分。它们可能位于使用它们的同一文件中,也可能位于单独的文件中。在后一种情况下,应用程序代码必须 :require
规范,就像任何其他代码一样。
用作测试的规范在它们指定的代码之后加载。这些是您的 fdef
和生成器。您可以将它们放在与代码分开的命名空间中——甚至放在单独的目录中,而不是与您的应用程序打包在一起——它们将 :require
代码。
您可能有一些谓词或实用函数被两种规范使用。这些将进入一个单独的命名空间。
clojure.spec
Guide 中的示例之一是一个简单的选项解析规范:
(require '[clojure.spec :as s])
(s/def ::config
(s/* (s/cat :prop string?
:val (s/alt :s string? :b boolean?))))
(s/conform ::config ["-server" "foo" "-verbose" true "-user" "joe"])
;;=> [{:prop "-server", :val [:s "foo"]}
;; {:prop "-verbose", :val [:b true]}
;; {:prop "-user", :val [:s "joe"]}]
稍后,在 validation section, a function is defined that internally conform
中使用此规范输入:
(defn- set-config [prop val]
(println "set" prop val))
(defn configure [input]
(let [parsed (s/conform ::config input)]
(if (= parsed ::s/invalid)
(throw (ex-info "Invalid input" (s/explain-data ::config input)))
(doseq [{prop :prop [_ val] :val} parsed]
(set-config (subs prop 1) val)))))
(configure ["-server" "foo" "-verbose" true "-user" "joe"])
;; set server foo
;; set verbose true
;; set user joe
;;=> nil
由于本指南旨在易于从 REPL 中遵循,因此所有这些代码都在同一命名空间中进行评估。不过,在 this answer 中,@levand 建议将规范放在单独的命名空间中:
I usually put specs in their own namespace, alongside the namespace that they are describing.
这会破坏上面 ::config
的用法,但可以解决该问题:
It is preferable for spec key names to be in the namespace of the code, however, not the namespace of the spec. This is still easy to do by using a namespace alias on the keyword:
(ns my.app.foo.specs (:require [my.app.foo :as f])) (s/def ::f/name string?)
他接着解释说,规范和实现 可以 放在同一个命名空间中,但这并不理想:
While I certainly could put them right alongside the spec'd code in the same file, that hurts readability IMO.
但是,我无法理解这如何与 destructuring. As an example, I put together a little Boot 项目一起使用,其中上述代码已转换为多个命名空间。
boot.properties
:
BOOT_CLOJURE_VERSION=1.9.0-alpha7
src/example/core.clj
:
(ns example.core
(:require [clojure.spec :as s]))
(defn- set-config [prop val]
(println "set" prop val))
(defn configure [input]
(let [parsed (s/conform ::config input)]
(if (= parsed ::s/invalid)
(throw (ex-info "Invalid input" (s/explain-data ::config input)))
(doseq [{prop :prop [_ val] :val} parsed]
(set-config (subs prop 1) val)))))
src/example/spec.clj
:
(ns example.spec
(:require [clojure.spec :as s]
[example.core :as core]))
(s/def ::core/config
(s/* (s/cat :prop string?
:val (s/alt :s string? :b boolean?))))
build.boot
:
(set-env! :source-paths #{"src"})
(require '[example.core :as core])
(deftask run []
(with-pass-thru _
(core/configure ["-server" "foo" "-verbose" true "-user" "joe"])))
但是当然,当我实际 运行 这个时,我得到一个错误:
$ boot run
clojure.lang.ExceptionInfo: Unable to resolve spec: :example.core/config
我可以通过将 (require 'example.spec)
添加到 build.boot
来解决这个问题,但这很丑陋且容易出错,并且只会随着我的规范命名空间数量的增加而变得更糟。由于多种原因,我不能 require
来自实现命名空间的规范命名空间。这是一个使用 fdef
.
boot.properties
:
BOOT_CLOJURE_VERSION=1.9.0-alpha7
src/example/spec.clj
:
(ns example.spec
(:require [clojure.spec :as s]))
(alias 'core 'example.core)
(s/fdef core/divisible?
:args (s/cat :x integer? :y (s/and integer? (complement zero?)))
:ret boolean?)
(s/fdef core/prime?
:args (s/cat :x integer?)
:ret boolean?)
(s/fdef core/factor
:args (s/cat :x (s/and integer? pos?))
:ret (s/map-of (s/and integer? core/prime?) (s/and integer? pos?))
:fn #(== (-> % :args :x) (apply * (for [[a b] (:ret %)] (Math/pow a b)))))
src/example/core.clj
:
(ns example.core
(:require [example.spec]))
(defn divisible? [x y]
(zero? (rem x y)))
(defn prime? [x]
(and (< 1 x)
(not-any? (partial divisible? x)
(range 2 (inc (Math/floor (Math/sqrt x)))))))
(defn factor [x]
(loop [x x y 2 factors {}]
(let [add #(update factors % (fnil inc 0))]
(cond
(< x 2) factors
(< x (* y y)) (add x)
(divisible? x y) (recur (/ x y) y (add y))
:else (recur x (inc y) factors)))))
build.boot
:
(set-env!
:source-paths #{"src"}
:dependencies '[[org.clojure/test.check "0.9.0" :scope "test"]])
(require '[clojure.spec.test :as stest]
'[example.core :as core])
(deftask run []
(with-pass-thru _
(prn (stest/run-all-tests))))
第一个问题最明显:
$ boot run
clojure.lang.ExceptionInfo: No such var: core/prime?
data: {:file "example/spec.clj", :line 16}
java.lang.RuntimeException: No such var: core/prime?
在我的 factor
规范中,我想使用我的 prime?
谓词来验证返回的因子。 factor
规范的妙处在于,假设 prime?
是正确的,它既完整地记录了 factor
函数,又消除了我为该函数编写任何其他测试的需要。但如果你觉得这太酷了,你可以用 pos?
或其他东西代替它。
不出所料,再次尝试 boot run
时仍然会出现错误,这次是抱怨 :args
规范对 #'example.core/divisible?
或 #'example.core/prime?
或缺少 #'example.core/factor
(以先尝试的为准)。这是因为,无论您 alias
是否是命名空间,fdef
都不会 使用 那个别名,除非您给它的符号命名一个 var 已经存在。如果 var 不存在,则符号不会展开。 (为了更有趣,从 build.boot
中删除 :as core
,看看会发生什么。)
如果您想保留该别名,您需要从 example.core
中删除 (:require [example.spec])
,并在 build.boot
中添加一个 (require 'example.spec)
。当然,require
需要 在 example.core
之后,否则它不会起作用。到那时,为什么不直接将 require
放入 example.spec
?
所有这些问题都可以通过将规范与实现放在同一个文件中来解决。那么,我真的应该将规范与实现放在不同的命名空间中吗?如果是这样,我上面详述的问题如何解决?
这个问题展示了在应用程序中使用的规范和用于测试应用程序的规范之间的重要区别。
应用程序中用于符合或验证输入的规范(如此处的 :example.core/config
)是应用程序代码的一部分。它们可能位于使用它们的同一文件中,也可能位于单独的文件中。在后一种情况下,应用程序代码必须 :require
规范,就像任何其他代码一样。
用作测试的规范在它们指定的代码之后加载。这些是您的 fdef
和生成器。您可以将它们放在与代码分开的命名空间中——甚至放在单独的目录中,而不是与您的应用程序打包在一起——它们将 :require
代码。
您可能有一些谓词或实用函数被两种规范使用。这些将进入一个单独的命名空间。