options for dependencies

<!-- ps-id: bc69715d-8c9e-4bfe-9aec-bb348c037204 -->

Author: bilus

libs/kit-generator/src/kit/api.clj

@@ -1,53 +1,102 @@
 (ns kit.api
   (:require
-   [clojure.string :as string]
-   [kit.generator.modules.generator :as generator]
-   [kit.generator.modules.dependencies :as deps]
+   [clojure.string :as str]
+   [kit.generator.io :as io]
    [kit.generator.modules :as modules]
+   [kit.generator.modules.dependencies :as deps]
+   [kit.generator.modules.generator :as generator]
    [kit.generator.snippets :as snippets]
-   [kit.generator.io :as io]))
+   [clojure.test :as t]))
 
 ;; TODO: Add docstrings
 
-(defn read-ctx
-  ([] (read-ctx nil))
-  ([path]
-   (-> (or path "kit.edn")
-       (slurp)
-       (io/str->edn))))
+(defn- read-ctx
+  [path]
+  (assert (not (str/blank? path)))
+  (-> path
+      (slurp)
+      (io/str->edn)))
+
+(defn- log-install-dependency [module-key feature-flag deps]
+  (print "Installing module" module-key)
+
+  (when-let [extras (not-empty (cond-> []
+                                 (not= :default feature-flag) (conj (str " - feature flag:" feature-flag))
+                                 (seq deps) (conj (str " - requires:" (str/join ",")))))]
+    (print (str "(" (str/join "; " extras) ")"))))
+
+(defn- log-missing-module [module-key]
+  (println "ERROR: no module found with name:" module-key))
+
+(defn- install-dependency
+  "Installs a module and its dependencies recursively. Asumes ctx has loaded :modules.
+   Note that `opts` have a different schema than the one passed to `install-module`,
+   the latter being preserved for backwards compatibility. Here `opts` is a map of
+   module-key to module-specific options. For example:
 
-(defn sync-modules []
-  (modules/sync-modules! (read-ctx))
+    {:html {:feature-flag :default}
+     :auth {:feature-flag :oauth}}"
+  [{:keys [modules] :as ctx} module-key opts]
+  (if (modules/module-exists? ctx module-key)
+    (let [{:keys [module-config]} (generator/read-module-config ctx modules module-key)
+          {:keys [feature-flag] :or {feature-flag :default} :as module-opts} (get opts module-key {})
+          deps (deps/resolve-dependencies module-config feature-flag)]
+      (log-install-dependency module-key feature-flag deps)
+      (doseq [module-key deps]
+        (install-dependency ctx module-key opts))
+      (generator/generate ctx module-key module-opts))
+    (log-missing-module module-key))
   :done)
 
-(defn list-modules []
-  (let [ctx (modules/load-modules (read-ctx))]
-    (modules/list-modules ctx))
+(defn- flat-module-options
+  "Converts options map passed to install-module into a flat map
+   of module-key to module-specific options."
+  {:test (fn []
+           (t/are [opts module-key output] (flat-module-options opts module-key)
+             {} :meta {}
+             {:feature-flag :extras} :meta {:meta {:feature-flag :extras}}
+             {:feature-flag :extras
+              :kit/cljs    {:feature-flag :advanced}} :meta
+             {:meta    {:feature-flag :extras}
+              :kit/cljs {:feature-flag :advanced}}))}
+  [opts module-key]
+  (let [supported-module-options [:feature-flag]]
+    (as-> opts $
+      {module-key (select-keys $ supported-module-options)}
+      (merge opts $)
+      (apply dissoc $ supported-module-options))))
+
+(defn sync-modules
+  "Downloads modules for the current project."
+  []
+  (modules/sync-modules! (read-ctx "kit-edn"))
   :done)
 
-(declare install-module)
-(defn install-dependency [module-key]
-  (if (vector? module-key)
-    (apply install-module module-key)
-    (install-module module-key)))
+(defn list-modules
+  "List modules available for the current project."
+  []
+  (let [ctx (modules/load-modules (read-ctx "kit.edn"))]
+    (modules/list-modules ctx))
+  :done)
 
 (defn install-module
+  "Installs a kit module into the current project or the project specified by a
+  path to kit.edn file.
+
+  NOTE: When adding new options, update flat-module-options."
   ([module-key]
    (install-module module-key {:feature-flag :default}))
-  ([module-key {:keys [feature-flag kit-edn-path] :or {kit-edn-path "kit.edn"} :as opts}]
-   (let [{:keys [modules] :as ctx} (modules/load-modules (read-ctx kit-edn-path))]
-     (if (modules/module-exists? ctx module-key)
-       (let [{:keys [module-config]} (generator/read-module-config ctx modules module-key)
-             deps (deps/resolve-dependencies module-config  feature-flag)]
-         (println module-key "requires following modules:" deps)
-         (doseq [module-key deps]
-           (install-dependency module-key))
-         (generator/generate ctx module-key opts))
-       (println "no module found with name:" module-key))
-     :done)))
-
-(defn list-installed-modules []
-  (doseq [[id status] (-> (read-ctx)
+  ([module-key opts]
+   (install-module module-key "kit.edn" opts))
+  ([module-key kit-edn-path opts]
+   (let [ctx (modules/load-modules (read-ctx kit-edn-path))]
+     (install-dependency ctx module-key (flat-module-options opts module-key)))))
+
+(defn list-installed-modules
+  "Lists installed modules and modules that failed to install, for the current
+   project."
+  []
+  (doseq [[id status] (-> (read-ctx "kit.edn")
                           :modules
                           :root
                           (generator/read-modules-log))]
@@ -64,22 +113,25 @@
         @db))))
 
 (defn sync-snippets []
-  (let [ctx (read-ctx)]
+  (let [ctx (read-ctx "kit.edn")]
     (snippets/sync-snippets! ctx)
     (snippets-db ctx true)
     :done))
 
 (defn find-snippets [query]
-  (snippets/print-snippets (snippets-db (read-ctx)) query)
+  (snippets/print-snippets (snippets-db (read-ctx "kit.edn")) query)
   :done)
 
 (defn find-snippet-ids [query]
-  (println (string/join ", " (map :id (snippets/match-snippets (snippets-db (read-ctx)) query))))
+  (println (str/join ", " (map :id (snippets/match-snippets (snippets-db (read-ctx "kit.edn")) query))))
   :done)
 
 (defn list-snippets []
-  (println (string/join "\n" (keys (snippets-db (read-ctx)))))
+  (println (str/join "\n" (keys (snippets-db (read-ctx "kit.edn")))))
   :done)
 
 (defn snippet [id & args]
-  (snippets/gen-snippet (snippets-db (read-ctx)) id args))
+  (snippets/gen-snippet (snippets-db (read-ctx "kit.edn")) id args))
+
+(comment
+  (t/run-tests 'kit.api))

libs/kit-generator/src/kit/generator/modules.clj

@@ -1,9 +1,10 @@
 (ns kit.generator.modules
   (:require
-    [clojure.java.io :as jio]
-    [kit.generator.git :as git]
-    [kit.generator.io :as io])
-  (:import java.io.File))
+   [clojure.java.io :as jio]
+   [deep.merge :as deep-merge]
+   [kit.generator.git :as git])
+  (:import
+   java.io.File))
 
 (defn sync-modules!
   "Clones or pulls modules from git repositories.
@@ -18,18 +19,18 @@
   [{:keys [modules]}]
   (doseq [{:keys [name url] :as repository} (-> modules :repositories)]
     (git/sync-repository!
-      (:root modules)
-      repository)))
+     (:root modules)
+     repository)))
 
 (defn set-module-path [module-config base-path]
   (update module-config :path #(str base-path File/separator %)))
 
 (defn set-module-paths [root {:keys [module-root modules]}]
   (reduce
-    (fn [modules [id config]]
-      (assoc modules id (set-module-path config (str root File/separator module-root))))
-    {}
-    modules))
+   (fn [modules [id config]]
+     (assoc modules id (set-module-path config (str root File/separator module-root))))
+   {}
+   modules))
 
 (defn load-modules [{:keys [modules] :as ctx}]
   (let [root (:root modules)]

libs/kit-generator/src/kit/generator/modules/generator.clj

@@ -40,7 +40,7 @@
 (defn write-asset [asset path force?]
   (jio/make-parents path)
   (if (and (.exists (jio/file path)) (not force?))
-    (println "asset already exists:" path)
+    (println "WARNING: Asset already exists:" path)
     ((if (string? asset) write-string write-binary) asset path)))
 
 (defmulti handle-action (fn [_ [id]] id))
@@ -63,13 +63,13 @@
          (renderer/render-template ctx target-path)
          force?))
       :else
