cursus 0.3.0

Library crate for the cursus release management CLI
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
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
//! TUI for selecting projects and the type of change (major, minor, patch).

use anyhow::Context;
use crossterm::event::Event;
use ratatui::prelude::*;
use ratatui_textarea::TextArea;

use super::screens::ButtonScreen;
use super::widgets::{self, KeyResult};
use crate::model::changeset::ChangeType;
use crate::package_manager::Project;

mod enter_message;
mod select_projects;
mod single_package;

/// The result of a completed change selection.
#[derive(Debug, Clone)]
pub struct ChangeResult {
	/// The projects and their per-package change types selected by the user.
	pub projects: Vec<(Project, ChangeType)>,
	/// The changeset description. `None` means launch the editor.
	pub message: Option<String>,
}

/// Options that can be pre-filled to skip interactive steps.
#[derive(Debug, Clone, Default)]
pub struct ChangeOptions {
	/// Pre-selected change type (skips selection screen).
	pub change_type: Option<ChangeType>,
	/// Pre-selected project indices (skips project selection screen).
	pub projects: Option<Vec<usize>>,
}

/// State for the [`Screen::SelectProjects`] screen.
#[derive(Debug)]
struct SelectProjectsState {
	selected: Vec<bool>,
	/// Per-project change level (shown only for selected projects).
	levels: Vec<ChangeType>,
	cursor: usize,
	error: bool,
	/// Number of projects in the "Changed" group (always the first slice).
	changed_count: usize,
}

/// State carried when navigating back from [`Screen::EnterMessage`].
enum BackState {
	MultiPackage(SelectProjectsState),
	SinglePackage { level: ChangeType },
}

enum Screen {
	SelectProjects(SelectProjectsState),
	SinglePackage {
		level: ChangeType,
	},
	EnterMessage {
		textarea: Box<TextArea<'static>>,
		projects: Vec<(Project, ChangeType)>,
		back: BackState,
	},
}

/// Shorthand for the handle_event return type used by the internal state machine.
type HandleResult = KeyResult<Screen, ChangeResult>;

/// Output of [`reorder_projects`]: projects sorted changed-first, with index mapping.
struct ReorderedProjects {
	/// Projects reordered: changed first (sorted by name), then unchanged (sorted by name).
	projects: Vec<Project>,
	/// Number of projects in the changed group (the first `changed_count` entries).
	changed_count: usize,
	/// Maps original index → new index in `projects`.
	orig_to_new: Vec<usize>,
}

/// Partitions and sorts `projects` into changed-first order based on `changed_flags`.
///
/// Both groups are sorted by project name within their group. Returns the
/// reordered list together with the boundary count and an index mapping.
///
/// # Precondition
///
/// `changed_flags.len()` must equal `projects.len()`. The caller in [`run`]
/// ensures this by normalising the slice before calling this function.
fn reorder_projects(projects: &[Project], changed_flags: &[bool]) -> ReorderedProjects {
	let changed_count = changed_flags.iter().filter(|&&c| c).count();
	let mut changed_pairs: Vec<(usize, Project)> = projects
		.iter()
		.enumerate()
		.filter(|(i, _)| changed_flags[*i])
		.map(|(i, p)| (i, p.clone()))
		.collect();
	let mut unchanged_pairs: Vec<(usize, Project)> = projects
		.iter()
		.enumerate()
		.filter(|(i, _)| !changed_flags[*i])
		.map(|(i, p)| (i, p.clone()))
		.collect();
	changed_pairs.sort_by(|a, b| a.1.name().cmp(b.1.name()));
	unchanged_pairs.sort_by(|a, b| a.1.name().cmp(b.1.name()));
	let reordered_pairs: Vec<(usize, Project)> =
		changed_pairs.into_iter().chain(unchanged_pairs).collect();
	let mut orig_to_new = vec![0usize; projects.len()];
	for (new_idx, (orig_idx, _)) in reordered_pairs.iter().enumerate() {
		orig_to_new[*orig_idx] = new_idx;
	}
	let reordered = reordered_pairs.into_iter().map(|(_, p)| p).collect();
	ReorderedProjects {
		projects: reordered,
		changed_count,
		orig_to_new,
	}
}

