chore: add specs to the codebase

README.md

@@ -1,7 +1,7 @@
 # GitHub changelog
 
 [![Continuous Integration status](https://api.travis-ci.org/whitepages/github-changelog.svg?branch=master)](http://travis-ci.org/whitepages/github-changelog)
-[![Docker Build Status](https://img.shields.io/docker/build/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/whitepages/github-changelog/)
+[![Docker Build Status](https://img.shields.io/docker/build/whitepages/github-changelog.svg)](https://hub.docker.com/r/whitepages/github-changelog/)
 [![Docker pulls](https://img.shields.io/docker/pulls/whitepages/github-changelog.svg)](https://hub.docker.com/r/whitepages/github-changelog/)
 [![GitHub license](https://img.shields.io/github/license/whitepages/github-changelog.svg)](https://github.com/whitepages/github-changelog/blob/master/LICENSE)
 

deps.edn

@@ -1,15 +1,15 @@
 {:paths   ["src"]
  :deps    {org.clojure/clojure             {:mvn/version "1.10.1"}
            org.martinklepsch/clj-http-lite {:mvn/version "0.4.3"}
-           metosin/jsonista                {:mvn/version "0.2.4"}
-           org.clojure/core.async          {:mvn/version "0.4.500"} ; clojure spec fixed
+           metosin/jsonista                {:mvn/version "0.2.5"}
+           org.clojure/core.async          {:mvn/version "1.0.567"} ; clojure spec fixed
            throttler                       {:mvn/version "1.0.0"}
-           org.slf4j/slf4j-nop             {:mvn/version "1.7.28"}
+           org.slf4j/slf4j-nop             {:mvn/version "1.7.30"}
            grimradical/clj-semver          {:mvn/version "0.3.0"
                                             :exclusions  [org.clojure/clojure]}
-           org.clojure/tools.cli           {:mvn/version "0.4.2"}}
+           org.clojure/tools.cli           {:mvn/version "1.0.194"}}
  :aliases {:test     {:extra-paths ["test"]
-                      :extra-deps  {org.clojure/test.check        {:mvn/version "0.9.0"}
+                      :extra-deps  {org.clojure/test.check        {:mvn/version "0.10.0"}
                                     lambdaisland/kaocha           {:mvn/version "0.0-541"}
                                     lambdaisland/kaocha-cloverage {:mvn/version "0.0-41"}}}
            :metav    {:extra-deps {metav {:mvn/version "1.5.4"}}}

src/github_changelog/cli.clj

@@ -1,8 +1,7 @@
 (ns github-changelog.cli
   (:gen-class)
-  (:require [clojure
-             [edn :as edn]
-             [string :as str]]
+  (:require [clojure.edn :as edn]
+            [clojure.string :as str]
             [clojure.tools.cli :as cli]
             [github-changelog.core :as core]
             [github-changelog.formatters.markdown :as md]))

src/github_changelog/config.clj

@@ -0,0 +1,35 @@
+(ns github-changelog.config
+  (:require [clojure.spec.alpha :as s]
+            [github-changelog.spec :as spec]))
+
+(s/def ::git-url ::spec/url)
+
+(s/def ::github ::spec/url)
+
+(s/def ::github-api ::spec/url)
+
+(s/def ::jira ::spec/url)
+
+(s/def ::user ::spec/non-blank-string)
+
+(s/def ::repo ::spec/non-blank-string)
+
+(s/def ::dir ::spec/non-blank-string)
+
+(s/def ::update? boolean?)
+
+(s/def ::tag-prefix string?)
+
+(s/def ::token ::spec/non-blank-string)
+
+(s/def ::config-map
+  (s/keys :req-un [::user ::repo]
+          :opt-un [::token ::github ::github-api ::jira ::dir ::update? ::git-url]))
+
+(def defaults {:github     "https://github.com/"
+               :github-api "https://api.github.com/"
+               :update?    true
+               :tag-prefix "v"})
+
+(comment
+  (s/exercise ::config-map))

src/github_changelog/conventional.clj

@@ -1,10 +1,51 @@
 (ns github-changelog.conventional
-  (:require [clojure.string :as str]
+  (:require [clojure.spec.alpha :as s]
+            [clojure.spec.gen.alpha :as gen]
+            [clojure.string :as str]
+            [github-changelog.config :as config]
+            [github-changelog.core-spec :as core-spec]
+            [github-changelog.github :as github]
+            [github-changelog.spec :as spec]
             [github-changelog.util :refer [strip-trailing]]))
 
 ; https://help.github.com/articles/closing-issues-via-commit-messages/
 (def close-keywords #{"close" "closes" "closed" "fix" "fixes" "fixed" "resolve" "resolves" "resolved" "related to" "relates to"})
 
+(def angular-pattern #"^(\w*)(?:\((.*)\))?\: (.*)$")
+
+(s/def ::type ::spec/non-blank-string)
+(s/def ::scope string?)
+(s/def ::subject ::spec/non-blank-string)
+
+(s/def ::issue (s/tuple ::spec/non-blank-string  ::spec/url))
+
+(s/def ::issues (s/* ::issue))
+
+(defn title-gen []
+  (gen/fmap (fn [[type scope subject]]
+              (if (str/blank? scope)
+                (format "%s: %s" type subject)
+                (format "%s(%s): %s" type scope subject)))
+            (s/gen (s/tuple ::type ::scope ::subject))))
+
+(s/def ::title
+  (s/with-gen
+    (s/and string? #(re-matches angular-pattern %))
+    title-gen))
+
+;; (s/def ::revert-pull pos-int?)
+
+;; (s/def ::revert-pr
+;;   (s/keys :req-un [::revert-pull ::pull-request]))
+
+(s/def ::pull-request ::github/pull)
+
+(s/def ::change (s/keys :req-un [::type ::scope ::subject ::pull-request ::issues]))
+(s/def ::changes (s/* ::change))
+
+(s/def ::tag-with-changes
+  (s/merge ::core-spec/tag-with-pulls (s/keys :req-un [::changes])))
+
 (defn fixes-pattern
   ([pattern] (fixes-pattern pattern close-keywords))
   ([pattern closing-words]
@@ -13,8 +54,6 @@
             (str/join \| closing-words)
             pattern))))
 
-(def angular-pattern #"^(\w*)(?:\((.*)\))?\: (.*)$")
-
 (defn collect-issues [pull pattern link-fn]
   (->> (:body pull)
        (str)
@@ -49,14 +88,14 @@
 
 (defn parse-pull [config {:keys [title] :as pull}]
   (if-let [pull-id (parse-revert config pull)]
-    {:revert-pull pull-id
+    {:revert-pull  pull-id
      :pull-request pull}
-    (if-let [[_ type scope subject] (re-find angular-pattern title)]
-      {:type type
-       :scope scope
-       :subject subject
+    (when-let [[_ type scope subject] (re-find angular-pattern title)]
+      {:type         type
+       :scope        scope
+       :subject      subject
        :pull-request pull
-       :issues (parse-issues config pull)})))
+       :issues       (parse-issues config pull)})))
 
 (defn reverted-ids [pulls]
   (->> (map :revert-pull pulls)
@@ -70,9 +109,19 @@
       pulls
       (conj pulls pull))))
 
-(defn parse-changes [config {:keys [pulls] :as tag}]
+(defn ^:no-gen parse-changes [config {:keys [pulls] :as tag}]
   (->> (map (partial parse-pull config) pulls)
        (remove nil?)
        (reduce filter-reverted [])
        (remove :revert-pull)
        (assoc tag :changes)))
+
+(s/fdef parse-changes
+  :args (s/cat :config ::config/config-map :tag ::core-spec/tag-with-pulls)
+  :ret (s/* ::tag-with-changes))
+
+(comment
+  (s/exercise-fn `parse-changes)
+  (s/exercise ::issue)
+  (s/exercise ::issues)
+  (s/exercise ::title))

src/github_changelog/core.clj

@@ -1,9 +1,11 @@
 (ns github-changelog.core
-  (:require [github-changelog
-             [conventional :as conventional]
-             [git :as git]
-             [github :as github]
-             [semver :as semver]]))
+  (:require [clojure.spec.alpha :as s]
+            [github-changelog.config :as config]
+            [github-changelog.conventional :as conventional]
+            [github-changelog.core-spec :as core-spec]
+            [github-changelog.git :as git]
+            [github-changelog.github :as github]
+            [github-changelog.semver :as semver]))
 
 (defn assoc-semver [prefix {:keys [name] :as tag}]
   (assoc tag :version (semver/extract name prefix)))
@@ -21,26 +23,51 @@
 (defn assoc-commits [git-repo {:keys [from sha] :as tag}]
   (assoc tag :commits (git/commits git-repo from sha)))
 
-(defn load-tags [config]
+(defn map-commits [tags git-repo]
+  (map (partial assoc-commits git-repo) tags))
+
+(defn ^:no-gen load-tags [config]
   (let [git-repo (git/init config)
-        tags     (git/tags git-repo)
         prefix   (get config :tag-prefix "v")]
-    (map (partial assoc-commits git-repo) (parse-tags tags prefix))))
+    (-> (git/tags git-repo)
+        (parse-tags prefix)
+        (map-commits git-repo))))
+
+(s/fdef load-tags
+  :args (s/cat :config ::config/config-map)
+  :ret (s/* ::core-spec/tag))
 
 (defn find-pull [pulls sha]
-  (first (filter #(= (:sha %) sha) pulls)))
+  (first (filter #(= (github/get-sha %) sha) pulls)))
+
+(defn ^:no-gen assoc-pulls [pulls {:keys [commits] :as tag}]
+  (->> commits
+       (keep (partial find-pull pulls))
+       (assoc tag :pulls)))
 
-(defn assoc-pulls [pulls {:keys [commits] :as tag}]
-  (let [related-pulls (remove nil? (map (partial find-pull pulls) commits))]
-    (assoc tag :pulls related-pulls)))
+(s/fdef assoc-pulls
+  :args (s/cat :pulls (s/* ::github/pull) :tag ::core-spec/tag)
+  :ret ::core-spec/tag-with-pulls)
 
-(defn changelog
+(defn ^:no-gen collect-tags [config]
+  (let [pulls (github/fetch-pulls config)]
+    (->> (load-tags config)
+         (map (partial assoc-pulls pulls)))))
+
+(s/fdef collect-tags
+  :args (s/cat :config ::config/config-map)
+  :ret (s/* ::core-spec/tag-with-pulls))
+
+(defn ^:no-gen changelog
   "Fetches the changelog"
   [config]
-  (->> (load-tags config)
-       (map (partial assoc-pulls (github/fetch-pulls config)))
+  (->> (collect-tags config)
        (map (partial conventional/parse-changes config))))
 
+(s/fdef changelog
+  :args (s/cat :config ::config/config-map)
+  :ret (s/* ::conventional/tag-with-changes))
+
 (defn filter-tags [tags {:keys [last since until]}]
   (cond->> tags
     since (filter #(semver/newer? (:version %) since))

src/github_changelog/core_spec.clj

@@ -0,0 +1,19 @@
+(ns github-changelog.core-spec
+  (:require [clojure.spec.alpha :as s]
+            [github-changelog.git :as git]
+            [github-changelog.github :as github]
+            [github-changelog.semver :as semver]))
+
+(s/def ::commits (s/* ::git/commit))
+
+(s/def ::tag
+  (s/merge ::git/tag (s/keys :req-un [::semver/version ::commits])))
+
+(s/def ::pulls (s/* ::github/pull))
+
+(s/def ::tag-with-pulls
+  (s/merge ::tag (s/keys :req-un [::pulls])))
+
+(comment
+  (s/exercise ::tag)
+  (s/exercise ::tag-with-pulls))

src/github_changelog/formatters/markdown.clj

@@ -1,9 +1,8 @@
 (ns github-changelog.formatters.markdown
-  (:require [clojure.string :refer [join]]
-            [github-changelog
-             [markdown :as md]
-             [semver :refer [get-type]]
-             [util :refer [str-map]]]))
+  (:require [clojure.string :as str]
+            [github-changelog.markdown :as md]
+            [github-changelog.semver :as semver]
+            [github-changelog.util :as util]))
 
 (defmulti translate-type identity)
 
@@ -34,10 +33,10 @@
    subject
    (format-pull-request pull-request)
    (if-let [issues (seq issues)]
-     (str ", closes " (join ", " (map (partial apply md/link) issues))))))
+     (str ", closes " (str/join ", " (map (partial apply md/link) issues))))))
 
 (defn- format-entries [changes]
-  (join (map md/li changes)))
+  (str/join (map md/li changes)))
 
 (defmulti format-grouped-changes (comp count second))
 
@@ -62,7 +61,7 @@
             (flatten)
             (format-entries))))
 
-(defmulti highlight-fn get-type)
+(defmulti highlight-fn semver/get-type)
 
 (defmethod highlight-fn :major [_] (comp md/h2 md/emphasis))
 (defmethod highlight-fn :minor [_] md/h2)
@@ -74,7 +73,7 @@
   ((highlight-fn version) name))
 
 (defn format-changes [changes]
-  (str-map format-change-group (group-by :type changes)))
+  (util/str-map format-change-group (group-by :type changes)))
 
 (defn format-tag [{:keys [version name changes]}]
   (str (format-version version name)
@@ -85,4 +84,4 @@
   [tags {:keys [collapse-tags]}]
   (if collapse-tags
     (format-changes (mapcat :changes tags))
-    (str-map format-tag tags)))
+    (util/str-map format-tag tags)))