Merge pull request #21 from mbarbin/vcs-git-eio

vcs-git-eio & vcs-git-provider

CHANGES.md

@@ -2,6 +2,8 @@
 
 ### Changed
 
+- Rename `vcs-git-cli` to `vcs-git-provider` (breaking change).
+- Rename `vcs-git` to `vcs-git-eio` (breaking change).
 - Rename `tree` to `graph` to designate the commit graph of a repository (breaking change).
 - Upgrade to `cmdlang.0.0.5`.
 

doc/docs/design/introduction.md

@@ -16,13 +16,13 @@ The `vcs` repository contains several components:
 stateDiagram-v2
   vcs : vcs *
   user : user-lib *
-  vcs_git_cli : vcs-git-cli
+  vcs_git_provider : vcs-git-provider
   executable : executable (eio)
-  provider : vcs-git
+  provider : vcs-git-eio
   runtime : eio
   vcs --> user
   user --> executable
-  vcs_git_cli --> provider
+  vcs_git_provider --> provider
   runtime --> provider
   provider --> executable
 ```
@@ -33,21 +33,21 @@ stateDiagram-v2
   Also marked with a * to indicate no runtime dependencies.
 - **executable**: A placeholder for a runtime component based on `user-lib` that
   commits to a specific provider and concurrency model.
-- **vcs-git-cli**: A IO-free library that parses the output of a `git` cli process.
-- **vcs-git**: An instantiation of `Vcs_git_cli` based on an `Eio` runtime.
-- **vcs-git-blocking**: An instantiation of `Vcs_git_cli` based on the OCaml `Stdlib`.
+- **vcs-git-provider**: A IO-free library that parses the output of a `git` cli process.
+- **vcs-git-eio**: An instantiation of `Vcs_git_provider` based on an `Eio` runtime.
+- **vcs-git-blocking**: An instantiation of `Vcs_git_provider` based on the OCaml `Stdlib`.
 
 ```mermaid
 stateDiagram-v2
   vcs : vcs *
   user : user-lib *
-  vcs_git_cli : vcs-git-cli
+  vcs_git_provider : vcs-git-provider
   executable : executable (blocking)
   provider : vcs-git-blocking
   runtime : stdlib
   vcs --> user
   user --> executable
