feat(tui): initialize with Ratatui

Author: orhun

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["git-cliff-core", "git-cliff"]
+members = ["git-cliff-core", "git-cliff", "git-cliff-tui"]
 
 [workspace.dependencies]
 regex = "1.11.1"

Cargo.toml

@@ -28,20 +28,21 @@ use std::time::{
 };
 
 /// Changelog generator.
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub struct Changelog<'a> {
 	/// Releases that the changelog will contain.
 	pub releases:       Vec<Release<'a>>,
+	/// Configuration.
+	pub config:         Config,
 	header_template:    Option<Template>,
 	body_template:      Template,
 	footer_template:    Option<Template>,
-	config:             &'a Config,
 	additional_context: HashMap<String, serde_json::Value>,
 }
 
 impl<'a> Changelog<'a> {
 	/// Constructs a new instance.
-	pub fn new(releases: Vec<Release<'a>>, config: &'a Config) -> Result<Self> {
+	pub fn new(releases: Vec<Release<'a>>, config: Config) -> Result<Self> {
 		let mut changelog = Changelog::build(releases, config)?;
 		changelog.add_remote_data()?;
 		changelog.process_commits();
@@ -50,7 +51,7 @@ impl<'a> Changelog<'a> {
 	}
 
 	/// Builds a changelog from releases and config.
-	fn build(releases: Vec<Release<'a>>, config: &'a Config) -> Result<Self> {
+	fn build(releases: Vec<Release<'a>>, config: Config) -> Result<Self> {
 		let trim = config.changelog.trim.unwrap_or(true);
 		Ok(Self {
 			releases,
@@ -60,7 +61,7 @@ impl<'a> Changelog<'a> {
 				}
 				None => None,
 			},
-			body_template: get_body_template(config, trim)?,
+			body_template: get_body_template(&config, trim)?,
 			footer_template: match &config.changelog.footer {
 				Some(footer) => {
 					Some(Template::new("footer", footer.to_string(), trim)?)
@@ -73,7 +74,7 @@ impl<'a> Changelog<'a> {
 	}
 
 	/// Constructs an instance from a serialized context object.
-	pub fn from_context<R: Read>(input: &mut R, config: &'a Config) -> Result<Self> {
+	pub fn from_context<R: Read>(input: &mut R, config: Config) -> Result<Self> {
 		Changelog::build(serde_json::from_reader(input)?, config)
 	}
 
@@ -431,6 +432,7 @@ impl<'a> Changelog<'a> {
 
 	/// Adds information about the remote to the template context.
 	pub fn add_remote_context(&mut self) -> Result<()> {
+		debug!("Adding remote context...");
 		self.additional_context.insert(
 			"remote".to_string(),
 			serde_json::to_value(self.config.remote.clone())?,
@@ -1028,7 +1030,7 @@ mod test {
 	#[test]
 	fn changelog_generator() -> Result<()> {
 		let (config, releases) = get_test_data();
-		let mut changelog = Changelog::new(releases, &config)?;
+		let mut changelog = Changelog::new(releases, config)?;
 		changelog.bump_version()?;
 		changelog.releases[0].timestamp = 0;
 		let mut out = Vec::new();
@@ -1147,7 +1149,7 @@ chore(deps): fix broken deps
 ",
 			),
 		));
-		let changelog = Changelog::new(releases, &config)?;
+		let changelog = Changelog::new(releases, config)?;
 		let mut out = Vec::new();
 		changelog.generate(&mut out)?;
 		assert_eq!(
@@ -1251,7 +1253,7 @@ chore(deps): fix broken deps
 				{% endfor %}{% endfor %}"#
 				.to_string(),
 		);
-		let mut changelog = Changelog::new(releases, &config)?;
+		let mut changelog = Changelog::new(releases, config)?;
 		changelog.add_context("custom_field", "Hello")?;
 		let mut out = Vec::new();
 		changelog.generate(&mut out)?;

git-cliff-core/src/changelog.rs

@@ -75,15 +75,6 @@ impl Repository {
 		}
 	}
 
-	/// Returns the path of the repository.
-	pub fn path(&self) -> PathBuf {
-		let mut path = self.inner.path().to_path_buf();
-		if path.ends_with(".git") {
-			path.pop();
-		}
-		path
-	}
-
 	/// Sets the range for the commit search.
 	///
 	/// When a single SHA is provided as the range, start from the
@@ -104,6 +95,15 @@ impl Repository {
 		Ok(())
 	}
 
+	/// Returns the path of the repository.
+	pub fn path(&self) -> PathBuf {
+		let mut path = self.inner.path().to_path_buf();
+		if path.ends_with(".git") {
+			path.pop();
+		}
+		path
+	}
+
 	/// Parses and returns the commits.
 	///
 	/// Sorts the commits by their time.

git-cliff-core/src/repo.rs

@@ -20,7 +20,7 @@ use tera::{
 };
 
 /// Wrapper for [`Tera`].
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub struct Template {
 	/// Template name.
 	name:          String,

git-cliff-core/src/template.rs

@@ -0,0 +1,21 @@
+[package]
+name = "git-cliff-tui"
+version = "2.5.0" # managed by release.sh
+authors = ["Orhun Parmaksız <[email protected]>"]
+license = "MIT"
+edition = "2021"
+
+[dependencies]
+ratatui = { version = "0.29.0", features = ["unstable-widget-ref"] }
+copypasta = "0.10.1"
+tui-markdown = "0.3.0"
+ansi-to-tui = "7.0.0"
+unicode-width = "0.2.0"
+tachyonfx = "0.10.1"
+lazy_static.workspace = true
+
+[dependencies.git-cliff]
+version = "2.5.0" # managed by release.sh
+path = "../git-cliff"
+default-features = false
+features = ["github", "gitlab", "gitea", "bitbucket"]

git-cliff-tui/Cargo.toml

@@ -0,0 +1,185 @@
+use std::time::Instant;
+
+use ratatui::{
+	layout::Rect,
+	style::Color,
+};
+use tachyonfx::{
+	fx,
+	Effect,
+	HslConvertable,
+};
+
+use tachyonfx::Interpolatable;
+
+pub trait IndexResolver<T: Clone> {
+	fn resolve(idx: usize, data: &[T]) -> &T;
+}
+
+#[derive(Clone, Debug)]
+pub struct ColorCycle<T: IndexResolver<Color>> {
+	colors:  Vec<Color>,
+	_marker: std::marker::PhantomData<T>,
+}
+
+#[derive(Clone, Debug)]
+pub struct PingPongCycle;
+
+impl IndexResolver<Color> for PingPongCycle {
+	fn resolve(idx: usize, data: &[Color]) -> &Color {
+		let dbl_idx = idx % (2 * data.len());
+		let final_index = if dbl_idx < data.len() {
+			dbl_idx
+		} else {
+			2 * data.len() - 1 - dbl_idx
+		};
+
+		data.get(final_index)
+			.expect("ColorCycle: index out of bounds")
+	}
+}
+
+pub type PingPongColorCycle = ColorCycle<PingPongCycle>;
+
+#[derive(Clone, Debug)]
+pub struct RepeatingCycle;
+
+impl IndexResolver<Color> for RepeatingCycle {
+	fn resolve(idx: usize, data: &[Color]) -> &Color {
+		data.get(idx % data.len())
+			.expect("ColorCycle: index out of bounds")
+	}
+}
+
+pub type RepeatingColorCycle = ColorCycle<RepeatingCycle>;
+
+impl<T> ColorCycle<T>
+where
+	T: IndexResolver<Color>,
+{
+	pub fn new(initial_color: Color, colors: &[(usize, Color)]) -> Self {
+		let mut gradient = vec![initial_color];
+		colors
+			.iter()
+			.fold((0, initial_color), |(_, prev_color), (len, color)| {
+				(0..=*len).for_each(|i| {
+					let color = prev_color.lerp(color, i as f32 / *len as f32);
+					gradient.push(color);
+				});
+				gradient.push(*color);
+				(*len, *color)
+			});
+
+		Self {
+			colors:  gradient,
+			_marker: std::marker::PhantomData,
+		}
+	}
+
+	pub fn color_at(&self, idx: usize) -> &Color {
+		T::resolve(idx, &self.colors)
+	}
+}
+
+/// Creates a repeating color cycle based on a base color.
+///
+/// # Arguments
+/// * `base_color` - Primary color to derive the cycle from
+/// * `length_multiplier` - Factor to adjust the cycle length
+///
+/// # Returns
+/// A ColorCycle instance with derived colors and adjusted steps.
+fn create_color_cycle(
+	base_color: Color,
+	length_multiplier: usize,
+) -> ColorCycle<RepeatingCycle> {
+	let color_step: usize = 7 * length_multiplier;
+
+	let (h, s, l) = base_color.to_hsl();
+
+	let color_l = Color::from_hsl(h, s, 80.0);
+	let color_d = Color::from_hsl(h, s, 40.0);
+
+	RepeatingColorCycle::new(base_color, &[
+		(4 * length_multiplier, color_d),
+		(2 * length_multiplier, color_l),
+		(
+			4 * length_multiplier,
+			Color::from_hsl((h - 25.0) % 360.0, s, (l + 10.0).min(100.0)),
+		),
+		(
+			color_step,
+			Color::from_hsl(h, (s - 20.0).max(0.0), (l + 10.0).min(100.0)),
+		),
+		(
+			color_step,
+			Color::from_hsl((h + 25.0) % 360.0, s, (l + 10.0).min(100.0)),
+		),
+		(
+			color_step,
+			Color::from_hsl(h, (s + 20.0).max(0.0), (l + 10.0).min(100.0)),
+		),
+	])
+}
+
+/// Creates an animated border effect using color cycling.
+///
+/// # Arguments
+/// * `base_color` - The primary color to base the cycling effect on
+/// * `area` - The rectangular area where the effect should be rendered
+///
+/// # Returns
+///
+/// An Effect that animates a border around the specified area using cycled
+/// colors
+pub fn create_border_effect(
+	base_color: Color,
+	speed: f32,
+	length: usize,
+	area: Rect,
+) -> Effect {
+	let color_cycle = create_color_cycle(base_color, length);
+
+	let effect =
+		fx::effect_fn_buf(Instant::now(), u32::MAX, move |started_at, ctx, buf| {
+			let elapsed = started_at.elapsed().as_secs_f32();
+
+			// speed n cells/s
+			let idx = (elapsed * speed) as usize;
+
+			let area = ctx.area;
+
+			let mut update_cell = |(x, y): (u16, u16), idx: usize| {
+				if let Some(cell) = buf.cell_mut((x, y)) {
+					cell.set_fg(*color_cycle.color_at(idx));
+				}
+			};
+
+			(area.x..area.right()).enumerate().for_each(|(i, x)| {
+				update_cell((x, area.y), idx + i);
+			});
+
+			let cell_idx_offset = area.width as usize;
+			(area.y + 1..area.bottom() - 1)
+				.enumerate()
+				.for_each(|(i, y)| {
+					update_cell((area.right() - 1, y), idx + i + cell_idx_offset);
+				});
+
+			let cell_idx_offset =
+				cell_idx_offset + area.height.saturating_sub(2) as usize;
+			(area.x..area.right()).rev().enumerate().for_each(|(i, x)| {
+				update_cell((x, area.bottom() - 1), idx + i + cell_idx_offset);
+			});
+
+			let cell_idx_offset = cell_idx_offset + area.width as usize;
+			(area.y + 1..area.bottom())
+				.rev()
+				.enumerate()
+				.for_each(|(i, y)| {
+					update_cell((area.x, y), idx + i + cell_idx_offset);
+				});
+		});
+
+	effect.with_area(area)
+}