Split Caqti_prereq into Caqti_common and Caqti_common_priv.

paurkedal · Oct 1, 2019 · 88f8d4f · 88f8d4f
1 parent b6e2f42
commit 88f8d4f
Show file tree

Hide file tree

Showing 16 changed files with 60 additions and 27 deletions.
diff --git a/lib-async/caqti_async.ml b/lib-async/caqti_async.ml
@@ -18,7 +18,7 @@
 
 open Async_kernel
 open Async_unix
-open Caqti_prereq
+open Caqti_common_priv
 open Core_kernel
 
 module System = struct

diff --git a/lib-blocking/caqti_blocking.ml b/lib-blocking/caqti_blocking.ml
@@ -1,4 +1,4 @@
-(* Copyright (C) 2018  Petter A. Urkedal <[email protected]>
+(* Copyright (C) 2018--2019  Petter A. Urkedal <[email protected]>
  *
  * This library is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as published by
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 
 module System = struct
 

diff --git a/lib-driver/caqti_driver_mariadb.ml b/lib-driver/caqti_driver_mariadb.ml
@@ -15,7 +15,7 @@
  *)
 
 open Caqti_driver_lib
-open Caqti_prereq
+open Caqti_common_priv
 open Printf
 
 type Caqti_error.msg += Mdb_msg of (int * string)

diff --git a/lib-driver/caqti_driver_postgresql.ml b/lib-driver/caqti_driver_postgresql.ml
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 open Printf
 module Pg = Postgresql
 

diff --git a/lib-driver/caqti_driver_sqlite3.ml b/lib-driver/caqti_driver_sqlite3.ml
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 open Caqti_driver_lib
 open Printf
 

diff --git a/lib-lwt/caqti_lwt.ml b/lib-lwt/caqti_lwt.ml
@@ -1,4 +1,4 @@
-(* Copyright (C) 2014--2018  Petter A. Urkedal <[email protected]>
+(* Copyright (C) 2014--2019  Petter A. Urkedal <[email protected]>
  *
  * This library is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as published by
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 
 module System = struct
 

diff --git a/lib/caqti_common.ml b/lib/caqti_common.ml
@@ -0,0 +1,19 @@
+(* Copyright (C) 2014--2019  Petter A. Urkedal <[email protected]>
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version, with the OCaml static compilation exception.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *)
+
+type counit = {absurd: 'a. 'a}
+
+let absurd {absurd} = absurd
diff --git a/lib/caqti_common.mli b/lib/caqti_common.mli
@@ -0,0 +1,21 @@
+(* Copyright (C) 2014--2019  Petter A. Urkedal <[email protected]>
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version, with the OCaml static compilation exception.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *)
+
+(** Prerequisites. *)
+
+type counit
+
+val absurd : counit -> 'a
diff --git a/lib/caqti_prereq.ml → lib/caqti_common_priv.ml b/lib/caqti_prereq.ml → lib/caqti_common_priv.ml
@@ -1,4 +1,4 @@
-(* Copyright (C) 2014--2019  Petter A. Urkedal <[email protected]>
+(* Copyright (C) 2019  Petter A. Urkedal <[email protected]>
  *
  * This library is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as published by
@@ -16,10 +16,6 @@
 
 open Printf
 
-type counit = {absurd: 'a. 'a}
-
-let absurd {absurd} = absurd
-
 let ident x = x
 
 let (%) g f x = g (f x)

diff --git a/lib/caqti_prereq.mli → lib/caqti_common_priv.mli b/lib/caqti_prereq.mli → lib/caqti_common_priv.mli
@@ -1,4 +1,4 @@
-(* Copyright (C) 2014--2019  Petter A. Urkedal <[email protected]>
+(* Copyright (C) 2019  Petter A. Urkedal <[email protected]>
  *
  * This library is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as published by
@@ -14,14 +14,10 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-(** Prerequisites. *)
+(** {b Internal:} Prerequisites.
 
-type counit
-
-val absurd : counit -> 'a
-
-(**/**)
-(* The rest are for internal use only. *)
+    This module is ment for internal use by Caqti and may change in backwards
+    incompatible ways between minor versions without prior notice. *)
 
 val (%) : ('b -> 'c) -> ('a -> 'b) -> 'a -> 'c
 val (%>) : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c

diff --git a/lib/caqti_connection.ml b/lib/caqti_connection.ml
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 open Printf
 
 module Make_helpers

diff --git a/lib/caqti_driver_lib.ml b/lib/caqti_driver_lib.ml
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 
 let linear_param_length templ =
   let rec loop = function

diff --git a/lib/caqti_error.ml b/lib/caqti_error.ml
@@ -203,7 +203,7 @@ let show err =
 
 let uncongested = function
  | Error #t | Ok _ as x -> x
- | Error `Congested x -> Caqti_prereq.absurd x
+ | Error `Congested x -> Caqti_common.absurd x
 
 exception Exn of t
 

diff --git a/lib/caqti_error.mli b/lib/caqti_error.mli
@@ -193,7 +193,7 @@ val show : [< t] -> string
 (** [show error] is an explanation of [error]. *)
 
 val uncongested :
-  ('a, [< t | `Congested of Caqti_prereq.counit]) result ->
+  ('a, [< t | `Congested of Caqti_common.counit]) result ->
   ('a, [> t]) result
 (** [uncongested r] eliminates an unused [`Congested] case from the error. *)
 

diff --git a/lib/dune b/lib/dune
@@ -16,6 +16,7 @@
     Caqti_mult
     Caqti_pool
     Caqti_pool_sig
+    Caqti_common
     Caqti_query
     Caqti_request
     Caqti_response_sig
@@ -26,7 +27,7 @@
     Caqti_type_sig
     ; internal
     Caqti_heap
-    Caqti_prereq)
+    Caqti_common_priv)
   (modules_without_implementation
     Caqti_connect_sig
     Caqti_connection_sig

diff --git a/tests/test_sql.ml b/tests/test_sql.ml
@@ -14,7 +14,7 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *)
 
-open Caqti_prereq
+open Caqti_common_priv
 open Printf
 
 module Q = struct