-  vcs_git_cli --> provider
+  vcs_git_provider --> provider
   runtime --> provider
   provider --> executable
 ```

dune-project

@@ -116,7 +116,7 @@
    (>= 0.33))
   (vcs
    (= :version))
-  (vcs-git
+  (vcs-git-eio
    (= :version))))
 
 (package
@@ -181,13 +181,13 @@
    (= :version))
   (vcs-arg
    (= :version))
-  (vcs-git
+  (vcs-git-eio
    (= :version))
   (vcs-private-libs-eio
    (= :version))))
 
 (package
- (name vcs-git-cli)
+ (name vcs-git-provider)
  (synopsis "An IO-free library that parses the output of Git commands")
  (depends
   (ocaml
@@ -234,8 +234,9 @@
    (= :version))))
 
 (package
- (name vcs-git)
- (synopsis "A Git provider for Vcs based on Vcs_git_cli for Eio programs")
+ (name vcs-git-eio)
+ (synopsis
+  "A Git provider for Vcs based on Vcs_git_provider for Eio programs")
  (depends
   (ocaml
    (>= 5.2))
@@ -283,15 +284,15 @@
    (>= 0.0.8))
   (vcs
    (= :version))
-  (vcs-git-cli
+  (vcs-git-provider
    (= :version))
   (vcs-private-libs-eio
    (= :version))))
 
 (package
  (name vcs-git-blocking)
  (synopsis
-  "A Git provider for Vcs based on Vcs_git_cli for blocking programs")
+  "A Git provider for Vcs based on Vcs_git_provider for blocking programs")
  (depends
   (ocaml
    (>= 5.2))
@@ -337,7 +338,7 @@
    (>= 0.0.8))
   (vcs
    (= :version))
-  (vcs-git-cli
+  (vcs-git-provider
    (= :version))))
 
 (package
@@ -453,11 +454,11 @@
    (= :version))
   (vcs-command
    (= :version))
-  (vcs-git
+  (vcs-git-eio
    (= :version))
   (vcs-git-blocking
    (= :version))
-  (vcs-git-cli
+  (vcs-git-provider
    (= :version))
   (vcs-private-libs-base
    (= :version))

example/dune

@@ -24,7 +24,7 @@
   fpath
   fpath-base
   vcs
-  vcs_git
+  vcs_git_eio
   vcs_git_blocking
   vcs_test_helpers)
  (instrumentation

example/hello_error.ml

@@ -26,7 +26,7 @@
 let%expect_test "hello error" =
   Eio_main.run
   @@ fun env ->
-  let vcs = Vcs_git.create ~env in
+  let vcs = Vcs_git_eio.create ~env in
   let invalid_path = Absolute_path.v "/invalid/path" in
   let redact_sexp sexp =
     (* Because the actual error may become too brittle overtime, we actually

example/hello_git_cli.ml

@@ -28,7 +28,7 @@ let%expect_test "hello cli" =
   @@ fun env ->
   Eio.Switch.run
   @@ fun sw ->
-  let vcs = Vcs_git.create ~env in
+  let vcs = Vcs_git_eio.create ~env in
   let repo_root = Vcs_test_helpers.init_temp_repo ~env ~sw ~vcs in
   let hello_file = Vcs.Path_in_repo.v "hello.txt" in
   Vcs.save_file

example/hello_vcs.ml

@@ -31,7 +31,7 @@ let%expect_test "hello commit" =
   (* To use the [Vcs] API, you need a [vcs] value, which you must obtain from a
      provider. We're using [Vcs_git] for this here. It is a provider based on
      [Eio] and running the [git] command line as an external process. *)
-  let vcs = Vcs_git.create ~env in
+  let vcs = Vcs_git_eio.create ~env in
   (* The next step takes care of creating a fresh repository. We make use of a
      helper library to encapsulate the required steps. *)
   let repo_root = Vcs_test_helpers.init_temp_repo ~env ~sw ~vcs in

lib/vcs/src/vcs.mli

@@ -39,7 +39,7 @@ type -'a t = 'a Vcs0.t
 
 (** [create provider] returns a [vcs] that implements a given set of traits.
     Typical users do not use [create] directly, but rather will rely on an
-    actual provider. See for example [Vcs_git.create]. *)
+    actual provider. See for example [Vcs_git_eio.create]. *)
 val create : 'a Provider.t -> 'a t
 
 (** {1 Error handling}

lib/vcs/test/dune

@@ -30,7 +30,7 @@
   fpath
   fpath-base
   vcs
-  vcs_git_cli)
+  vcs_git_provider)
  (instrumentation
   (backend bisect_ppx))
  (lint

lib/vcs/test/test__graph.ml

@@ -26,13 +26,13 @@ let%expect_test "graph" =
     let path = Eio.Path.(Eio.Stdenv.fs env / "super-master-mind.log") in
     let contents = Eio.Path.load path in
     let lines = String.split_lines contents in
-    List.map lines ~f:(fun line -> Vcs_git_cli.Log.parse_log_line_exn ~line)
+    List.map lines ~f:(fun line -> Vcs_git_provider.Log.parse_log_line_exn ~line)
   in
   let refs =
     let path = Eio.Path.(Eio.Stdenv.fs env / "super-master-mind.refs") in
     let contents = Eio.Path.load path in
     let lines = String.split_lines contents in
-    Vcs_git_cli.Refs.parse_lines_exn ~lines
+    Vcs_git_provider.Refs.parse_lines_exn ~lines
   in
   let graph = Vcs.Graph.create () in
   print_s [%sexp { node_count = (Vcs.Graph.node_count graph : int) }];

lib/vcs/test/test__log.ml

@@ -27,7 +27,9 @@ let%expect_test "parse_exn" =
   let path = Eio.Path.(Eio.Stdenv.fs env / "super-master-mind.log") in
   let contents = Eio.Path.load path in
   let lines = String.split_lines contents in
-  let log = List.map lines ~f:(fun line -> Vcs_git_cli.Log.parse_log_line_exn ~line) in
+  let log =
+    List.map lines ~f:(fun line -> Vcs_git_provider.Log.parse_log_line_exn ~line)
+  in
   let roots = Vcs.Log.roots log in
   print_s [%sexp (roots : Vcs.Rev.t list)];
   [%expect

lib/vcs/test/test__name_status.ml

@@ -25,7 +25,7 @@ let%expect_test "parse_exn" =
   let path = Eio.Path.(Eio.Stdenv.fs env / "super-master-mind.name-status") in
   let contents = Eio.Path.load path in
   let lines = String.split_lines contents in
-  let name_status = Vcs_git_cli.Name_status.parse_lines_exn ~lines in
+  let name_status = Vcs_git_provider.Name_status.parse_lines_exn ~lines in
   let files_at_src = Vcs.Name_status.files_at_src name_status in
   let files_at_dst = Vcs.Name_status.files_at_dst name_status in
   print_s [%sexp (Set.diff files_at_dst files_at_src : Set.M(Vcs.Path_in_repo).t)];
@@ -47,7 +47,7 @@ let%expect_test "files" =
     ; "R100\toriginal_renamed_file\tnew_renamed_file"
     ]
   in
-  let name_status = Vcs_git_cli.Name_status.parse_lines_exn ~lines in
+  let name_status = Vcs_git_provider.Name_status.parse_lines_exn ~lines in
   print_s [%sexp (name_status : Vcs.Name_status.t)];
   [%expect
     {|

lib/vcs/test/test__num_status.ml

@@ -25,7 +25,7 @@ let%expect_test "parse_exn" =
   let path = Eio.Path.(Eio.Stdenv.fs env / "super-master-mind.num-status") in
   let contents = Eio.Path.load path in
   let lines = String.split_lines contents in
-  let num_status = Vcs_git_cli.Num_status.parse_lines_exn ~lines in
+  let num_status = Vcs_git_provider.Num_status.parse_lines_exn ~lines in
   ignore (num_status : Vcs.Num_status.t);
   [%expect {||}];
   ()

lib/vcs_arg/src/dune

@@ -15,7 +15,7 @@
   Or_error.Let_syntax
   -open
   Cmdlang)
- (libraries base cmdlang eio fpath fpath-base unix vcs vcs-git)
+ (libraries base cmdlang eio fpath fpath-base unix vcs vcs-git-eio)
  (instrumentation
   (backend bisect_ppx))
  (lint

lib/vcs_arg/src/vcs_arg.ml

@@ -68,7 +68,7 @@ module Create_vcs_backend = struct
     | Some ((`Git as vcs), dir) ->
       let vcs =
         match vcs with
