add-ed 0.14.0

Embeddable pure rust editor based on ED
Documentation 
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

// Tests for 'e' and 'E' command
// Only test for 'E' is with unsaved buffer, last in file

use std::collections::HashMap;
mod shared;
use shared::fixtures::{
  IOTest,
  ErrorTest,
};
use shared::fake_io::{
  FakeIO,
  ShellCommand,
};

// Verify behaviour of 'e' and 'E' command
//
// - Takes no index
// - Takes filepath or shell escape after command, defaults to state.path
// - Replaces buffer contens with contents of file/output of shell command
// - Sets state.path to given filepath if one is gived, else unchanged
// - Sets saved if a filepath is given
// - Selection after is all of the newly read data, aka. whole buffer
// - Only 'e' command: If unsaved returns unsaved error to prevent losing data

// Function to set up the "filesystem" for these tests
fn test_io() -> FakeIO {
  FakeIO {
    fake_fs: HashMap::from([
      ("text".to_owned(), "file\ndata\nin\nfile\n".to_owned()),
      ("numbers".to_owned(), "4\n5\n2\n1\n".to_owned()),
      ("not_terminated".to_owned(), "test\ndata".to_owned()),
    ]),
    fake_shell: HashMap::from([
      (
        ShellCommand{
          command:"echo hi".to_owned(),
          input: String::new(),
        },
        "hi\n".to_owned(),
      ),
      (
        ShellCommand{
          command:"sort -n".to_owned(),
          input:"4\n5\n2\n1\n".to_owned(),
        },
        "1\n2\n4\n5\n".to_owned(),
      ),
    ]),
  }
}

// No selection and no path, verify defaults
// (Since there are no changes 'e' should reread from disk, for example to get a
// updated version of a file after git pull or similar)
#[test]
fn edit_defaults() {
  let test_io = test_io();
  IOTest{
    init_buffer: vec!["text"],
    init_io: test_io.clone(),
    init_clipboard: vec!["dummy"],
    init_filepath: "text",
    command_input: vec![
      "e",
    ],
    expected_buffer: vec![
      "file",
      "data",
      "in",
      "file",
    ],
    expected_buffer_saved: true,
    expected_selection: (1,4),
    expected_file_changes: vec![], // No changes to the fs
    expected_clipboard: vec!["dummy"],
    expected_filepath: "text",
  }.run();
}

// Give path, verify state changes
#[test]
fn edit_path() {
  let test_io = test_io();
  IOTest{
    init_buffer: vec!["text"],
    init_io: test_io.clone(),
    init_clipboard: vec!["dummy"],
    init_filepath: "text",
    command_input: vec![
      "e numbers",
    ],
    expected_buffer: vec![
      "4",
      "5",
      "2",
      "1",
    ],
    expected_buffer_saved: true,
    expected_selection: (1,4),
    expected_file_changes: vec![], // No changes to the fs
    expected_clipboard: vec!["dummy"],
    expected_filepath: "numbers",
  }.run();
}

// Open file that isn't newline terminated
// (Should add a newline to the last line automatically)
#[test]
fn edit_non_terminated() {
  let test_io = test_io();
  IOTest{
    init_buffer: vec!["text"],
    init_io: test_io.clone(),
    init_clipboard: vec!["dummy"],
    init_filepath: "text",
    command_input: vec![
      "e not_terminated",
    ],
    expected_buffer: vec![
      "test",
      "data",
    ],
    expected_buffer_saved: true,
    expected_selection: (1,2),
    expected_file_changes: vec![], // No changes to the fs
    expected_clipboard: vec!["dummy"],
    expected_filepath: "not_terminated",
  }.run();
}

// Give path that doesn't exist yet, verify state changes
#[test]
fn edit_new_file() {
  let test_io = test_io();
  IOTest{
    init_buffer: vec!["text"],
    init_io: test_io.clone(),
    init_clipboard: vec!["dummy"],
    init_filepath: "text",
    command_input: vec![
      "e new_file",
    ],
    expected_buffer: vec![
    ],
    expected_buffer_saved: true,
    expected_selection: (1,0),
    expected_file_changes: vec![], // No changes to the fs
    expected_clipboard: vec!["dummy"],
    expected_filepath: "new_file",
  }.run();
}

// Give selection, should panic
#[test]
fn edit_selection() {
  ErrorTest{
    init_buffer: vec!["text"],
    command_input: vec![
      ",e",
    ],
    expected_error: add_ed::EdError::SelectionForbidden,
  }.run();
}

// With edits, should error early so we don't need an IO
#[test]
fn edit_unsaved() {
  ErrorTest{
    init_buffer: vec!["text"],
    command_input: vec![
      "e",
    ],
    expected_error: add_ed::EdError::UnsavedChanges,
  }.run();
}

// With edits, should go through with force
#[test]
fn force_edit_unsaved() {
  let test_io = test_io();
  IOTest{
    init_buffer: vec!["text"],
    init_io: test_io.clone(),
    init_clipboard: vec!["dummy"],
    init_filepath: "text",
    command_input: vec![
      "i",
      "line",
      ".",
      "E",
    ],
    expected_buffer: vec![
      "file",
      "data",
      "in",
      "file",
    ],
    expected_buffer_saved: true,
    expected_selection: (1,4),
    expected_file_changes: vec![], // No changes to the fs
    expected_clipboard: vec!["dummy"],
    expected_filepath: "text",
  }.run();
}