-      (println "unrecognized asset type:" asset))))
+      (println "ERROR: Unrecognized asset type:" asset))))
 
 (defmethod handle-action :injections [ctx [_ injections]]
   (ij/inject-data ctx injections))
 
 (defmethod handle-action :default [_ [id]]
-  (println "undefined action:" id))
+  (println "ERROR: Undefined action:" id))
 
 (defn- render-module-config [ctx module-path]
   (some->> (str module-path File/separator "config.edn")
@@ -106,7 +106,6 @@
   [edn-config {:keys [feature-requires] :as config}]
   (if (some? feature-requires)
     (do
-      (println "applying features to config:" feature-requires)
       (apply deep-merge/concat-merge
              (conj (mapv #(get-throw-on-not-found edn-config %) feature-requires)
                    config)))
@@ -117,7 +116,7 @@
   (let [modules-root (:root modules)
         module-log   (read-modules-log modules-root)]
     (if (= :success (module-log module-key))
-      (println "module" module-key "is already installed!")
+      (println "WARNING: Module" module-key "is already installed!")
       (try
         (let [{:keys [module-path module-config config-str]} (read-module-config ctx modules module-key)
               ctx                                            (assoc ctx :module-path module-path)
@@ -126,12 +125,12 @@
           (cond
             (nil? module-config)
             (do
-              (println "module" module-key "not found, available modules:")
+              (println "ERROR: Module" module-key "not found, available modules:")
               (pprint (modules/list-modules ctx)))
 
             (nil? config)
             (do
-              (println "feature" feature-flag "not found for module" module-key ", available features:")
+              (println "ERROR: Feature" feature-flag "not found for module" module-key ", available features:")
               (pprint (keys module-config)))
 
             :else
@@ -141,11 +140,11 @@
                 (handle-action ctx action))
               (write-modules-log modules-root (assoc module-log module-key :success))
               (println (or success-message
-                           (str module-key " installed successfully!")))
+                           (str "Module " module-key " installed successfully!")))
               (when require-restart?
                 (println "restart required!")))))
         (catch Exception e
-          (println "failed to install module" module-key)
+          (println "ERROR: Failed to install module" module-key)
           (write-modules-log modules-root (assoc module-log module-key :error))
           (.printStackTrace e))))))
 