-        | `Git -> Vcs_git.create ~env
+        | `Git -> Vcs_git_eio.create ~env
       in
       let repo_root = repo_root dir in
       Some (vcs, repo_root)
@@ -80,7 +80,7 @@ module Context = struct
     { config : Config.t
     ; fs : Eio.Fs.dir_ty Eio.Path.t
     ; cwd : Absolute_path.t
-    ; vcs : Vcs_git.t'
+    ; vcs : Vcs_git_eio.t'
     ; repo_root : Vcs.Repo_root.t
     }
 
@@ -121,7 +121,7 @@ end
 
 module Initialized = struct
   type t =
-    { vcs : Vcs_git.t'
+    { vcs : Vcs_git_eio.t'
     ; repo_root : Vcs.Repo_root.t
     ; context : Context.t
     }

lib/vcs_arg/src/vcs_arg.mli

@@ -43,7 +43,7 @@ end
 
 module Initialized : sig
   type t =
-    { vcs : Vcs_git.t'
+    { vcs : Vcs_git_eio.t'
     ; repo_root : Vcs.Repo_root.t
     ; context : Context.t
     }

lib/vcs_command/src/dune

@@ -24,7 +24,7 @@
   fpath-base
   vcs
   vcs-arg
-  vcs-git
+  vcs-git-eio
   vcs-private-libs-eio.eio-writer)
  (instrumentation
   (backend bisect_ppx))

lib/vcs_git_blocking/src/dune

@@ -11,7 +11,7 @@
   Base
   -open
   Fpath_base)
