Also support maps as arguments when public APIs use trailing map args

[richievos]

There's some APIs in elastisch that support trailing named arguments. For instance native.document.search

(defn search
  "Performs a search query across one or more indexes and one or more mapping types.

   Examples:

   (require '[clojurewerkz.elastisch.native.document :as doc])
   (require '[clojurewerkz.elastisch.query :as q])

   (doc/search \"people\" \"person\" :query (q/prefix :username \"appl\"))"
  [index mapping-type & {:as options}]
  (let [ft                  (es/search (cnv/->search-request index mapping-type options))
        ^SearchResponse res (.actionGet ft)]
    (cnv/search-response->seq res)))

This is handy when I'm directly calling search, ala

(es-doc/seach "foo" "bar" :size 10)

but is a PITA when trying to interact with search from another method that takes options. For instance, if I wanted to have a search method that I want to take a query and filter option, I end up having to write awkward code like:

(ns my.custom.type.that.has.defaults.and.such ...)

(defn search [name & {:as options}]
  (es-doc/search (concat ["myindex" "mytype" :size 15]
                         (flatten (vec (select-keys options [:query :filter]))))))

Rather than start my whole rant against hating the trailing named argument pattern (versus just passing a map), I'm asking here that when elastisch supports trailing named arguments it also supports passing them in as a map.

There may be a clojure pattern that makes this easier that I'm unaware of, but on the receiving side this the following works:

(defn search
  "Performs a search query across one or more indexes and one or more mapping types.

   Examples:

   (require '[clojurewerkz.elastisch.native.document :as doc])
   (require '[clojurewerkz.elastisch.query :as q])

   (doc/search \"people\" \"person\" :query (q/prefix :username \"appl\"))"
  [index mapping-type & args]
  (let [options (if (map? args) args (apply array-map args))
        ft                  (es/search (cnv/->search-request index mapping-type options))
        ^SearchResponse res (.actionGet ft)]
    (cnv/search-response->seq res)))

I'm aware throwing that if in all over the place is annoying, but such is the world of trailing named args.

[michaelklishin]

Sounds good.

[michaelklishin]

Going to give this a try this w/e.

[michaelklishin]

Should be fixed in master, will be in 2.0.0-beta4 shipping soon.

[richievos]

Thanks. This is awesome.