Source file test_autocmd.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
open Core
open Async
open Vcaml
open Vcaml_test_helpers

let%expect_test "Events are typed correctly" =
  with_client (fun client ->
    let typed_events = Autocmd.Event.all in
    let%bind documented_events, missing_events =
      let%bind runtime =
        Nvim.eval_viml_expression client "$VIMRUNTIME" ~result_type:String >>| ok_exn
      in
      let%map tags = Reader.file_lines (runtime ^/ "doc/tags") in
      List.filter_map tags ~f:(fun line ->
        match String.split line ~on:'\t' with
        | [ ("Cmd-event" | "FileExplorer" | "UserGettingBored"); _; _ ] -> None
        | [ tag; "autocmd.txt"; _pattern ] ->
          (match Char.is_uppercase tag.[0] with
           | false -> None
           | true ->
             (match tag.[0] with
              | ('E' | 'W')
                when String.drop_prefix tag 1 |> Int.of_string_opt |> Option.is_some ->
                (* Omit tags for warnings and errors. *)
                None
              | _ -> Some tag))
        | [ tag; "lsp.txt"; _pattern ] ->
          (match Char.is_uppercase tag.[0] with
           | false -> None
           | true ->
             (match tag with
              | "LSP" -> None
              | _ when String.is_prefix tag ~prefix:"Client:" ->
                (* The [Client:] entries refer to methods from the [lsp.client] module,
                   not Neovim events. *)
                None
              | _ -> Some tag))
        | _ -> None)
      |> List.partition_map ~f:(fun event ->
        match Autocmd.Event.of_string event with
        | event -> First event
        | exception _ -> Second event)
    in
    let extra_events =
      Set.diff
        (Autocmd.Event.Set.of_list typed_events)
        (Autocmd.Event.Set.of_list documented_events)
    in
    print_s
      [%message.omit_nil
        (missing_events : string list) (extra_events : Autocmd.Event.Set.t)];
    [%expect {| () |}];
    Deferred.Or_error.return ())
;;

module Maybe_group = Comparable.Make_plain (struct
    type t = Autocmd.Group.t option [@@deriving compare, sexp_of]
  end)

