refactor: update examples and tests to range_trait

mpizenberg · mpizenberg · commit 948d2c4ac3c8 · 2021-06-22T18:43:11.000+02:00
diff --git a/examples/branching_error_reporting.rs b/examples/branching_error_reporting.rs
@@ -1,14 +1,15 @@
 // SPDX-License-Identifier: MPL-2.0
 
 use pubgrub::error::PubGrubError;
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::report::{DefaultStringReporter, Reporter};
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
-use pubgrub::version::SemanticVersion;
+use pubgrub::version_trait::{SemanticInterval, SemanticVersion};
 
 // https://github.com/dart-lang/pub/blob/master/doc/solver.md#branching-error-reporting
 fn main() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
     // root 1.0.0 depends on foo ^1.0.0
         dependency_provider.add_dependencies(
diff --git a/examples/caching_dependency_provider.rs b/examples/caching_dependency_provider.rs
@@ -4,18 +4,25 @@ use std::cell::RefCell;
 use std::error::Error;
 
 use pubgrub::package::Package;
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::solver::{resolve, Dependencies, DependencyProvider, OfflineDependencyProvider};
-use pubgrub::version::{NumberVersion, Version};
+use pubgrub::version_trait::{Interval, NumberInterval, NumberVersion, Version};
 
 // An example implementing caching dependency provider that will
 // store queried dependencies in memory and check them before querying more from remote.
-struct CachingDependencyProvider<P: Package, V: Version, DP: DependencyProvider<P, V>> {
+struct CachingDependencyProvider<
+    P: Package,
+    I: Interval<V>,
+    V: Version,
+    DP: DependencyProvider<P, I, V>,
+> {
     remote_dependencies: DP,
-    cached_dependencies: RefCell<OfflineDependencyProvider<P, V>>,
+    cached_dependencies: RefCell<OfflineDependencyProvider<P, I, V>>,
 }
 
-impl<P: Package, V: Version, DP: DependencyProvider<P, V>> CachingDependencyProvider<P, V, DP> {
+impl<P: Package, I: Interval<V>, V: Version, DP: DependencyProvider<P, I, V>>
+    CachingDependencyProvider<P, I, V, DP>
+{
     pub fn new(remote_dependencies_provider: DP) -> Self {
         CachingDependencyProvider {
             remote_dependencies: remote_dependencies_provider,
@@ -24,10 +31,10 @@ impl<P: Package, V: Version, DP: DependencyProvider<P, V>> CachingDependencyProv
     }
 }
 
-impl<P: Package, V: Version, DP: DependencyProvider<P, V>> DependencyProvider<P, V>
-    for CachingDependencyProvider<P, V, DP>
+impl<P: Package, I: Interval<V>, V: Version, DP: DependencyProvider<P, I, V>>
+    DependencyProvider<P, I, V> for CachingDependencyProvider<P, I, V, DP>
 {
-    fn choose_package_version<T: std::borrow::Borrow<P>, U: std::borrow::Borrow<Range<V>>>(
+    fn choose_package_version<T: std::borrow::Borrow<P>, U: std::borrow::Borrow<Range<I, V>>>(
         &self,
         packages: impl Iterator<Item = (T, U)>,
     ) -> Result<(T, Option<V>), Box<dyn Error>> {
@@ -39,7 +46,7 @@ impl<P: Package, V: Version, DP: DependencyProvider<P, V>> DependencyProvider<P,
         &self,
         package: &P,
         version: &V,
-    ) -> Result<Dependencies<P, V>, Box<dyn Error>> {
+    ) -> Result<Dependencies<P, I, V>, Box<dyn Error>> {
         let mut cache = self.cached_dependencies.borrow_mut();
         match cache.get_dependencies(package, version) {
             Ok(Dependencies::Unknown) => {
@@ -65,7 +72,8 @@ impl<P: Package, V: Version, DP: DependencyProvider<P, V>> DependencyProvider<P,
 
 fn main() {
     // Simulating remote provider locally.
-    let mut remote_dependencies_provider = OfflineDependencyProvider::<&str, NumberVersion>::new();
+    let mut remote_dependencies_provider =
+        OfflineDependencyProvider::<&str, NumberInterval, NumberVersion>::new();
 
     // Add dependencies as needed. Here only root package is added.
     remote_dependencies_provider.add_dependencies("root", 1, Vec::new());
diff --git a/examples/doc_interface.rs b/examples/doc_interface.rs
@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: MPL-2.0
 
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
-use pubgrub::version::NumberVersion;
+use pubgrub::version_trait::{NumberInterval, NumberVersion};
 
 // `root` depends on `menu` and `icons`
 // `menu` depends on `dropdown`
 // `dropdown` depends on `icons`
 // `icons` has no dependency
 #[rustfmt::skip]
 fn main() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, NumberVersion>::new();
+    let mut dependency_provider = OfflineDependencyProvider::<&str, NumberInterval,  NumberVersion>::new();
     dependency_provider.add_dependencies(
-        "root", 1, vec![("menu", Range::any()), ("icons", Range::any())],
+        "root", 1, vec![("menu", Range::full()), ("icons", Range::full())],
     );
-    dependency_provider.add_dependencies("menu", 1, vec![("dropdown", Range::any())]);
-    dependency_provider.add_dependencies("dropdown", 1, vec![("icons", Range::any())]);
+    dependency_provider.add_dependencies("menu", 1, vec![("dropdown", Range::full())]);
+    dependency_provider.add_dependencies("dropdown", 1, vec![("icons", Range::full())]);
     dependency_provider.add_dependencies("icons", 1, vec![]);
 
     // Run the algorithm.
diff --git a/examples/doc_interface_error.rs b/examples/doc_interface_error.rs
@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MPL-2.0
 
 use pubgrub::error::PubGrubError;
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::report::{DefaultStringReporter, Reporter};
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
-use pubgrub::version::SemanticVersion;
+use pubgrub::version_trait::{SemanticInterval, SemanticVersion};
 
 // `root` depends on `menu`, `icons 1.0.0` and `intl 5.0.0`
 // `menu 1.0.0` depends on `dropdown < 2.0.0`
@@ -15,12 +15,12 @@ use pubgrub::version::SemanticVersion;
 // `intl` has no dependency
 #[rustfmt::skip]
 fn main() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticInterval,  SemanticVersion>::new();
     // Direct dependencies: menu and icons.
     dependency_provider.add_dependencies("root", (1, 0, 0), vec![
-        ("menu", Range::any()),
-        ("icons", Range::exact((1, 0, 0))),
-        ("intl", Range::exact((5, 0, 0))),
+        ("menu", Range::full()),
+        ("icons", Range::singleton((1, 0, 0))),
+        ("intl", Range::singleton((5, 0, 0))),
     ]);
 
     // Dependencies of the menu lib.
@@ -45,19 +45,19 @@ fn main() {
 
     // Dependencies of the dropdown lib.
     dependency_provider.add_dependencies("dropdown", (1, 8, 0), vec![
-        ("intl", Range::exact((3, 0, 0))),
+        ("intl", Range::singleton((3, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 0, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 1, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 2, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 3, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
 
     // Icons have no dependencies.
diff --git a/examples/doc_interface_semantic.rs b/examples/doc_interface_semantic.rs
@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: MPL-2.0
 
 use pubgrub::error::PubGrubError;
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::report::{DefaultStringReporter, Reporter};
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
-use pubgrub::version::SemanticVersion;
+use pubgrub::version_trait::{SemanticInterval, SemanticVersion};
 
 // `root` depends on `menu` and `icons 1.0.0`
 // `menu 1.0.0` depends on `dropdown < 2.0.0`
@@ -14,11 +14,11 @@ use pubgrub::version::SemanticVersion;
 // `icons` has no dependency
 #[rustfmt::skip]
 fn main() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     // Direct dependencies: menu and icons.
     dependency_provider.add_dependencies("root", (1, 0, 0), vec![
-        ("menu", Range::any()),
-        ("icons", Range::exact((1, 0, 0))),
+        ("menu", Range::full()),
+        ("icons", Range::singleton((1, 0, 0))),
     ]);
 
     // Dependencies of the menu lib.
@@ -44,16 +44,16 @@ fn main() {
     // Dependencies of the dropdown lib.
     dependency_provider.add_dependencies("dropdown", (1, 8, 0), vec![]);
     dependency_provider.add_dependencies("dropdown", (2, 0, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 1, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 2, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
     dependency_provider.add_dependencies("dropdown", (2, 3, 0), vec![
-        ("icons", Range::exact((2, 0, 0))),
+        ("icons", Range::singleton((2, 0, 0))),
     ]);
 
     // Icons has no dependency.
diff --git a/examples/linear_error_reporting.rs b/examples/linear_error_reporting.rs
@@ -1,14 +1,15 @@
 // SPDX-License-Identifier: MPL-2.0
 
 use pubgrub::error::PubGrubError;
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::report::{DefaultStringReporter, Reporter};
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
-use pubgrub::version::SemanticVersion;
+use pubgrub::version_trait::{SemanticInterval, SemanticVersion};
 
 // https://github.com/dart-lang/pub/blob/master/doc/solver.md#linear-error-reporting
 fn main() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
     // root 1.0.0 depends on foo ^1.0.0 and baz ^1.0.0
         dependency_provider.add_dependencies(
diff --git a/src/lib.rs b/src/lib.rs
@@ -212,12 +212,12 @@
 pub mod error;
 pub mod package;
 pub mod range;
-mod range_trait;
+pub mod range_trait;
 pub mod report;
 pub mod solver;
 pub mod term;
 pub mod type_aliases;
 pub mod version;
-mod version_trait;
+pub mod version_trait;
 
 mod internal;
diff --git a/src/term.rs b/src/term.rs
@@ -182,13 +182,13 @@ impl<I: Interval<V>, V: Version + fmt::Display> fmt::Display for Term<I, V> {
 #[cfg(test)]
 pub mod tests {
     use super::*;
-    use crate::version::NumberVersion;
+    use crate::version_trait::{NumberInterval, NumberVersion};
     use proptest::prelude::*;
 
-    pub fn strategy() -> impl Strategy<Value = Term<NumberVersion>> {
+    pub fn strategy() -> impl Strategy<Value = Term<NumberInterval, NumberVersion>> {
         prop_oneof![
-            crate::range::tests::strategy().prop_map(Term::Positive),
-            crate::range::tests::strategy().prop_map(Term::Negative),
+            crate::range_trait::tests::strategy().prop_map(Term::Positive),
+            crate::range_trait::tests::strategy().prop_map(Term::Negative),
         ]
     }
 
diff --git a/tests/examples.rs b/tests/examples.rs
@@ -1,14 +1,15 @@
 // SPDX-License-Identifier: MPL-2.0
 
-use pubgrub::range::Range;
+use pubgrub::range_trait::Range;
 use pubgrub::solver::{resolve, OfflineDependencyProvider};
 use pubgrub::type_aliases::Map;
-use pubgrub::version::{NumberVersion, SemanticVersion};
+use pubgrub::version_trait::{NumberInterval, NumberVersion, SemanticInterval, SemanticVersion};
 
 #[test]
 /// https://github.com/dart-lang/pub/blob/master/doc/solver.md#no-conflicts
 fn no_conflict() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
         dependency_provider.add_dependencies(
         "root", (1, 0, 0),
@@ -38,7 +39,8 @@ fn no_conflict() {
 #[test]
 /// https://github.com/dart-lang/pub/blob/master/doc/solver.md#avoiding-conflict-during-decision-making
 fn avoiding_conflict_during_decision_making() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
         dependency_provider.add_dependencies(
         "root", (1, 0, 0),
@@ -73,7 +75,8 @@ fn avoiding_conflict_during_decision_making() {
 #[test]
 /// https://github.com/dart-lang/pub/blob/master/doc/solver.md#performing-conflict-resolution
 fn conflict_resolution() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
         dependency_provider.add_dependencies(
         "root", (1, 0, 0),
@@ -106,7 +109,8 @@ fn conflict_resolution() {
 #[test]
 /// https://github.com/dart-lang/pub/blob/master/doc/solver.md#conflict-resolution-with-a-partial-satisfier
 fn conflict_with_partial_satisfier() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, SemanticVersion>::new();
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, SemanticInterval, SemanticVersion>::new();
     #[rustfmt::skip]
     // root 1.0.0 depends on foo ^1.0.0 and target ^2.0.0
         dependency_provider.add_dependencies(
@@ -171,12 +175,13 @@ fn conflict_with_partial_satisfier() {
 ///
 /// Solution: a0, b0, c0, d0
 fn double_choices() {
-    let mut dependency_provider = OfflineDependencyProvider::<&str, NumberVersion>::new();
-    dependency_provider.add_dependencies("a", 0, vec![("b", Range::any()), ("c", Range::any())]);
-    dependency_provider.add_dependencies("b", 0, vec![("d", Range::exact(0))]);
-    dependency_provider.add_dependencies("b", 1, vec![("d", Range::exact(1))]);
+    let mut dependency_provider =
+        OfflineDependencyProvider::<&str, NumberInterval, NumberVersion>::new();
+    dependency_provider.add_dependencies("a", 0, vec![("b", Range::full()), ("c", Range::full())]);
+    dependency_provider.add_dependencies("b", 0, vec![("d", Range::singleton(0))]);
+    dependency_provider.add_dependencies("b", 1, vec![("d", Range::singleton(1))]);
     dependency_provider.add_dependencies("c", 0, vec![]);
-    dependency_provider.add_dependencies("c", 1, vec![("d", Range::exact(2))]);
+    dependency_provider.add_dependencies("c", 1, vec![("d", Range::singleton(2))]);
     dependency_provider.add_dependencies("d", 0, vec![]);
 
     // Solution.
diff --git a/tests/proptest.rs b/tests/proptest.rs
diff --git a/tests/sat_dependency_provider.rs b/tests/sat_dependency_provider.rs
diff --git a/tests/tests.rs b/tests/tests.rs
