Я пытаюсь использовать этот инструмент: https://github.com/stathissideris/spec-provider
spec-провайдер не дает желаемого результата, потому что ваши данные представляют собой сложную вложенную / рекурсивную структуру.Некоторые из этих карт лучше всего подходят с multi-specs , но провайдер спецификаций этого не сделает;одно из предостережений в его документах гласит: Не делается попыток сделать вывод о мультиспецификации.
Единственный способ правильно указать некоторые из этих карт - использоватьспецификации их спецификации будут зависеть от их значения :importer.datamodel/type.
Сначала давайте посмотрим на ключи верхнего уровня (при условии, что карта находится в привязке с именем data):
(keys data) => (:contexts :datasources :iois)
Создайте s/keys спецификацию для самой внешней карты:
(s/def ::my-map
(s/keys :req-un [::contexts ::datasources ::iois]))
Эти ключи не определены, но мы должны использовать квалифицированные ключевые слова w / :req-un для их спецификации.Мы можем использовать REPL для просмотра форм вложенных карт и их взаимосвязей с :importer.datamodel/type, обходя вложенную структуру и собирая данные:
(let [keysets (atom #{})]
(clojure.walk/postwalk
(fn [v]
(when (map? v)
(swap! keysets conj [(:importer.datamodel/type v) (keys v)]))
v)
data)
@keysets)
=>
#{...
["organisation" (:importer.datamodel/global-id :importer.datamodel/type :name)]
[nil (:context :context-association-type :context-association-name :priority)]
["description"
(:importer.datamodel/global-id :date :fulltext :location-meanings
:interaction-name :importer.datamodel/type :has-contexts :facts :attributes)]
["event" (:importer.datamodel/global-id :importer.datamodel/type :datasource :features :attributes :ioi-slice)]
...}
(Предстоящая альфа-спецификация должна облегчить определениеСпецификации программно из этих данных.)
Multi-specs
Мы можем видеть, что есть некоторые формы карт, которые не имеют :importer.datamodel/type, но мы можем написать мультиспекуляции для нихчто делать.Сначала определите мультиметод для отправки с помощью клавиши типа:
(defmulti type-spec :importer.datamodel/type)
Затем запишите defmethod для каждого значения :importer.datamodel/type.Вот несколько примеров:
(defmethod type-spec :default [_] (s/keys))
(defmethod type-spec "organisation" [_]
(s/keys :req [:importer.datamodel/global-id]
:req-un [::name]))
(defmethod type-spec "description" [_]
(s/keys :req [:importer.datamodel/global-id]
:req-un [::date ::fulltext ::location-meanings ::interaction-name
::has-contexts ::facts ::attributes]))
(defmethod type-spec "event" [_]
(s/keys :req-un [::features]))
Затем определите s/multi-spec:
(s/def ::datamodel
(s/multi-spec type-spec :importer.datamodel/type))
Теперь любая карта, которой мы соответствуем ::datamodel, будет разрешать спецификацию на основе ее :importer.datamodel/typeзначение.Мы можем присвоить эту спецификацию ключевым словам, которые спецификация будет использовать для соответствия карт, например, одному из самых внешних ключей:
(s/def ::contexts (s/coll-of ::datamodel))
Теперь, если вы удалите требуемый ключ из одной из карт, которые мы специфицировали под :contexts, спецификация может сказать вам, что не так.Например, удаление ключа :name из карты "organisation":
(s/explain ::my-map data)
In: [:contexts 3]
val: #:importer.datamodel{:global-id "88844f94f79c75acfcb957bb41386149",
:type "organisation"}
fails spec: :playground.so/datamodel
at: [:contexts "organisation"]
predicate: (contains? % :name)
Другие спецификации
Для карт, которые не имеют :importer.datamodel/type, вы должны иметь возможностьопределить ключевую спецификацию.Например, вложенный ключ :has-contexts имеет коллекцию карт без :importer.datamodel/type, но если мы можем предположить, что все они будут похожи, мы можем написать эту спецификацию:
(s/def ::has-contexts
(s/coll-of (s/keys :req-un [::context ::context-association-type
::context-association-name ::priority])))
:has-contexts isна карте мы уже рассмотрели мультиспекуляцию выше, и простая регистрация спецификации для этого ключа приведет к тому, что спецификация будет соответствовать ее значениям.Самый внешний ключ, который содержит эту спецификацию, - :iois, поэтому мы можем также указать эту клавишу:
(s/def ::iois (s/coll-of ::datamodel))
Теперь соответствие ввода спецификации ::my-map автоматически охватит больше данных.
Каким инструментом можно создать спецификацию для такой структуры?
Как видите, написание полной спецификации для этой структуры нетривиально, но возможно.Я не знаю ни одного существующего инструмента, который мог бы автоматически вывести полную, «правильную» спецификацию для этой структуры.Было бы интуитивно понятно, что :importer.datamodel/type - это ключ, который можно использовать для отправки различных s/keys спецификаций, и он все равно будет делать потенциально неверное предположение.Я думаю, что инструментальная генерация спецификаций с поддержкой более реалистична и практична в этом случае.