WIP

Author: foresterre

Cargo.toml

@@ -18,28 +18,37 @@ exclude = [
 
 [workspace]
 members = [
+    # extra
     "crates/rust-release",
+    "crates/rust-toolchain",
+    # core & shared impl
     "crates/rust-releases-core",
     "crates/rust-releases-io",
+    # sources
+    "crates/rust-releases-github",
     "crates/rust-releases-rust-changelog",
     "crates/rust-releases-rust-dist",
-    "crates/rust-toolchain",
 ]
 
 [features]
 default = [
     "rust-changelog",
 ]
 
+github = ["rust-releases-github"]
 rust-changelog = ["rust-releases-rust-changelog"]
 rust-dist = ["rust-releases-rust-dist"]
 
 io = ["rust-releases-io"]
 io-http = ["rust-releases-io/http_client"]
 
 [dependencies]
-rust-releases-core = { version = "^0.30.0", path = "crates/rust-releases-core" }
-rust-releases-io = { version = "^0.30.0", path = "crates/rust-releases-io", optional = true }
+# types and shared impl's
+rust-releases-core = { workspace = true }
+rust-releases-io = { workspace = true, optional = true }
+
+# sources
+rust-releases-github = { version = "^0.30.0", path = "crates/rust-releases-github", optional = true }
 rust-releases-rust-changelog = { version = "^0.30.0", path = "crates/rust-releases-rust-changelog", optional = true }
 rust-releases-rust-dist = { version = "^0.30.0", path = "crates/rust-releases-rust-dist", optional = true }
 
@@ -52,3 +61,8 @@ thiserror = "2.0.12"
 
 # Parameterized tests
 yare = "3.0.0"
+
+rust-release = { path = "crates/rust-release" }
+rust-toolchain = { version = "1.1.0", path = "crates/rust-toolchain" }
+rust-releases-core = { version = "^0.30.0", path = "crates/rust-releases-core" }
+rust-releases-io = { version = "^0.30.0", path = "crates/rust-releases-io" }

crates/rust-release/Cargo.toml

@@ -11,7 +11,7 @@ documentation = "https://docs.rs/rust-toolchain"
 repository = "https://github.com/foresterre/rust-releases"
 
 [dependencies]
-rust-toolchain = "1.1.0"
+rust-toolchain = { workspace = true }
 
 [dev-dependencies]
 yare = { workspace = true }

crates/rust-release/src/lib.rs

@@ -14,9 +14,14 @@
 // #![deny(missing_docs)]
 #![warn(clippy::all)]
 #![deny(unsafe_code)]
-#![deny(missing_docs)]
+// #![deny(missing_docs)]
 
 use crate::toolchain::ReleaseToolchain;
+use std::cmp::Ordering;
+
+// exports
+pub use rust_toolchain;
+pub use rust_toolchain::channel::{Beta, Nightly, Stable};
 
 /// Describes toolchains in so far they're relevant to a release
 pub mod toolchain;
@@ -25,30 +30,57 @@ pub mod toolchain;
 pub mod version;
 
 /// Type to model a Rust release.
-#[derive(Clone, Debug, Eq, PartialEq)]
-pub struct RustRelease {
-    version: ReleaseVersion,
-    release_date: Option<rust_toolchain::Date>,
-    toolchains: Vec<ReleaseToolchain>,
+///
+/// # PartialEq, Eq, Ord, PartialOrd
+///
+/// With respect to the PartialEq, Eq, PartialOrd and Ord traits, a [`RustRelease`]
+/// is only compared and ordered based on its `version`.
+#[derive(Clone, Debug)]
+pub struct RustRelease<V, C = ()> {
+    pub version: V,
+    pub release_date: Option<rust_toolchain::Date>,
+    pub toolchains: Vec<ReleaseToolchain>,
+    pub context: C,
+}
+
+impl<V: PartialEq, C> PartialEq for RustRelease<V, C> {
+    fn eq(&self, other: &Self) -> bool {
+        self.version.eq(&other.version)
+    }
 }
 
-impl RustRelease {
+impl<V: Eq, C> Eq for RustRelease<V, C> {}
+
+impl<V: PartialOrd, C> PartialOrd for RustRelease<V, C> {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        self.version.partial_cmp(&other.version)
+    }
+}
+
+impl<V: Ord, C> Ord for RustRelease<V, C> {
+    fn cmp(&self, other: &Self) -> Ordering {
+        self.version.cmp(&other.version)
+    }
+}
+
+impl<V> RustRelease<V> {
     /// Create a new RustRelease instance using a version, optionally
     /// a release date, and an iterator of toolchains.
     pub fn new(
-        version: ReleaseVersion,
+        version: V,
         release_date: Option<rust_toolchain::Date>,
         toolchains: impl IntoIterator<Item = ReleaseToolchain>,
     ) -> Self {
         Self {
             version,
             release_date,
             toolchains: toolchains.into_iter().collect(),
+            context: (),
         }
     }
 
     /// The 3 component MAJOR.MINOR.PATCH version number of the release
-    pub fn version(&self) -> &ReleaseVersion {
+    pub fn version(&self) -> &V {
         &self.version
     }
 
@@ -70,11 +102,11 @@ impl RustRelease {
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub enum ReleaseVersion {
     /// A stable channel release version
-    Stable(rust_toolchain::channel::Stable),
+    Stable(Stable),
     /// A beta channel release version
-    Beta(rust_toolchain::channel::Beta),
+    Beta(Beta),
     /// A nightly channel release version
-    Nightly(rust_toolchain::channel::Nightly),
+    Nightly(Nightly),
 }
 
 #[cfg(test)]
@@ -84,7 +116,7 @@ mod tests {
 
     #[test]
     fn can_instantiate() {
-        let stable_version = rust_toolchain::channel::Stable {
+        let stable_version = Stable {
             version: rust_toolchain::RustVersion::new(1, 82, 0),
         };
         let version = ReleaseVersion::Stable(stable_version.clone());

crates/rust-releases-core/Cargo.toml

@@ -10,8 +10,8 @@ documentation = "https://docs.rs/rust-releases-core"
 repository = "https://github.com/foresterre/rust-releases"
 
 [dependencies]
+rust-release = { workspace = true }
 thiserror = { workspace = true }
-semver = "1.0.0"
 
 [dev-dependencies]
 yare = { workspace = true }

crates/rust-releases-core/src/channel.rs

@@ -1,27 +1,30 @@
-use crate::CoreError;
 use std::convert::TryFrom;
 use std::fmt::{Display, Formatter};
 
 /// Enumerates the Rust release channels
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 pub enum Channel {
+    /// An identifier for the `stable` release channel
+    Stable,
     /// An identifier for the `beta` release channel
     Beta,
     /// An identifier for the `nightly` release channel
     Nightly,
-    /// An identifier for the `stable` release channel
-    Stable,
 }
 
 impl TryFrom<&str> for Channel {
-    type Error = CoreError;
+    type Error = Error;
 
     fn try_from(item: &str) -> Result<Self, Self::Error> {
         Ok(match item {
             "beta" => Self::Beta,
             "nightly" => Self::Nightly,
             "stable" => Self::Stable,
-            unsupported => return Err(CoreError::NoSuchChannel(unsupported.to_string())),
+            unsupported => {
+                return Err(Error {
+                    channel: unsupported.to_string(),
+                })
+            }
         })
     }
 }
@@ -43,6 +46,12 @@ impl Display for Channel {
     }
 }
 
+#[derive(Debug, thiserror::Error)]
+#[error("No such channel: `{}`", .channel)]
+pub struct Error {
+    channel: String,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;