fn handle_event(
	screen: Screen,
	event: Event,
	area: Rect,
	projects: &[Project],
) -> anyhow::Result<HandleResult> {
	match screen {
		Screen::SelectProjects(state) => Ok(select_projects::handle_event_select_projects(
			state, event, area, projects,
		)),
		Screen::SinglePackage { level } => {
			let project = projects
				.first()
				.context("SinglePackage screen requires at least one project")?
				.clone();
			let buttons = single_package::SinglePackageButtons { level };
			match buttons.handle_event(vec![project], event, area)? {
				KeyResult::Continue((_, screen)) => Ok(KeyResult::Continue(screen)),
				KeyResult::Complete(cr) => Ok(KeyResult::Complete(cr)),
				KeyResult::Cancelled => Ok(KeyResult::Cancelled),
			}
		}
		Screen::EnterMessage {
			textarea,
			projects: proj,
			back,
		} => enter_message::handle_event_enter_message(textarea, proj, back, event),
	}
}

fn ui(frame: &mut Frame, screen: &Screen, project_names: &[&str]) {
	let area = frame.area();
	match screen {
		Screen::SelectProjects(state) => {
			select_projects::render_select_projects(frame, area, project_names, state);
		}
		Screen::SinglePackage { level } => {
			single_package::SinglePackageButtons { level: *level }.render(frame, area);
		}
		Screen::EnterMessage { textarea, .. } => {
			enter_message::render_enter_message(frame, area, textarea);
		}
	}
}

/// Constructs the initial [`Screen`] for the TUI based on how many projects
/// there are and whether the caller pre-selected any of them.
fn build_initial_screen(
	ro: &ReorderedProjects,
	project_indices: &[usize],
	have_projects: bool,
) -> Screen {
	if ro.projects.len() == 1 {
		return Screen::SinglePackage {
			level: ChangeType::Patch,
		};
	}
	if have_projects {
		let mut selected = vec![false; ro.projects.len()];
		for &i in project_indices {
			selected[i] = true;
		}
		Screen::SelectProjects(SelectProjectsState {
			selected,
			levels: vec![ChangeType::Patch; ro.projects.len()],
			cursor: 0,
			error: false,
			changed_count: ro.changed_count,
		})
	} else {
		let selected = (0..ro.projects.len())
			.map(|i| i < ro.changed_count)
			.collect();
		Screen::SelectProjects(SelectProjectsState {
			selected,
			levels: vec![ChangeType::Patch; ro.projects.len()],
			cursor: 0,
			error: false,
			changed_count: ro.changed_count,
		})
	}
}

/// Runs the interactive TUI for selecting projects and a change type.
///
/// Displays a terminal UI that allows the user to select which projects
/// to include and the type of semantic version change. Projects are split
/// into "Changed" (pre-selected) and "Unchanged" (unselected) groups based
/// on the provided `changed` classification.
///
/// # Returns
///
/// Returns `Ok(Some(ChangeResult))` if the user completes selection,
/// or `Ok(None)` if the user cancels.
///
/// # Errors
///
/// Returns an error if terminal setup or I/O operations fail.
pub fn run(
	projects: &[Project],
	options: &ChangeOptions,
	changed: &[bool],
) -> anyhow::Result<Option<ChangeResult>> {
	let changed_flags: Vec<bool> = if changed.len() == projects.len() {
		changed.to_vec()
	} else {
		vec![true; projects.len()] // length mismatch: treat all as changed
	};

	let ro = reorder_projects(projects, &changed_flags);

	let project_indices: Vec<usize> = match &options.projects {
		Some(indices) => indices.iter().map(|&i| ro.orig_to_new[i]).collect(),
		None if ro.projects.len() == 1 => vec![0],
		_ => vec![], // Need interactive project selection
	};

	let have_projects = !project_indices.is_empty();

	if let Some(change_type) = options.change_type {
		let indices = if have_projects {
			project_indices
		} else {
			(0..ro.projects.len()).collect()
		};
		return Ok(Some(ChangeResult {
			projects: indices
				.into_iter()
				.map(|i| (ro.projects[i].clone(), change_type))
				.collect(),
			message: None,
		}));
	}

	let project_names: Vec<&str> = ro.projects.iter().map(|p| p.name()).collect();
	let initial_screen = build_initial_screen(&ro, &project_indices, have_projects);

	let result = widgets::run_tui(
		initial_screen,
		|frame, screen| ui(frame, screen, &project_names),
		|screen, event, area| handle_event(screen, event, area, &ro.projects),
	)?;

	Ok(result)
}

/// Thin keyboard-only wrapper around `handle_event` for use in unit tests.
///
/// Passes a default 80×24 content area so tests don't need to supply one.
#[cfg(test)]
fn handle_key(
	screen: Screen,
	key: crossterm::event::KeyCode,
	projects: &[Project],
) -> anyhow::Result<HandleResult> {
	use crossterm::event::{KeyEvent, KeyModifiers};
	handle_event(
		screen,
		Event::Key(KeyEvent::new(key, KeyModifiers::NONE)),
		Rect::new(0, 0, 80, 24),
		projects,
	)
}

