Skip to content

feat!: reduce the public apis #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryuapp merged 4 commits into from
Mar 28, 2026
Merged

feat!: reduce the public apis #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c72e2de
feat!: reduce the public apis
ryuapp Mar 28, 2026
9f894d2
chore: remove unused import
ryuapp Mar 28, 2026
923eea3
fmt
ryuapp Mar 28, 2026
64b1b94
fix!: remove metadata and prerelease parse function
ryuapp Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ fn main() {
major: 1,
minor: 2,
patch: 3,
pre_release: PreRelease::parse("alpha.1").unwrap(),
pre_release: PreRelease::new("alpha.1").unwrap(),
build: BuildMetadata::default(),
};
assert!(!range.satisfies(&version));
Expand Down
9 changes: 9 additions & 0 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ use alloc::string::{String, ToString};
use core::fmt;

/// Error returned when a version or range string cannot be parsed.
///
/// # Examples
///
/// ```rust
/// use js_semver::{SemverError, Version};
///
/// let err: SemverError = Version::parse("1.a.b").unwrap_err();
/// eprintln!("{err}");
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SemverError(String);

Expand Down
17 changes: 1 addition & 16 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,6 @@
//! let version: Version = "1.3.0".parse().unwrap();
//! assert!(range.satisfies(&version));
//! ```
//!
//! ```rust
//! use core::cmp::Ordering;
//! use js_semver::Version;
//!
//! let stable: Version = "1.2.3+build.1".parse().unwrap();
//! let rebuilt: Version = "1.2.3+build.2".parse().unwrap();
//!
//! // Total ordering includes build metadata.
//! assert!(stable < rebuilt);
//! assert_ne!(stable, rebuilt);
//!
//! // SemVer precedence ignores build metadata.
//! assert_eq!(stable.cmp_precedence(&rebuilt), Ordering::Equal);
//! ```

#[cfg(not(feature = "std"))]
extern crate alloc;
Expand All @@ -57,4 +42,4 @@ mod version;

pub use error::SemverError;
pub use range::Range;
pub use version::{BuildMetadata, PreRelease, ReleaseType, Version};
pub use version::{BuildMetadata, PreRelease, Version};
233 changes: 1 addition & 232 deletions src/range.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,59 +133,6 @@ impl Range {
}
false
}

/// Returns `true` if this range intersects with `other`.
#[must_use]
pub fn intersects(&self, other: &Self) -> bool {
range_intersects_impl(self, other)
}

/// Return the minimum version that satisfies this range, or `None`.
#[must_use]
pub fn min_version(&self) -> Option<Version> {
let mut candidates: Vec<Version> = vec![];
for comparator_set in &self.set {
let Some(candidate) = comparator_set_min_version(comparator_set) else {
continue;
};
candidates.push(candidate);
}
candidates.sort();
candidates.dedup();
candidates.into_iter().next()
}

/// Return the highest version in `versions` that satisfies this range, or `None`.
#[must_use]
pub fn max_satisfying<'a>(&self, versions: &'a [Version]) -> Option<&'a Version> {
let mut best = None;
for version in versions {
let is_better = match best {
Some(current) => version > current,
None => true,
};
if self.satisfies(version) && is_better {
best = Some(version);
}
}
best
}

/// Return the lowest version in `versions` that satisfies this range, or `None`.
#[must_use]
pub fn min_satisfying<'a>(&self, versions: &'a [Version]) -> Option<&'a Version> {
let mut best = None;
for version in versions {
let is_better = match best {
Some(current) => version < current,
None => true,
};
if self.satisfies(version) && is_better {
best = Some(version);
}
}
best
}
}