let%expect_test "get, create, delete, clear" =
  with_client (fun client ->
    let open Deferred.Or_error.Let_syntax in
    let all_events = Nonempty_list.of_list_exn Autocmd.Event.all in
    let print_summary () =
      let%map autocmds =
        Autocmd.get client ()
        >>| Maybe_group.Map.of_list_with_key_multi ~get_key:(fun { Autocmd.group; _ } ->
          group)
        >>| Map.map ~f:(fun autocmds -> List.length autocmds)
      in
      autocmds
      |> Map.to_alist
      |> List.map ~f:(fun (group, count) ->
        [%message (group : Autocmd.Group.t option) (count : int)])
      |> [%sexp_of: Sexp.t list]
      |> print_s
    in
    let%bind () = print_summary () in
    (* This is a summary of the initial autocommands from the runtime. The output is
       stable modulo version upgrades, and changes due to upgrades are innocuous. *)
    [%expect
      {|
      (((group ()) (count 9)) ((group (1)) (count 1)) ((group (2)) (count 5))
       ((group (3)) (count 1)) ((group (4)) (count 1)) ((group (5)) (count 1))
       ((group (6)) (count 1)) ((group (7)) (count 6)) ((group (8)) (count 1))
       ((group (9)) (count 88)) ((group (10)) (count 10)) ((group (11)) (count 3))
       ((group (12)) (count 48)) ((group (13)) (count 12))
       ((group (14)) (count 23)) ((group (15)) (count 63)) ((group (16)) (count 3))
       ((group (17)) (count 1)) ((group (18)) (count 2)) ((group (20)) (count 1)))
      |}];
    let%bind () =
      Autocmd.get client ()
      >>| List.map ~f:(fun event -> event.Autocmd.group)
      >>| List.filter_opt
      >>| List.dedup_and_sort ~compare:Autocmd.Group.compare
      >>= Deferred.Or_error.List.iter ~how:`Sequential ~f:(fun group ->
        Autocmd.clear client () ~group:(`Group group) ~events:all_events)
    in
    let%bind () = print_summary () in
    [%expect {| (((group ()) (count 9))) |}];
    let%bind () = Autocmd.clear client () ~group:`Not_in_any_group ~events:all_events in
    let%bind () = print_summary () in
    [%expect {| () |}];
    let get_and_print ?group ?events ?patterns_or_buffer () =
      Autocmd.get client ?group ?events ?patterns_or_buffer ()
      >>| List.iter ~f:(fun autocmd -> print_s [%sexp (autocmd : Autocmd.t)])
    in
    let%bind group1 = Autocmd.Group.create client "MyGroup1" in
    let%bind group2 = Autocmd.Group.create client "MyGroup2" in
    let%bind autocmd1 =
      Autocmd.create
        client
        ~description:"First autocmd"
        ~once:true
        ~nested:true
        ~group:group1
        ~patterns_or_buffer:(Buffer Current)
        ~events:[ WinEnter ]
        (Viml "echo 'Hello!'")
    in
    let%bind (_ : Autocmd.Id.t) =
      Autocmd.create
        client
        ~description:"Second autocmd"
        ~group:group2
        ~patterns_or_buffer:(Patterns [ "*.lua" ])
        ~events:[ FileType ]
        (Viml "echo 'Hello, Lua!'")
    in
    let%bind (_ : Autocmd.Id.t) =
      Autocmd.create
        client
        ~description:"Third autocmd"
        ~group:group2
        ~patterns_or_buffer:(Patterns [ "*" ])
        ~events:[ BufWinEnter ]
        (Viml "echo 'BufWinEnter'")
    in
    let%bind () = get_and_print ~events:[ WinLeave ] () in
    [%expect {| |}];
    let%bind () = get_and_print ~events:[ WinEnter ] () in
    [%expect
      {|
      ((id (17)) (group (21)) (group_name (MyGroup1))
       (description ("First autocmd")) (event WinEnter)
       (pattern_or_buffer (Buffer 1)) (once true) (command "echo 'Hello!'"))
      |}];
    let%bind () = get_and_print ~group:group1 () in
    [%expect
      {|
      ((id (17)) (group (21)) (group_name (MyGroup1))
       (description ("First autocmd")) (event WinEnter)
       (pattern_or_buffer (Buffer 1)) (once true) (command "echo 'Hello!'"))
      |}];
    let%bind () = get_and_print ~group:group2 () in
    [%expect
      {|
      ((id (19)) (group (22)) (group_name (MyGroup2))
       (description ("Third autocmd")) (event BufWinEnter)
       (pattern_or_buffer (Pattern *)) (once false) (command "echo 'BufWinEnter'"))
      ((id (18)) (group (22)) (group_name (MyGroup2))
       (description ("Second autocmd")) (event FileType)
       (pattern_or_buffer (Pattern *.lua)) (once false)
       (command "echo 'Hello, Lua!'"))
      |}];
    let%bind () = get_and_print ~patterns_or_buffer:(Patterns [ "*.lua" ]) () in
    [%expect
      {|
      ((id (18)) (group (22)) (group_name (MyGroup2))
       (description ("Second autocmd")) (event FileType)
       (pattern_or_buffer (Pattern *.lua)) (once false)
       (command "echo 'Hello, Lua!'"))
      |}];
    let%bind () = get_and_print ~patterns_or_buffer:(Buffer Current) () in
    [%expect
      {|
      ((id (17)) (group (21)) (group_name (MyGroup1))
       (description ("First autocmd")) (event WinEnter)
       (pattern_or_buffer (Buffer 1)) (once true) (command "echo 'Hello!'"))
      |}];
    let%bind () =
      Autocmd.clear
        client
        ~patterns_or_buffer:(Patterns [ "*" ])
        ()
        ~group:(`Group group2)
        ~events:[ BufWinEnter; BufWinLeave ]
    in
    let%bind () = get_and_print () in
    [%expect
      {|
      ((id (18)) (group (22)) (group_name (MyGroup2))
       (description ("Second autocmd")) (event FileType)
       (pattern_or_buffer (Pattern *.lua)) (once false)
       (command "echo 'Hello, Lua!'"))
      ((id (17)) (group (21)) (group_name (MyGroup1))
       (description ("First autocmd")) (event WinEnter)
       (pattern_or_buffer (Buffer 1)) (once true) (command "echo 'Hello!'"))
      |}];
    let%bind () = Autocmd.Group.delete client group2 in
    let%bind () = get_and_print () in
    [%expect
      {|
      ((id (17)) (group (21)) (group_name (MyGroup1))
       (description ("First autocmd")) (event WinEnter)
       (pattern_or_buffer (Buffer 1)) (once true) (command "echo 'Hello!'"))
      |}];
    let%bind () = Autocmd.delete client autocmd1 in
    let%bind () = get_and_print () in
    [%expect {| |}];
    return ())
;;

let%expect_test "exec" =
  with_ui_client ~args:[ "--noplugin"; "--cmd"; "set shortmess+=I" ] (fun client ui ->
    let open Deferred.Or_error.Let_syntax in
    let%bind group = Autocmd.Group.create client "Test group" in
    let%bind (_ : Autocmd.Id.t) =
      Autocmd.create
        client
        ~description:"Say hello"
        ~group
        ~events:[ User ]
        ~patterns_or_buffer:(Buffer Current)
        (Viml {| echo "Hello!" |})
    in
    let%bind () =
      Autocmd.exec client () ~events:[ User ] ~patterns_or_buffer:(Buffer Current)
    in
    let%bind () = get_screen_contents ui >>| print_endline in
    [%expect
      {|
      ╭────────────────────────────────────────────────────────────────────────────────╮
      │                                                                                │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │~                                                                               │
      │[No Name]                                                     0,0-1          All│
      │Hello!                                                                          │
      ╰────────────────────────────────────────────────────────────────────────────────╯
      |}];
    return ())
;;