Should we have a phrase-all function?

[ouvanous]

Hi,
Not sure if i understood all correctly but i don't think that there is a method to get all the errors ?
like :

(defn phrase-all
  [context spec x]
  (some->> (s/explain-data spec x)
           ::s/problems
           (map #(phrase context %))))

Do i miss something ?
Thanks,

[alexanderkiel]

You are right. There is no phrase-all function. In the README I explain why:

However, you have to use phrase directly if you like to phrase more than one problem. The library doesn't contain a phrase-all function because it doesn't know how to concatenate messages.

Returning a list of messages from phrase-all might be a viable solution. So I let the issue open for votes to provide a phrase-all as you suggested.

[leblowl]

I think it's a nice idea, some folks like to return all errors at once for a particular API input - phrase-all would make that easy

[alexanderkiel]

Do you also think, that a simple list of messages is a good solution?

[leblowl]

@alexanderkiel yes that's what I would expect

[jsa-aerial]

Here's what I have for this - it works very well:

(defn validate-msg
  [spec x & {:keys [sep prefix suffix with-val?]
             :or {sep " and " prefix "" suffix "" with-val? false}}]
  (let [msgbody (->> (s/explain-data spec  x) ::s/problems
                     (mapv #(phrase {} %))
                     (cljstr/join sep))
        msgval (if with-val? (format "<%s>: " x) "")]
    (str msgval prefix msgbody suffix)))

(defn make-validator [spec & validate-msg-kvs]
  (fn [x]
    (if (not (s/valid? spec x))
      (apply validate-msg spec x validate-msg-kvs)
      "")))

;;; Example use:
(def validate-bc-rep-xref (make-validator ::bc-replicate-xref-rec))

(validate-bc-rep-xref
 {:strain-cond-repid (str/split #"-" "T4P-006PEN120MIN-CC"),
  :illumbc "TACTTAG",
  :sampbc "TGGTCCTx"})
=> "rep id `CC` in `T4P-006PEN120MIN-CC` must be a single upper case or lower case letter or digit and Sample BC `TGGTCCTx` must contain only 'A', 'T', 'G', 'C' characters and Illumina BC `TACTTAG` is not listed as an index in SampleSheet.csv"

[reutsharabani]

I think this is required to provide messages to consumers. Its very unpleasant to provide one error at a time.

This suggests users of this library will create their phrase-all for any non-trivial use-case (probably most use cases).

Therefore I support adding it to the core of the library.