Replace implicit migrations file with option

The #duct/include reader tag can still be used to factor the migrations
out into their own file; it just needs to be explicit.

Author: weavejester

README.md

@@ -28,16 +28,16 @@ Or to your Leiningen project file:
 Add the `:duct.module/sql` key to your Duct configuration:
 
 ```edn
-{:duct.module/sql {}}
+{:duct.module/sql {:migrations #duct/include "migrations.edn"}}
 ```
 This module uses the Integrant [expand][] function to add the
 following keys to the configuration:
 
 * `:duct.database.sql/hikaricp` - a SQL datasource
 * `:duct.migrator/ragtime` - applies database migrations
 
-This will setup a pooled database connection and a migrator that looks
-for a file `migrations.edn` in the current directory. See the
+This will setup a pooled database connection and a migrator with
+migrations loaded from the `migrations.edn` include file. See the
 documentation on [Ragtime's SQL migrations][migrations] for information
 about the syntax.
 

project.clj

@@ -5,7 +5,7 @@
             :url "http://www.eclipse.org/legal/epl-v10.html"}
   :dependencies [[org.clojure/clojure "1.12.2"]
                  [org.duct-framework/database.sql.hikaricp "0.7.1"]
-                 [org.duct-framework/migrator.ragtime "0.5.3"]
+                 [org.duct-framework/migrator.ragtime "0.6.0"]
                  [org.duct-framework/repl.refers "0.1.0"]
                  [integrant "1.0.0"]
                  [com.github.seancorfield/next.jdbc "1.3.1070"]]

src/duct/module/sql.clj

@@ -1,15 +1,15 @@
 (ns duct.module.sql
   (:require [integrant.core :as ig]))
 
-(defmethod ig/expand-key :duct.module/sql [_ _]
+(defmethod ig/expand-key :duct.module/sql [_ {:keys [migrations]}]
   (let [components {:duct.database.sql/hikaricp
                     {:logger  (ig/refset :duct/logger)
                      :jdbcUrl (ig/var 'jdbc-url)}
                     :duct.migrator/ragtime
-                    {:logger   (ig/refset :duct/logger)
-                     :database (ig/ref :duct.database/sql)
-                     :strategy :rebase
-                     :migrations-file "migrations.edn"}}]
+                    {:logger    (ig/refset :duct/logger)
+                     :database  (ig/ref :duct.database/sql)
+                     :strategy  :rebase
+                     :migrations migrations}}]
     (ig/profile
      :main (assoc-in components [:duct.migrator/ragtime :strategy]
                      :raise-error)

src/integrant/annotations.edn

@@ -6,7 +6,10 @@
     :doc "The JDBC database URL"}}
   :doc
   "A module that adds components for accessing SQL databases to the
-  configuration. Takes no options.
+  configuration.
+
+  Takes the following option:
+  - `:migrations` - a data structure of [Ragtime SQL Migrations][1]
 
   In the `:repl` profile, migrations are run using the `:rebase` strategy
   (conflicts replace existing migrations), while in the `:main` profile the
@@ -16,4 +19,6 @@
   - `db` - get a `DataSource` of the running system's database
   - `sql` - run a SQL statement on the system's database
 
-  A Duct `jdbc-url` variable is added to configure the JDBC database URL."}}
+  A Duct `jdbc-url` variable is added to configure the JDBC database URL.
+
+  [1]: https://github.com/weavejester/ragtime/wiki/SQL-Migrations#edn"}}

test/duct/module/sql_test.clj

@@ -14,8 +14,9 @@
             {:database   (ig/ref :duct.database/sql)
              :logger     (ig/refset :duct/logger)
              :strategy   :raise-error
-             :migrations-file "migrations.edn"}}
-           (-> {:duct.module/sql {}}
+             :migrations '[[:create-table foo (id "INTEGER")]]}}
+           (-> {:duct.module/sql
+                {:migrations '[[:create-table foo (id "INTEGER")]]}}
                (ig/expand (ig/deprofile [:main]))
                (ig/bind {'jdbc-url "jdbc:sqlite:"})))))
 
@@ -27,11 +28,12 @@
             {:database   (ig/ref :duct.database/sql)
              :logger     (ig/refset :duct/logger)
              :strategy   :rebase
-             :migrations-file "migrations.edn"}
+             :migrations '[[:create-table foo (id "INTEGER")]]}
             :duct.repl/refers
             '{db  duct.repl.sql/db
               sql duct.repl.sql/sql}}
-           (-> {:duct.module/sql {}}
+           (-> {:duct.module/sql
+                {:migrations '[[:create-table foo (id "INTEGER")]]}}
                (ig/expand (ig/deprofile [:repl]))
                (ig/bind {'jdbc-url "jdbc:sqlite:"})))))
 
@@ -43,7 +45,8 @@
             {:database   (ig/ref :duct.database/sql)
              :logger     (ig/refset :duct/logger)
              :strategy   :rebase
-             :migrations-file "migrations.edn"}}
-           (-> {:duct.module/sql {}}
+             :migrations '[[:create-table foo (id "INTEGER")]]}}
+           (-> {:duct.module/sql
+                {:migrations '[[:create-table foo (id "INTEGER")]]}}
                (ig/expand (ig/deprofile [:test]))
                (ig/bind {'jdbc-url "jdbc:sqlite:"}))))))