(ns codeina.reader.clojure

"Read raw documentation information from Clojure source directory."

(:require [clojure.java.io :as io]

[clojure.tools.namespace.find :as ns]

[clojure.string :as str]

[codeina.utils :refer (assoc-some update-some correct-indent)])

(:import java.util.jar.JarFile))

(defn- sorted-public-vars

[namespace]

(->> (ns-publics namespace)

(vals)

(sort-by (comp :name meta))))

(defn- no-doc?

"Return true if a var contains no-doc label."

[var]

(let [{:keys [skip-wiki no-doc]} (meta var)]

(or skip-wiki no-doc)))

(defn- proxy?

"Return true if provided var has reference to proxy

[var]

(re-find #"proxy\$" (-> var meta :name str)))

(defn- macro?

[var]

(:macro (meta var)))

(defn- multimethod?

[var]

(instance? clojure.lang.MultiFn (var-get var)))

(defn- protocol?

[var]

(let [value (var-get var)]

(and (map? value)

(not (sorted? value)) ; workaround for CLJ-1242

(:on-interface value))))

(defn- protocol-method?

[vars var]

(if-let [p (:protocol (meta var))]

(some #{p} vars)))

(defn- protocol-methods

[protocol vars]

(filter #(= protocol (:protocol (meta %))) vars))

(defn- var-type

[var]

(cond

(macro? var) :macro

(multimethod? var) :multimethod

(protocol? var) :protocol

:else :var))

(defn- read-var

[vars var]

(-> (meta var)

(select-keys [:name :file :line :arglists :doc :dynamic

:added :deprecated :doc/format])

(update-some :doc correct-indent)

(assoc-some :type (var-type var)

:members (seq (map (partial read-var vars)

(protocol-methods var vars))))))

(defn- read-publics

[namespace]

(let [vars (sorted-public-vars namespace)]

(->> vars

(remove proxy?)

(remove no-doc?)

(remove (partial protocol-method? vars))

(map (partial read-var vars))

(sort-by (comp str/lower-case :name)))))

(defn- read-ns

[namespace]

(try

(require namespace)

(-> (find-ns namespace)

(meta)

(assoc :name namespace)

(assoc :publics (read-publics namespace))

(update-some :doc correct-indent)

(list))

(catch Exception e

(println

(format "Could not generate clojure documentation for %s - root cause: %s %s"

namespace

(.getName (class e))

(.getMessage e))))))

(defn- jar-file?

[file]

(and

(.isFile file)

(-> file .getName (.endsWith ".jar"))))

(defn- find-namespaces

[file]

(cond

(.isDirectory file) (ns/find-namespaces-in-dir file)

(jar-file? file) (ns/find-namespaces-in-jarfile (JarFile. file))))

(defn read-namespaces

"Read Clojure namespaces from a source directory (defaults to

([] (read-namespaces "src"))

([path]

(->> (io/file path)

(find-namespaces)

(mapcat read-ns)

(remove :no-doc)))

([path & paths]

(mapcat read-namespaces (cons path paths))))