Skip to content

Commit 02ebab6

Browse files
refactor: Rename pinning functions to make their meaning clearer (#13178)
Pulled out of #13176. --------- Signed-off-by: Marek Kubica <[email protected]>
1 parent 34320ef commit 02ebab6

File tree

3 files changed

+26
-14
lines changed

3 files changed

+26
-14
lines changed

src/dune_pkg/local_package.ml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
open Import
22
module Package_constraint = Dune_lang.Package_constraint
33

4+
module Origin = struct
5+
type t =
6+
| Opam_file
7+
| Pin_stanza
8+
end
9+
410
type pin =
511
{ loc : Loc.t
612
; version : Package_version.t
713
; url : Loc.t * OpamUrl.t
814
; name : Package_name.t
9-
; origin : [ `Dune | `Opam ]
15+
; origin : Origin.t
1016
}
1117

1218
type pins = pin Package_name.Map.t
@@ -190,7 +196,7 @@ let of_package (t : Dune_lang.Package.t) =
190196
Package_version.of_opam_package_version (OpamPackage.version pkg)
191197
in
192198
let loc = Loc.in_file (Path.source file) in
193-
name, { loc; version; url = loc, url; name; origin = `Opam })
199+
name, { loc; version; url = loc, url; name; origin = Opam_file })
194200
|> Package_name.Map.of_list
195201
with
196202
| Ok x -> x

src/dune_pkg/local_package.mli

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
open Import
22

3+
module Origin : sig
4+
type t =
5+
| Opam_file
6+
| Pin_stanza
7+
end
8+
39
type pin =
410
{ loc : Loc.t
511
; version : Package_version.t
612
; url : Loc.t * OpamUrl.t
713
; name : Package_name.t
8-
; origin : [ `Dune | `Opam ]
14+
; origin : Origin.t
915
}
1016

1117
type pins = pin Package_name.Map.t

src/dune_pkg/pin.ml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ module DB = struct
3535
map =
3636
Package_name.Map.fold pins ~init:t.map ~f:(fun (pin : Local_package.pin) acc ->
3737
(match pin.origin with
38-
| `Dune -> Code_error.raise "add_opam_pins: can only pin opam packages" []
39-
| `Opam -> ());
38+
| Pin_stanza -> Code_error.raise "add_opam_pins: can only pin opam packages" []
39+
| Opam_file -> ());
4040
Package_name.Map.update acc pin.name ~f:(function
4141
| None -> Some (pin, t.context)
4242
| Some _ as x -> x))
@@ -50,7 +50,7 @@ module DB = struct
5050
; map =
5151
Pin_stanza.Project.map pins
5252
|> Package_name.Map.map ~f:(fun (url, pkg) ->
53-
let pkg = local_package_of_pin pkg ~url ~origin:`Dune in
53+
let pkg = local_package_of_pin pkg ~url ~origin:Pin_stanza in
5454
pkg, context)
5555
}
5656
;;
@@ -117,7 +117,7 @@ module DB = struct
117117
Dune_lang.Pin_stanza.Workspace.map pins
118118
|> String.Map.map ~f:(fun map ->
119119
Package_name.Map.map map ~f:(fun (url, package) ->
120-
local_package_of_pin package ~url ~origin:`Dune))
120+
local_package_of_pin package ~url ~origin:Pin_stanza))
121121
;;
122122

123123
let extract (t : t) ~names =
@@ -261,7 +261,7 @@ let resolve (t : DB.t) ~(scan_project : Scan_project.t)
261261
; Stack.pp stack
262262
]
263263
in
264-
let opam_package stack (package : Local_package.pin) =
264+
let pinned_via_opam stack (package : Local_package.pin) =
265265
let* resolved_package = Pinned_package.resolve_package package in
266266
resolve package.name resolved_package;
267267
Resolved_package.opam_file resolved_package
@@ -276,7 +276,7 @@ let resolve (t : DB.t) ~(scan_project : Scan_project.t)
276276
; version
277277
; name
278278
; loc = package.loc
279-
; origin = `Opam
279+
; origin = Opam_file
280280
}
281281
in
282282
let stack = Stack.push stack package in
@@ -286,7 +286,7 @@ let resolve (t : DB.t) ~(scan_project : Scan_project.t)
286286
|> Fiber.parallel_iter ~f:(fun package ->
287287
Pinned_package.resolve_package package >>| resolve package.name)
288288
in
289-
let dune_package packages (package : Local_package.pin) =
289+
let pinned_via_dune packages (package : Local_package.pin) =
290290
match Package_name.Map.find packages package.name with
291291
| None ->
292292
User_error.raise
@@ -331,13 +331,13 @@ let resolve (t : DB.t) ~(scan_project : Scan_project.t)
331331
|> Fiber.parallel_iter ~f:(fun (package : Local_package.pin) ->
332332
let stack = Stack.push stack package in
333333
match package.origin with
334-
| `Opam -> opam_package stack package
335-
| `Dune ->
334+
| Opam_file -> pinned_via_opam stack package
335+
| Pin_stanza ->
336336
eval_url package.url
337337
>>= (function
338-
| None -> opam_package stack package
338+
| None -> pinned_via_opam stack package
339339
| Some (more_sources, packages) ->
340-
dune_package packages package;
340+
pinned_via_dune packages package;
341341
let more_sources = DB.add_opam_pins more_sources packages in
342342
loop stack more_sources))
343343
in

0 commit comments

Comments
 (0)