Fix text-diff representation of multiline item changes

NathanReb · NathanReb · commit bba2a06597f4 · 2024-08-27T18:24:32.000+02:00
Signed-off-by: Nathan Rebours &lt;nathan.p.rebours@gmail.com&gt;
diff --git a/lib/text_diff.ml b/lib/text_diff.ml
@@ -2,38 +2,37 @@ open Types
 
 type t = Diffutils.Diff.t String_map.t
 
-let vd_to_string name vd =
+let vd_to_lines name vd =
   let buf = Buffer.create 256 in
   let formatter = Format.formatter_of_buffer buf in
   Printtyp.value_description (Ident.create_local name) formatter vd;
   Format.pp_print_flush formatter ();
-  Buffer.contents buf
+  CCString.lines (Buffer.contents buf)
 
-let md_to_string name md =
+let md_to_lines name md =
   let buf = Buffer.create 256 in
   let formatter = Format.formatter_of_buffer buf in
   Printtyp.modtype formatter md.md_type;
   Format.pp_print_flush formatter ();
-  "module " ^ name ^ ": " ^ Buffer.contents buf
+  let module_str = "module " ^ name ^ ": " ^ Buffer.contents buf in
+  CCString.lines module_str
 
 let process_value_diff (val_diff : Diff.value) =
   match val_diff.vdiff with
   | Added vd ->
       [
-        Diffutils.Diff.Diff
-          { orig = []; new_ = [ vd_to_string val_diff.vname vd ] };
+        Diffutils.Diff.Diff { orig = []; new_ = vd_to_lines val_diff.vname vd };
       ]
   | Removed vd ->
       [
-        Diffutils.Diff.Diff
-          { orig = [ vd_to_string val_diff.vname vd ]; new_ = [] };
+        Diffutils.Diff.Diff { orig = vd_to_lines val_diff.vname vd; new_ = [] };
       ]
   | Modified { reference; current } ->
       [
         Diffutils.Diff.Diff
           {
-            orig = [ vd_to_string val_diff.vname reference ];
-            new_ = [ vd_to_string val_diff.vname current ];
+            orig = vd_to_lines val_diff.vname reference;
+            new_ = vd_to_lines val_diff.vname current;
           };
       ]
 
@@ -50,7 +49,7 @@ let from_diff (diff : Diff.module_) : Diffutils.Diff.t String_map.t =
         let diff =
           [
             Diffutils.Diff.Diff
-              { orig = []; new_ = [ md_to_string module_diff.mname curr_md ] };
+              { orig = []; new_ = md_to_lines module_diff.mname curr_md };
           ]
         in
         String_map.update module_path
@@ -61,7 +60,7 @@ let from_diff (diff : Diff.module_) : Diffutils.Diff.t String_map.t =
         let diff =
           [
             Diffutils.Diff.Diff
-              { orig = [ md_to_string module_diff.mname ref_md ]; new_ = [] };
+              { orig = md_to_lines module_diff.mname ref_md; new_ = [] };
           ]
         in
         String_map.update module_path
diff --git a/tests/api-watch/test_text_diff.ml b/tests/api-watch/test_text_diff.ml
@@ -29,11 +29,11 @@ let%expect_test "multi-line items are represented as multi-line diffs" =
     {|
     diff module Main:
     +val f :
-      some_long_labeled_argument:int ->
-      some_other_long_labeled_arg:int * int -> string * string -> unit -> string
+    +  some_long_labeled_argument:int ->
+    +  some_other_long_labeled_arg:int * int -> string * string -> unit -> string
     +module M: sig
-      val some_val : int -> int -> int -> string
-      val some_other_val : string -> string -> string -> int
-      val yet_some_other_val : string -> bool -> string
-    end
+    +  val some_val : int -> int -> int -> string
+    +  val some_other_val : string -> string -> string -> int
+    +  val yet_some_other_val : string -> bool -> string
+    +end
     |}]