#[cfg(test)]
pub(super) mod test_helpers {
	use crate::package_manager::Project;

	pub(super) fn dummy_projects(n: usize) -> Vec<Project> {
		(0..n)
			.map(|i| {
				Project::new_test(
					&format!("project-{i}"),
					&format!("/nonexistent/projects/project-{i}"),
				)
			})
			.collect()
	}
}

#[cfg(test)]
mod tests {
	use crossterm::event::KeyCode;

	use crate::model::changeset::ChangeType;
	use crate::package_manager::Project;

	use super::test_helpers::dummy_projects;
	use super::*;

	// --- reorder_projects tests ---

	#[test]
	fn reorder_projects_mixed_changed_and_unchanged() {
		let projects = dummy_projects(3); // project-0, project-1, project-2
		let changed_flags = vec![false, true, false];
		let ro = reorder_projects(&projects, &changed_flags);
		// Changed: [project-1], Unchanged: [project-0, project-2] (sorted by name)
		assert_eq!(ro.changed_count, 1);
		assert_eq!(ro.projects[0].name(), "project-1"); // only changed
		assert_eq!(ro.projects[1].name(), "project-0"); // unchanged, alphabetically first
		assert_eq!(ro.projects[2].name(), "project-2");
		assert_eq!(ro.orig_to_new[0], 1); // project-0 (orig 0) → new idx 1
		assert_eq!(ro.orig_to_new[1], 0); // project-1 (orig 1) → new idx 0
		assert_eq!(ro.orig_to_new[2], 2); // project-2 (orig 2) → new idx 2
	}

	#[test]
	fn reorder_projects_all_changed() {
		let projects = dummy_projects(2);
		let ro = reorder_projects(&projects, &[true, true]);
		assert_eq!(ro.changed_count, 2);
		assert_eq!(ro.projects[0].name(), "project-0");
		assert_eq!(ro.projects[1].name(), "project-1");
		assert_eq!(ro.orig_to_new[0], 0);
		assert_eq!(ro.orig_to_new[1], 1);
	}

	#[test]
	fn reorder_projects_all_unchanged() {
		let projects = dummy_projects(2);
		let ro = reorder_projects(&projects, &[false, false]);
		assert_eq!(ro.changed_count, 0);
		assert_eq!(ro.projects[0].name(), "project-0");
		assert_eq!(ro.projects[1].name(), "project-1");
		assert_eq!(ro.orig_to_new[0], 0);
		assert_eq!(ro.orig_to_new[1], 1);
	}

	#[test]
	fn reorder_projects_empty() {
		let ro = reorder_projects(&[], &[]);
		assert_eq!(ro.changed_count, 0);
		assert!(ro.projects.is_empty());
		assert!(ro.orig_to_new.is_empty());
	}

	#[test]
	fn reorder_projects_single_project() {
		let projects = dummy_projects(1);
		let ro = reorder_projects(&projects, &[true]);
		assert_eq!(ro.changed_count, 1);
		assert_eq!(ro.projects[0].name(), "project-0");
		assert_eq!(ro.orig_to_new[0], 0);
	}

	#[test]
	fn reorder_projects_sorts_changed_group_by_name() {
		let projects = vec![
			Project::new_test("beta", "/nonexistent/beta"),
			Project::new_test("alpha", "/nonexistent/alpha"),
		];
		let ro = reorder_projects(&projects, &[true, true]);
		assert_eq!(ro.changed_count, 2);
		assert_eq!(ro.projects[0].name(), "alpha");
		assert_eq!(ro.projects[1].name(), "beta");
		assert_eq!(ro.orig_to_new[0], 1); // "beta" (orig 0) → new idx 1
		assert_eq!(ro.orig_to_new[1], 0); // "alpha" (orig 1) → new idx 0
	}

	#[test]
	fn reorder_projects_sorts_unchanged_group_by_name() {
		let projects = vec![
			Project::new_test("zeta", "/nonexistent/zeta"),
			Project::new_test("gamma", "/nonexistent/gamma"),
		];
		let ro = reorder_projects(&projects, &[false, false]);
		assert_eq!(ro.changed_count, 0);
		assert_eq!(ro.projects[0].name(), "gamma");
		assert_eq!(ro.projects[1].name(), "zeta");
		assert_eq!(ro.orig_to_new[0], 1); // "zeta" → new idx 1
		assert_eq!(ro.orig_to_new[1], 0); // "gamma" → new idx 0
	}