libs/kit-generator/test/kit_generator/core_test.clj

@@ -1,7 +1,7 @@
 (ns kit-generator.core-test
   (:require
    [clojure.string :as str]
-   [clojure.test :refer [deftest is testing]]
+   [clojure.test :refer [deftest is testing are]]
    [kit-generator.generator-test]
    [kit-generator.injections]
    [kit-generator.io :as io]
@@ -39,26 +39,44 @@
     (io/write-edn ctx kit-edn-path)
     kit-edn-path))
 
-(deftest test-install-module
-  (testing "installing a module"
-    (let [kit-edn-path (prepare-project)]
-      (is (not (module-installed? :meta)))
-      (is (= :done (kit/install-module :meta {:kit-edn-path kit-edn-path})))
-      (is (module-installed? :meta))
-      (is (empty? (io/folder-mismatches project-root
-                                        {"resources/public/css/styles.css" []
-                                         "resources/public/css/app.css"    []
-                                         "kit.edn"                         []}
-                                        {:filter #(not (str/starts-with? % "modules/"))}))))))
+(defn test-install-module*
+  [module-key opts expected-files]
+  (let [kit-edn-path (prepare-project)]
+    (is (not (module-installed? module-key)))
+    (is (= :done (kit/install-module module-key kit-edn-path opts)))
+    (is (module-installed? module-key))
+    (is (empty? (io/folder-mismatches project-root
+                                      expected-files
+                                      {:filter #(not (str/starts-with? % "modules/"))})))))
 
-(deftest test-install-module-with-feature-flag
-  (testing "installing a module with a feature flag"
-    (let [kit-edn-path (prepare-project)]
-      (is (not (module-installed? :meta)))
-      (is (= :done (kit/install-module :meta {:feature-flag :extras
-                                              :kit-edn-path kit-edn-path})))
-      (is (module-installed? :meta))
-      (is (empty? (io/folder-mismatches project-root
-                                        {"resources/public/css/styles.css" []
-                                         "kit.edn"                         []}
-                                        {:filter #(not (str/starts-with? % "modules/"))}))))))
+(deftest test-install-meta-module
+  (are [module-key opts expected-files] (test-install-module* module-key opts expected-files)
+    :meta {}                                {"resources/public/css/app.css"        []
+                                             "kit.edn"                             []}
+    :meta {:feature-flag :extras}           {"resources/public/css/styles.css"     []
+                                             "src/clj/myapp/db.clj"                []
+                                             "kit.edn"                             []}
+    :meta {:feature-flag :full}             {"resources/public/css/app.css"        []
+                                             "resources/public/css/styles.css"     []
+                                             "src/clj/myapp/db.clj"                []
+                                             "kit.edn"                             []}
+    :meta {:feature-flag :extras
+           :db {:feature-flag :postgres}}   {"resources/public/css/styles.css"     []
+                                             "src/clj/myapp/db.clj"                []
+                                             "src/clj/myapp/db/postgres.clj"       []
+                                             "kit.edn"                             []}
+    :meta {:feature-flag :extras
+           :db {:feature-flag :migrations}} {"resources/public/css/styles.css"     []
+                                             "src/clj/myapp/db.clj"                []
+                                             "src/clj/myapp/db/postgres.clj"       []
+                                             "src/clj/myapp/db/migratus.clj"       []
+                                             "src/clj/myapp/db/migrations/001.clj" []
+                                             "kit.edn"                             []}
+
+;;
+    ))
+
+;; TODO: Should feature-requires be transient? If so, add tests for that.
+
+(comment
+  (clojure.test/run-tests 'kit-generator.core-test))

libs/kit-generator/test/resources/modules/kit/cljs/config.edn

@@ -15,11 +15,11 @@
                  :action :append
                  :target [:body]
                  :value  [:script {:src "/js/app.js"}]}
-                 {:type :edn
-                  :path "deps.edn"
-                  :target [:paths]
-                  :action :append
-                  :value "target/classes/cljsbuild"}
+                {:type :edn
+                 :path "deps.edn"
+                 :target [:paths]
+                 :action :append
+                 :value "target/classes/cljsbuild"}
                 {:type   :clj
                  :path   "build.clj"
                  :action :append-requires

libs/kit-generator/test/resources/modules/kit/db/assets/db.clj

@@ -0,0 +1 @@
+(ns resources.modules.kit.db.assets.db)

libs/kit-generator/test/resources/modules/kit/db/assets/migrations/001.clj

@@ -0,0 +1,3 @@
+(ns resources.modules.kit.db.assets.migrations.001)
+
+;; First migration

libs/kit-generator/test/resources/modules/kit/db/assets/postgres.clj

@@ -0,0 +1 @@
+(ns resources.modules.kit.db.assets.postgres)

libs/kit-generator/test/resources/modules/kit/db/config.edn

@@ -0,0 +1,9 @@
+{:default    {:actions
+              {:assets [["assets/db.clj" "test/resources/generated/src/clj/<<sanitized>>/db.clj"]]}}
+ :postgres   {:actions
+              {:assets [["assets/postgres.clj" "test/resources/generated/src/clj/<<sanitized>>/db/postgres.clj"]]}
+              :feature-requires [:default]}
+ :migrations {:actions
+              {:assets [["assets/migrations/001.clj" "test/resources/generated/src/clj/<<sanitized>>/db/migrations/001.clj"]]}
+              :requires [:migratus]
+              :feature-requires [:postgres :default]}}