Implement type-fns support for PK (#87)

Author: pawit-metabase

src/toucan/db.clj

@@ -456,10 +456,11 @@
   *plus* other clauses).
 
      (where+ {} [:id 1 {:limit 10}]) -> {:where [:= :id 1], :limit 10}"
-  [honeysql-form args]
+  [model honeysql-form args]
   (loop [honeysql-form honeysql-form, [first-arg & [second-arg & more, :as butfirst]] args]
     (cond
-      (keyword? first-arg) (recur (where honeysql-form first-arg second-arg) more)
+      (keyword? first-arg) (recur (where honeysql-form first-arg
+                                         (models/do-type-fn model first-arg second-arg :in)) more)
       first-arg            (recur (merge honeysql-form first-arg)            butfirst)
       :else                honeysql-form)))
 
@@ -486,10 +487,10 @@
    {:pre [(some? id) (map? kvs) (every? keyword? (keys kvs))]}
    (let [model       (resolve-model model)
          primary-key (models/primary-key model)
-         kvs         (-> (models/do-pre-update model (assoc kvs primary-key id))
-                         (dissoc primary-key))
+         kvs-with-pk (models/do-pre-update model (assoc kvs primary-key id))
+         kvs         (dissoc kvs-with-pk primary-key)
          updated?    (update! model (-> (h/sset {} kvs)
-                                        (where primary-key id)))]
+                                        (where primary-key (primary-key kvs-with-pk))))]
         (when (and updated?
                    (method-implemented? :post-update model))
           (models/post-update (model id)))
@@ -608,7 +609,7 @@
    {:pre [(map? row-map) (every? keyword? (keys row-map))]}
    (let [model (resolve-model model)]
      (when-let [id (simple-insert! model (models/do-pre-insert model row-map))]
-       (models/post-insert (model id)))))
+       (models/post-insert (model (models/do-type-fn model (models/primary-key model) id :out))))))
   ([model k v & more]
    (insert! model (apply array-map k v more))))
 
@@ -624,7 +625,7 @@
   {:style/indent 1}
   [model & options]
   (let [fields (model->fields model)]
-    (simple-select-one model (where+ {:select (or fields [:*])} options))))
+    (simple-select-one model (where+ (resolve-model model) {:select (or fields [:*])} options))))
 
 (defn select-one-field
   "Select a single `field` of a single object from the database.
@@ -659,7 +660,8 @@
      (select 'Database :name [:not= nil] {:limit 2}) -> [...]"
   {:style/indent 1}
   [model & options]
-  (simple-select model (where+ {:select (or (model->fields model)
+  (simple-select model (where+ (resolve-model model)
+                               {:select (or (model->fields model)
                                             [:*])}
                                options)))
 
@@ -670,7 +672,8 @@
         -> [\"name1\", \"name2\"]"
   {:style/indent 1}
   [model & options]
-  (simple-select-reducible model (where+ {:select (or (model->fields model)
+  (simple-select-reducible model (where+ (resolve-model model)
+                                         {:select (or (model->fields model)
                                                       [:*])}
                                          options)))
 
@@ -768,4 +771,5 @@
         primary-key (models/primary-key model)]
     (doseq [object (apply select model conditions)]
       (models/pre-delete object)
-      (simple-delete! model primary-key (primary-key object)))))
+      (simple-delete! model primary-key
+                      (models/do-type-fn model primary-key (primary-key object) :in)))))

src/toucan/models.clj

@@ -351,6 +351,13 @@
     (map-> model <>)
     (apply-property-fns :select <>)))
 
+(defn do-type-fn
+  "Don't call this directly! This is automatically applied when doing select."
+  [model col v direction]
+  (if-let [type (col (types model))]
+    ((get-in @type-fns [type direction]) v)
+    v))
+
 (def IModelDefaults
   "Default implementations for `IModel` methods."
   {:default-fields (constantly nil)

test/toucan/db_test.clj

@@ -10,6 +10,7 @@
             [toucan.test-models
              [address :refer [Address]]
              [category :refer [Category]]
+             [food :refer [Food]]
              [phone-number :refer [PhoneNumber]]
              [user :refer [User]]
              [venue :refer [Venue]]])
@@ -286,6 +287,13 @@
       (db/update! PhoneNumber id :country_code "AU")
       (db/select-one PhoneNumber :number id))))
 
+(expect
+ #toucan.test_models.food.FoodInstance{:id "F4", :price 42.42M}
+ (test/with-clean-db
+  (db/insert! Food {:id "F4" :price 9.01M})
+  (db/update! Food "F4" :price 42.42M)
+  (db/select-one Food :id "F4")))
+
 ;; Test update-where!
 (expect
  [#toucan.test_models.user.UserInstance{:id 1, :first-name "Cam", :last-name "Saul"}
@@ -502,3 +510,11 @@
   (db/exists? User, :first-name "Kanye", :last-name "Nest"))
 
 ;; TODO - Test delete!
+
+;; Test delete! with transformed PK
+(expect
+ 0
+ (test/with-clean-db
+  (db/insert! Food {:id "F4" :price 9.01M})
+  (db/delete! Food :id "F4")
+  (db/count Food :id "F4")))

test/toucan/test_models/food.clj

@@ -0,0 +1,22 @@
+(ns toucan.test-models.food
+  "A model with BYTEA as primary key."
+  (:require [toucan.models :as models])
+  (:import (java.nio.charset StandardCharsets)))
+
+(defn- str->bytes [s]
+  (when s
+    (.getBytes s StandardCharsets/UTF_8)))
+
+(defn- bytes->str [b]
+  (when b
+    (String. b StandardCharsets/UTF_8)))
+
+;; Store string as byte array in the database
+(models/add-type! :string-as-bytes
+                  :in  str->bytes
+                  :out bytes->str)
+
+(models/defmodel Food :foods
+  models/IModel
+  (types [_]
+    {:id :string-as-bytes}))

test/toucan/test_setup.clj

@@ -70,7 +70,13 @@
       number TEXT PRIMARY KEY,
       country_code VARCHAR(3) NOT NULL
     );"
-    "TRUNCATE TABLE phone_numbers;"))
+    "TRUNCATE TABLE phone_numbers;"
+    ;; Food
+    "CREATE TABLE IF NOT EXISTS foods (
+      id BYTEA PRIMARY KEY,
+      price DECIMAL(10,2) NOT NULL
+    );"
+    "TRUNCATE TABLE foods;"))
 
 
 (def ^java.sql.Timestamp jan-first-2017 (Timestamp/valueOf "2017-01-01 00:00:00"))