	/// Unwrap a `Continue(Screen::SelectProjects(...))` result, panicking on mismatch.
	fn unwrap_select_projects(
		result: anyhow::Result<HandleResult>,
	) -> (Vec<bool>, Vec<ChangeType>, usize, bool, usize) {
		match result.unwrap() {
			KeyResult::Continue(Screen::SelectProjects(SelectProjectsState {
				selected,
				levels,
				cursor,
				error,
				changed_count,
			})) => (selected, levels, cursor, error, changed_count),
			other => panic!(
				"Expected Continue(SelectProjects), got different variant: {:?}",
				std::mem::discriminant(&other)
			),
		}
	}

	/// Unwrap a `Continue(Screen::EnterMessage {...})` result.
	fn unwrap_enter_message(result: anyhow::Result<HandleResult>) -> Vec<(Project, ChangeType)> {
		match result.unwrap() {
			KeyResult::Continue(Screen::EnterMessage { projects, .. }) => projects,
			_ => panic!("Expected Continue(EnterMessage)"),
		}
	}

	#[test]
	fn workflow_select_projects_then_enter_message() {
		let projects = dummy_projects(3);

		let screen = Screen::SelectProjects(SelectProjectsState {
			selected: vec![true, true, true],
			levels: vec![ChangeType::Patch; 3],
			cursor: 0,
			error: false,
			changed_count: 3,
		});

		// Deselect first project
		let (selected, levels, cursor, error, changed_count) =
			unwrap_select_projects(handle_key(screen, KeyCode::Char(' '), &projects));
		assert_eq!(selected, vec![false, true, true]);
		assert_eq!(levels, vec![ChangeType::Patch; 3]);
		assert_eq!(cursor, 0);
		assert!(!error);
		assert_eq!(changed_count, 3);

		// Change level of project at cursor (0) — but it's not selected, so no change
		let screen = Screen::SelectProjects(SelectProjectsState {
			selected: vec![false, true, true],
			levels: vec![ChangeType::Patch; 3],
			cursor: 1,
			error: false,
			changed_count: 3,
		});

		// Change level of project-1: Patch.next() == Major
		let (selected2, levels2, ..) =
			unwrap_select_projects(handle_key(screen, KeyCode::Right, &projects));
		assert_eq!(selected2, vec![false, true, true]);
		assert_eq!(levels2[1], ChangeType::Major);

		// Confirm → EnterMessage with selected projects and levels
		let screen = Screen::SelectProjects(SelectProjectsState {
			selected: vec![false, true, true],
			levels: vec![ChangeType::Patch, ChangeType::Major, ChangeType::Patch],
			cursor: 0,
			error: false,
			changed_count: 3,
		});
		let proj = unwrap_enter_message(handle_key(screen, KeyCode::Enter, &projects));
		assert_eq!(proj.len(), 2);
		assert_eq!(proj[0].0.name(), "project-1");
		assert_eq!(proj[0].1, ChangeType::Major);
		assert_eq!(proj[1].0.name(), "project-2");
		assert_eq!(proj[1].1, ChangeType::Patch);
	}

	/// Catches the `== 1`→`!= 1` mutation at line 169: single project → `SinglePackage`.
	#[test]
	fn build_initial_screen_single_project_returns_single_package() {
		let projects = dummy_projects(1);
		let ro = reorder_projects(&projects, &[true]);
		let screen = build_initial_screen(&ro, &[], false);
		assert!(
			matches!(screen, Screen::SinglePackage { .. }),
			"Expected SinglePackage for one project"
		);
	}

	/// Catches the `<`→`<=` mutation at line 188: projects[0] (index 0 < changed_count=1)
	/// should be pre-selected; projects[1] (index 1 >= 1) should not be.
	#[test]
	fn build_initial_screen_no_pre_selection_selects_only_changed() {
		let projects = dummy_projects(2);
		let ro = reorder_projects(&projects, &[true, false]); // 1 changed
		let screen = build_initial_screen(&ro, &[], false);
		match screen {
			Screen::SelectProjects(SelectProjectsState {
				selected,
				changed_count,
				..
			}) => {
				assert_eq!(changed_count, 1);
				assert!(selected[0], "first project (changed) should be selected");
				assert!(
					!selected[1],
					"second project (unchanged) should not be selected"
				);
			}
			_ => panic!("Expected SelectProjects"),
		}
	}
}