[Enhancement] Breaking Changes v4.0.0

.github/aeruginous.cff

@@ -12,12 +12,9 @@ keywords:
   - cffcreate
   - cffref
   - cffreference
-  - cffrel
-  - cffreleasetoday
   - cff-create
   - cff-ref
   - cff-reference
-  - cff-rel
   - cff-release-today
   - changelog
   - citation-file-format

src/application.rs

@@ -17,10 +17,7 @@
 |                                                                              |
 \******************************************************************************/
 
-use crate::{AppendAsLine, PatternWriter};
 use clap::{Parser, Subcommand};
-use std::{io::BufRead, path::PathBuf};
-use sysexits::Result;
 
 /// The supported application modes.
 ///
@@ -38,19 +35,6 @@ pub enum Action {
     /// Extract the citation information from a given and valid CFF file.
     Cffreference(crate::Cffreference),
 
-    /// ⚠️  DEPRECATED.
-    ///
-    /// Increment the release date in CFFs.
-    ///
-    /// This application mode is deprecated.  Please use `aeruginous
-    /// increment-version [-e|-R] <FILE>` instead.
-    #[command(aliases = ["cffrel", "cff-rel", "cffreleasetoday"])]
-    #[deprecated(since = "3.6.2", note = "use `IncrementVersion` instead")]
-    CffReleaseToday {
-        /// The file to work on.
-        file_to_edit: PathBuf,
-    },
-
     /// Create comments on the commits of a branch in this repository.
     CommentChanges(crate::CommentChanges),
 
@@ -91,38 +75,11 @@ impl Action {
     /// # Errors
     ///
     /// See [`sysexits::ExitCode`].
-    pub fn run(&self) -> Result<()> {
+    pub fn run(&self) -> sysexits::Result<()> {
         match self {
             #[cfg(feature = "cff-create")]
             Self::CffCreate(c) => c.main(),
             Self::Cffreference(c) => c.main(),
-            #[allow(deprecated)]
-            Self::CffReleaseToday { file_to_edit } => {
-                crate::ceprintlns!(
-                    "DEPRECATED"!Red,
-                    "Please use `increment-version` instead."
-                );
-
-                let mut buffer = String::new();
-
-                for line in
-                    std::io::BufReader::new(std::fs::File::open(file_to_edit)?)
-                        .lines()
-                {
-                    let line = line?;
-
-                    if line.starts_with("date-released:") {
-                        buffer.append_as_line(format!(
-                            "date-released: {}",
-                            chrono::Local::now().format("%Y-%m-%d")
-                        ));
-                    } else {
-                        buffer.append_as_line(line);
-                    }
-                }
-
-                file_to_edit.truncate(Box::new(buffer))
-            }
             Self::CommentChanges(c) => c.main(),
             Self::Complain(c) => c.main(),
             /*

src/changelog/comment_changes.rs

@@ -90,24 +90,6 @@ pub struct CommentChanges {
     #[arg(long, short = '@')]
     stop: Vec<String>,
 
-    /// ⚠️  DEPRECATED.
-    ///
-    /// The commit to stop at.
-    ///
-    /// This option is deprecated.  Please use `-@` instead.
-    #[arg(long, short = 'S')]
-    #[deprecated(since = "3.7.4", note = "use `Self::stop` instead")]
-    stop_at: Option<Oid>,
-
-    /// ⚠️  DEPRECATED.
-    ///
-    /// The tag to stop at.
-    ///
-    /// This option is deprecated.  Please use `-@` instead.
-    #[arg(long, short = 'T')]
-    #[deprecated(since = "3.7.4", note = "use `Self::stop` instead")]
-    tag: Option<String>,
-
     /// The hyperlinks' targets.
     #[arg(long, short)]
     target: Vec<String>,
@@ -140,8 +122,6 @@ impl CommentChanges {
             link: Vec::new(),
             output_directory: ".".to_string(),
             stop: Vec::new(),
-            stop_at: None,
-            tag: None,
             target: Vec::new(),
         }
     }
@@ -324,39 +304,7 @@ impl Logic {
             },
             |r| {
                 self.repository = Some(r);
-                self.analyse_stop_condition()?;
-
-                if let Some(oid) = &self.cli.stop_at {
-                    self.stop_conditions.push(*oid);
-                }
-
-                if let Some(tag) = &self.cli.tag {
-                    if let Some(repository) = &self.repository {
-                        if let Ok(target) =
-                            repository.resolve_reference_from_short_name(tag)
-                        {
-                            if target.is_tag() {
-                                if let Some(oid) = target.target() {
-                                    self.stop_conditions.push(oid);
-                                    Ok(())
-                                } else {
-                                    eprintln!("`{tag}` cannot be used as stop condition."); // #[aeruginous::mercy::0003]
-                                    Err(ExitCode::Usage)
-                                }
-                            } else {
-                                eprintln!("{tag} does not seem to be a tag.");
-                                Err(ExitCode::Usage)
-                            }
-                        } else {
-                            eprintln!("Tag {tag} does not seem to exist.");
-                            Err(ExitCode::Usage)
-                        }
-                    } else {
-                        Err(ExitCode::Software)
-                    }
-                } else {
-                    Ok(())
-                }
+                self.analyse_stop_condition()
             },
         )
     }

src/lib.rs

@@ -71,7 +71,6 @@
 //! 1. [Supported Subcommands](#supported-subcommands)
 //!    1. [`cff-create`](#cff-create)
 //!    1. [`cffreference`](#cffreference)
-//!    1. ⚠️  [`cff-release-today`](#cff-release-today) (deprecated)
 //!    1. [`comment-changes`](#comment-changes)
 //!    1. [`complain`](#complain)
 //!    1. [`increment-version`](#increment-version)
@@ -82,7 +81,6 @@
 //! <!--
 //!    1. [`cff-create`](#cff-create)
 //!    1. [`cffreference`](#cffreference)
-//!    1. ⚠️  [`cff-release-today`](#cff-release-today) (deprecated)
 //!    1. [`comment-changes`](#comment-changes)
 //!    1. [`complain`](#complain)
 //!    1. [`graph-description`](#graph-description)
@@ -259,21 +257,6 @@
 //! from [`std::io::Stdin`].  Likewise, omitting the output file will cause
 //! `cffreference` to write to [`std::io::Stdout`].
 //!
-//! ### `cff-release-today`
-//!
-//! ⚠️  This mode is deprecated.  Please use
-//! [`increment-version`](#increment-version) instead.  ⚠️
-//!
-//! > To be called with:
-//! >
-//! > - `cffrel`
-//! > - `cff-rel`
-//! > - `cffreleasetoday`
-//! > - `cff-release-today`
-//!
-//! This subcommand will set the release date in the given `CITATION.cff` to the
-//! present day.
-//!
 //! ### `comment-changes`
 //!
 //! > To be called with:

src/pattern/io_processor.rs

@@ -67,21 +67,6 @@ pub trait IOProcessor {
         truncate: bool,
     ) -> Result<()>;
 
-    /// Truncate the output stream and write error messages.
-    ///
-    /// # Errors
-    ///
-    /// See [`Self::behaviour`].
-    #[allow(deprecated)]
-    #[deprecated(since = "3.7.7", note = "use `aeruginous_io` instead")]
-    fn io(
-        &self,
-        input: impl ReadFile,
-        output: impl PatternWriter,
-    ) -> Result<()> {
-        self.behaviour(input, output, false, true, true)
-    }
-
     /// Do not truncate the output stream but write error messages.
     ///
     /// # Errors
@@ -110,21 +95,6 @@ pub trait IOProcessor {
         self.behaviour(input, output, true, false, false)
     }
 
-    /// Truncate the output stream but do not write error messages.
-    ///
-    /// # Errors
-    ///
-    /// See [`Self::behaviour`].
-    #[allow(deprecated)]
-    #[deprecated(since = "3.7.7", note = "use `aeruginous_io` instead")]
-    fn io_silent(
-        &self,
-        input: impl ReadFile,
-        output: impl PatternWriter,
-    ) -> Result<()> {
-        self.behaviour(input, output, false, false, true)
-    }
-
     /// Edit the output stream and write error messages.
     ///
     /// # Errors

src/pattern/writer.rs

@@ -70,26 +70,6 @@ pub trait Writer {
         truncate: bool,
     ) -> Result<()>;
 
-    /// Truncate the stream, write the buffer's data, and print error messages.
-    ///
-    /// # Errors
-    ///
-    /// See [`Self::behaviour`].
-    #[deprecated(since = "3.7.6", note = "use `aeruginous_io` instead")]
-    fn truncate(&self, buffer: Box<dyn PatternBuffer>) -> Result<()> {
-        self.behaviour(buffer, false, true, true)
-    }
-
-    /// Truncate the stream and write the buffer's data without error messages.
-    ///
-    /// # Errors
-    ///
-    /// See [`Self::behaviour`].
-    #[deprecated(since = "3.7.6", note = "use `aeruginous_io` instead")]
-    fn truncate_silently(&self, buffer: Box<dyn PatternBuffer>) -> Result<()> {
-        self.behaviour(buffer, false, false, true)
-    }
-
     /// Edit the stream, write the buffer's data, and print error messages.
     ///
     /// # Errors

tests/pattern_writer.rs

@@ -38,18 +38,6 @@ macro_rules! make_test {
           ),
           Ok(())
         );
-        assert_eq!(
-          std::io::$function().truncate(
-            Box::new(stringify!($function).to_string())
-          ),
-          Ok(())
-        );
-        assert_eq!(
-          std::io::$function().truncate_silently(
-            Box::new(stringify!($function).to_string())
-          ),
-          Ok(())
-        );
         assert_eq!(
           std::io::$function().write(
             Box::new(stringify!($function).to_string())