impl fmt::Display for Range {
Expand Down Expand Up @@ -880,94 +827,14 @@ fn is_impossible_comparator(comparator: &Comparator) -> bool {
&& comparator.version.pre_release == PreRelease::zero()
}

// --------------------------------------------------------------------------
// Range intersection helpers
// --------------------------------------------------------------------------

fn range_intersects_impl(r1: &Range, r2: &Range) -> bool {
r1.set
.iter()
.any(|cs1| r2.set.iter().any(|cs2| cs_intersect(cs1, cs2)))
}

fn cs_intersect(cs1: &ComparatorSet, cs2: &ComparatorSet) -> bool {
if cs1.comparators.is_empty() || cs2.comparators.is_empty() {
return true;
}
// Check lower-bound candidates from each set against the other.
for c in &cs1.comparators {
if let Some(cand) = lower_bound_candidate(c) {
if cs1.test(&cand) && cs2.test(&cand) {
return true;
}
}
}
for c in &cs2.comparators {
if let Some(cand) = lower_bound_candidate(c) {
if cs1.test(&cand) && cs2.test(&cand) {
return true;
}
}
}
false
}

// --------------------------------------------------------------------------
// Private helpers for Range methods
// --------------------------------------------------------------------------

fn lower_bound_candidate(c: &Comparator) -> Option<Version> {
match c.op {
Operator::Equal | Operator::GreaterThanOrEqual => Some(c.version.clone()),
Operator::GreaterThan => {
let mut ver = c.version.clone();
ver.build = BuildMetadata::default();
if ver.pre_release.is_empty() {
ver.patch += 1;
} else {
ver.pre_release.push_numeric_zero();
}
Some(ver)
}
Operator::LessThan | Operator::LessThanOrEqual => None,
}
}

fn comparator_set_min_version(comparator_set: &ComparatorSet) -> Option<Version> {
let v000 = Version::new(0, 0, 0);
if comparator_set.test(&v000) {
return Some(v000);
}
let v000_pre = prerelease_version(0, 0, 0, PreRelease::zero());
if comparator_set.test(&v000_pre) {
return Some(v000_pre);
}
let mut candidates: Vec<Version> = vec![];
for comparator in &comparator_set.comparators {
let Some(candidate) = lower_bound_candidate(comparator) else {
continue;
};
candidates.push(candidate);
}
candidates.sort();
candidates.dedup();
for candidate in candidates {
if !comparator_set.test(&candidate) {
continue;
}
return Some(candidate);
}
None
}

// --------------------------------------------------------------------------
// Tests
// --------------------------------------------------------------------------

#[cfg(test)]
mod tests {
#[cfg(not(feature = "std"))]
use alloc::{string::ToString, vec::Vec};
use alloc::string::ToString;

use core::fmt::{self, Write};

Expand Down Expand Up @@ -1054,49 +921,6 @@ mod tests {
assert!(!r(">=4.0.0-rc.0").satisfies(&v("4.2.0-rc.1")));
}

// --- max/min satisfying ---

#[test]
fn max_satisfying_basic() {
let mut vs: Vec<Version> = Vec::new();
for s in ["1.0.0", "1.2.0", "2.0.0", "3.0.0"] {
vs.push(s.parse().unwrap());
}
assert_eq!(r("^1.0.0").max_satisfying(&vs), Some(&v("1.2.0")));
assert_eq!(r("^3.0.0").max_satisfying(&vs), Some(&v("3.0.0")));
assert_eq!(r("^4.0.0").max_satisfying(&vs), None);
}

#[test]
fn min_satisfying_basic() {
let mut vs: Vec<Version> = Vec::new();
for s in ["1.0.0", "1.2.0", "2.0.0", "3.0.0"] {
vs.push(s.parse().unwrap());
}
assert_eq!(r("^1.0.0").min_satisfying(&vs), Some(&v("1.0.0")));
assert_eq!(r(">=2.0.0").min_satisfying(&vs), Some(&v("2.0.0")));
}

// --- min_version ---

#[test]
fn min_version_basic() {
assert_eq!(r(">=1.0.0").min_version(), Some(v("1.0.0")));
assert_eq!(r("^1.2.3").min_version(), Some(v("1.2.3")));
assert_eq!(r("~2.0.0").min_version(), Some(v("2.0.0")));
assert_eq!(r("*").min_version(), Some(v("0.0.0")));
assert_eq!(r("<2.0.0").min_version(), Some(v("0.0.0")));
}

// --- intersects ---

#[test]
fn intersects_ranges() {
assert!(r("^1.0.0").intersects(&r("^1.5.0")));
assert!(!r("^1.0.0").intersects(&r("^2.0.0")));
assert!(r(">=1.0.0").intersects(&r("<=2.0.0")));
}

#[test]
fn parse_valid_and_display_cases() {
assert_display_case("^1.0.0", ">=1.0.0 <2.0.0-0");
Expand Down Expand Up @@ -1194,25 +1018,6 @@ mod tests {
assert!(!r("<=1.2").satisfies(&v("1.3.0")));
}

// --- min_version with pre-release lower bound ---

#[test]
fn min_version_prerelease() {
assert_eq!(
r(">=1.0.0-alpha").min_version(),
Some("1.0.0-alpha".parse().unwrap())
);
// >* is impossible, returns None
assert_eq!(r(">*").min_version(), None);
}

// --- lower_bound_candidate with Gt + pre-release ---

#[test]
fn intersects_gt_pre() {
assert!(r(">1.0.0-alpha").intersects(&r("^1.0.0")));
}

// --- Operator Display ---

#[test]
Expand All @@ -1224,31 +1029,6 @@ mod tests {
assert_eq!(Operator::Equal.to_string(), "=");
}

// --- min_version: 0.0.0-0 path ---

#[test]
fn min_version_v000_pre() {
// 0.0.0 fails (pre-release restriction), but 0.0.0-0 passes
assert_eq!(
r(">=0.0.0-0 <=0.0.0-beta").min_version(),
Some("0.0.0-0".parse().unwrap())
);
}

// --- min_version: Gt with non-pre patch+1 ---

#[test]
fn min_version_gt() {
assert_eq!(r(">1.0.0").min_version(), Some(v("1.0.1")));
}

// --- cs_intersect: wildcard range ---

#[test]
fn intersects_wildcard() {
assert!(r("*").intersects(&r("^1.0.0")));
}

// --- wildcard operator forms ---

#[test]
Expand Down Expand Up @@ -1393,11 +1173,6 @@ mod tests {
assert_invalid_range("^9007199254740991.0.0");
}

#[test]
fn min_version_dedups_duplicate_candidates() {
assert_eq!(r(">=1.2.3 >=1.2.3").min_version(), Some(v("1.2.3")));
}

#[test]
fn invalid_partial_after_operator_errors() {
assert!(Range::parse("<=a.b.c").is_err());
Expand Down Expand Up @@ -1425,12 +1200,6 @@ mod tests {
assert_eq!(r("1.2.3 1.2.3").to_string(), "1.2.3");
}

#[test]
fn comparator_set_min_version_none_for_unsatisfiable_bounds() {
let comparator_set = parse_comparator_set(">1.0.0 <1.0.1").unwrap();
assert_eq!(comparator_set_min_version(&comparator_set), None);
}

#[test]
fn range_display_propagates_formatter_errors() {
let mut wildcard_writer = FailingWriter {
Expand Down
Loading