Original file line number	Diff line number	Diff line change
`@@ -2,38 +2,37 @@ open Types`
`2`	`2`
`3`	`3`	`type t = Diffutils.Diff.t String_map.t`
`4`	`4`
`5`		`-let vd_to_string name vd =`
	`5`	`+let vd_to_lines name vd =`
`6`	`6`	`let buf = Buffer.create 256 in`
`7`	`7`	`let formatter = Format.formatter_of_buffer buf in`
`8`	`8`	`Printtyp.value_description (Ident.create_local name) formatter vd;`
`9`	`9`	`Format.pp_print_flush formatter ();`
`10`		`- Buffer.contents buf`
	`10`	`+ CCString.lines (Buffer.contents buf)`
`11`	`11`
`12`		`-let md_to_string name md =`
	`12`	`+let md_to_lines name md =`
`13`	`13`	`let buf = Buffer.create 256 in`
`14`	`14`	`let formatter = Format.formatter_of_buffer buf in`
`15`	`15`	`Printtyp.modtype formatter md.md_type;`
`16`	`16`	`Format.pp_print_flush formatter ();`
`17`		`- "module " ^ name ^ ": " ^ Buffer.contents buf`
	`17`	`+ let module_str = "module " ^ name ^ ": " ^ Buffer.contents buf in`
	`18`	`+ CCString.lines module_str`
`18`	`19`
`19`	`20`	`let process_value_diff (val_diff : Diff.value) =`
`20`	`21`	`match val_diff.vdiff with`
`21`	`22`	`\| Added vd ->`
`22`	`23`	`[`
`23`		`- Diffutils.Diff.Diff`
`24`		`- { orig = []; new_ = [ vd_to_string val_diff.vname vd ] };`
	`24`	`+ Diffutils.Diff.Diff { orig = []; new_ = vd_to_lines val_diff.vname vd };`
`25`	`25`	`]`
`26`	`26`	`\| Removed vd ->`
`27`	`27`	`[`
`28`		`- Diffutils.Diff.Diff`
`29`		`- { orig = [ vd_to_string val_diff.vname vd ]; new_ = [] };`
	`28`	`+ Diffutils.Diff.Diff { orig = vd_to_lines val_diff.vname vd; new_ = [] };`
`30`	`29`	`]`
`31`	`30`	`\| Modified { reference; current } ->`
`32`	`31`	`[`
`33`	`32`	`Diffutils.Diff.Diff`
`34`	`33`	`{`
`35`		`- orig = [ vd_to_string val_diff.vname reference ];`
`36`		`- new_ = [ vd_to_string val_diff.vname current ];`
	`34`	`+ orig = vd_to_lines val_diff.vname reference;`
	`35`	`+ new_ = vd_to_lines val_diff.vname current;`
`37`	`36`	`};`
`38`	`37`	`]`
`39`	`38`
`@@ -50,7 +49,7 @@ let from_diff (diff : Diff.module_) : Diffutils.Diff.t String_map.t =`
`50`	`49`	`let diff =`
`51`	`50`	`[`
`52`	`51`	`Diffutils.Diff.Diff`
`53`		`- { orig = []; new_ = [ md_to_string module_diff.mname curr_md ] };`
	`52`	`+ { orig = []; new_ = md_to_lines module_diff.mname curr_md };`
`54`	`53`	`]`
`55`	`54`	`in`
`56`	`55`	`String_map.update module_path`
`@@ -61,7 +60,7 @@ let from_diff (diff : Diff.module_) : Diffutils.Diff.t String_map.t =`
`61`	`60`	`let diff =`
`62`	`61`	`[`
`63`	`62`	`Diffutils.Diff.Diff`
`64`		`- { orig = [ md_to_string module_diff.mname ref_md ]; new_ = [] };`
	`63`	`+ { orig = md_to_lines module_diff.mname ref_md; new_ = [] };`
`65`	`64`	`]`
`66`	`65`	`in`
`67`	`66`	`String_map.update module_path`