- (libraries base fpath fpath-base provider unix vcs vcs-git-cli)
+ (libraries base fpath fpath-base provider unix vcs vcs-git-provider)
  (instrumentation
   (backend bisect_ppx))
  (lint

lib/vcs_git_blocking/src/runtime.mli

@@ -21,6 +21,6 @@
 
 type t
 
-include Vcs_git_cli.Runtime.S with type t := t
+include Vcs_git_provider.Runtime.S with type t := t
 
 val create : unit -> t

lib/vcs_git_blocking/src/vcs_git_blocking.ml

@@ -19,12 +19,12 @@
 (*  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.       *)
 (*******************************************************************************)
 
-type 'a t = ([> Vcs_git_cli.Trait.t ] as 'a) Vcs.t
-type t' = Vcs_git_cli.Trait.t t
+type 'a t = ([> Vcs_git_provider.Trait.t ] as 'a) Vcs.t
+type t' = Vcs_git_provider.Trait.t t
 
 module Impl = struct
   include Runtime
-  include Vcs_git_cli.Make (Runtime)
+  include Vcs_git_provider.Make (Runtime)
 end
 
 let create () = Vcs.create (Provider.T { t = Impl.create (); handler = Impl.handler () })

lib/vcs_git_blocking/src/vcs_git_blocking.mli

@@ -20,18 +20,18 @@
 (*_******************************************************************************)
 
 (** Implementation of a git provider for the {!module:Vcs} library, based on
-    [Stdlib] and {!module:Vcs_git_cli}.
+    [Stdlib] and {!module:Vcs_git_provider}.
 
     This implementation is based on the [git] command line tool. We run it as an
     external program with utils from [Stdlib] and [Unix], producing the right
     command line invocation and parsing the output to produce a typed version of
-    the expected results with [Vcs_git_cli]. Note that [git] must be found in the
+    the expected results with [Vcs_git_provider]. Note that [git] must be found in the
     PATH of the running environment. *)
 
-type 'a t = ([> Vcs_git_cli.Trait.t ] as 'a) Vcs.t
+type 'a t = ([> Vcs_git_provider.Trait.t ] as 'a) Vcs.t
 
 (** This is a convenient type alias that may be used to designate a provider
     with the exact list of traits supported by this implementation. *)
-type t' = Vcs_git_cli.Trait.t t
+type t' = Vcs_git_provider.Trait.t t
 
 val create : unit -> _ t

lib/vcs_git/src/dune → lib/vcs_git_eio/src/dune

@@ -1,6 +1,6 @@
 (library
- (name vcs_git)
- (public_name vcs-git)
+ (name vcs_git_eio)
+ (public_name vcs-git-eio)
  (flags
   :standard
   -w
@@ -21,7 +21,7 @@
   fpath
   fpath-base
   vcs
-  vcs-git-cli
+  vcs-git-provider
   vcs-private-libs-eio.eio-process)
  (instrumentation
   (backend bisect_ppx))

lib/vcs_git/src/runtime.mli → lib/vcs_git_eio/src/runtime.mli

@@ -21,6 +21,6 @@
 
 type t
 
-include Vcs_git_cli.Runtime.S with type t := t
+include Vcs_git_provider.Runtime.S with type t := t
 
 val create : env:< fs : _ Eio.Path.t ; process_mgr : _ Eio.Process.mgr ; .. > -> t

lib/vcs_git/src/vcs_git.ml → lib/vcs_git_eio/src/vcs_git_eio.ml

@@ -19,12 +19,12 @@
 (*  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.       *)
 (*******************************************************************************)
 
-type 'a t = ([> Vcs_git_cli.Trait.t ] as 'a) Vcs.t
-type t' = Vcs_git_cli.Trait.t t
+type 'a t = ([> Vcs_git_provider.Trait.t ] as 'a) Vcs.t
+type t' = Vcs_git_provider.Trait.t t
 
 module Impl = struct
   include Runtime
-  include Vcs_git_cli.Make (Runtime)
+  include Vcs_git_provider.Make (Runtime)
 end
 
 let create ~env =